Módulos

Os módulos permitem que os aplicativos estendam a interface do usuário Crowdin, criem integrações com serviços externos, etc.

Módulos suportados

Integrations module – insert a new integration page in Crowdin.
Editor-panels module – create additional panels in the Editor.
Resources module – create an additional panel in the project owner’s resources.
Project menu module – create a new tab in the project.
Custom MT module – connect machine translation engines that aren’t supported in Crowdin by default yet.
Tools module – insert a new tool page in Crowdin.
Reports module – create additional reports in the Reports tab.
Custom File Format module – add a custom file format import and export support.

Mais módulos do Crowdin Apps serão disponibilizados em breve.

Módulo de integração

Integrations module allows creating and inserting a new integration within the Crowdin project. You can find it in your project’s Integrations tab. Este módulo está disponível para membros do projeto com permissões de gerente (ou superior).

Estrutura do módulo de integração:

{
  "integrations": [
    {
      "key": "your-module-key",
      "name": "Module name",
      "description": "Module description",
      "logo": "/logo.png",
      "url": "/integration-page"
    }
  ]
}

Propriedades:

`chave`	Tipo: `string` Requerido: sim Descrição: Identificador de módulo no aplicativo Crowdin.
`name`	Tipo: `string` Requerido: sim Descrição: O nome legível por humanos do módulo.
`description`	Tipo: `string` Descrição: A descrição legível por humanos do que o módulo faz. A descrição estará visível na interface do usuário do Crowdin.
`logo`	Tipo: `string` Requerido: sim Description: The relative URL to the integration's logo that will be displayed in the Crowdin UI. The recommended resolution is 48x48 pixels.
`url`	Tipo: `string` Requerido: sim Description: The relative URL to the content page of the module that will be integrated into the Crowdin UI.
`environments`	Tipo: `string` Allowed values: `crowdin`, `crowdin-enterprise` Description: Set of environments where a module could be installed. This parameter is needed for cross-product applications.

Módulo de painéis do editor

The editor-panels module allows creating additional tabs in the Editor. Ao usar este módulo em seu aplicativo para Crowdin, você pode escolher o modo editor onde deseja que as guias adicionais sejam exibidas. O módulo de painéis do editor está disponível apenas para os membros do projeto que têm acesso ao Editor.

Estrutura do módulo do painel do editor:

{
  "editor-panels": [
    {
      "key": "your-module-key",
      "position": "right",
      "name": "Module name",
      "modes": ["translate", "proofread"],
      "url": "/editor-page"
    }
  ]
}

Propriedades:

`chave`	Tipo: `string` Requerido: sim Descrição: Identificador de módulo no aplicativo Crowdin.
`position`	Tipo: `string` Requerido: sim Valores permitidos: `right` Descrição: A posição onde o módulo será colocado.
`name`	Tipo: `string` Requerido: sim Descrição: O nome legível por humanos do módulo.
`modes`	Tipo: `array` Requerido: sim Valores permitidos: `assets`, `review`, `translate`, `proofread` Descrição: A lista de modos do Editor onde o módulo estará disponível.
`url`	Tipo: `string` Requerido: sim Description: The relative URL to the content page of the module that will be integrated into the Crowdin UI.
`environments`	Tipo: `string` Allowed values: `crowdin`, `crowdin-enterprise` Description: Set of environments where a module could be installed. This parameter is needed for cross-product applications.

Módulo de recursos

The resources module allows creating an additional panel in the project owner’s resources. Este módulo está disponível apenas para o proprietário do projeto.

Estrutura do módulo de recursos:

{
  "resources": [
    {
      "key": "your-module-key",
      "name": "Module name",
      "url": "/resource-page"
    }
  ]
}

Propriedades:

`chave`	Tipo: `string` Requerido: sim Descrição: Identificador de módulo no aplicativo Crowdin.
`name`	Tipo: `string` Requerido: sim Descrição: O nome legível por humanos do módulo.
`url`	Tipo: `string` Requerido: sim Description: The relative URL to the content page of the module that will be integrated into the Crowdin UI.
`environments`	Tipo: `string` Allowed values: `crowdin`, `crowdin-enterprise` Description: Set of environments where a module could be installed. This parameter is needed for cross-product applications.

The project menu module allows creating a new tab in the project. This module is available to selected project roles.

Estrutura do módulo do menu do projeto:

{
  "project-menu": [
    {
      "key": "your-module-key",
      "name": "Module name",
      "url": "/project-page"
    }
  ]
}

Propriedades:

`chave`	Tipo: `string` Requerido: sim Descrição: Identificador de módulo no aplicativo Crowdin.
`name`	Tipo: `string` Requerido: sim Descrição: O nome legível por humanos do módulo.
`url`	Tipo: `string` Requerido: sim Descrição: A URL relativa à página de conteúdo do módulo, que será integrada à UI do Crowdin.
`environments`	Tipo: `string` Allowed values: `crowdin`, `crowdin-enterprise` Description: Set of environments where a module could be installed. This parameter is needed for cross-product applications.

Custom MT (Machine Translation) Module

This module helps you connect machine translation engines that are not supported by Crowdin yet. Once you create this kind of app, you’ll be able to pre-translate your content with the connected MT or enable translation suggestions made by it to be shown in the Editor for translators.

Custom MT module structure:

{
   "custom-mt": [
     {
            "key": "custom-mt",
            "name": "Custom MT",
            "url": "/translate"
      }
    ]
}

Propriedades:

`chave`	Tipo: `string` Requerido: sim Descrição: Identificador de módulo no aplicativo Crowdin.
`name`	Tipo: `string` Requerido: sim Descrição: O nome legível por humanos do módulo.
`url`	Tipo: `string` Requerido: sim Description: The relative URL to the content page of the module that will be integrated with Crowdin.
`environments`	Tipo: `string` Allowed values: `crowdin`, `crowdin-enterprise` Description: Set of environments where a module could be installed. This parameter is needed for cross-product applications.

Tools Module

The tools module allows creating and inserting a new tool page within the Crowdin project. You can find it in your project’s Tools tab. Este módulo está disponível para membros do projeto com permissões de gerente (ou superior).

Tools module structure:

{
  "tools": [
    {
      "key": "your-module-key",
      "name": "Module name",
      "description": "Module description",
      "logo": "/logo.png",
      "url": "/tools-page"
    }
  ]
}

Propriedades:

`chave`	Tipo: `string` Requerido: sim Descrição: Identificador de módulo no aplicativo Crowdin.
`name`	Tipo: `string` Requerido: sim Descrição: O nome legível por humanos do módulo.
`description`	Tipo: `string` Descrição: A descrição legível por humanos do que o módulo faz. A descrição estará visível na interface do usuário do Crowdin.
`logo`	Tipo: `string` Requerido: sim Description: The relative URL to the tool's logo that will be displayed in the Crowdin UI. The recommended resolution is 48x48 pixels.
`url`	Tipo: `string` Requerido: sim Description: The relative URL to the content page of the module that will be integrated into the Crowdin UI.
`environments`	Tipo: `string` Allowed values: `crowdin`, `crowdin-enterprise` Description: Set of environments where a module could be installed. This parameter is needed for cross-product applications.

Reports Module

The reports module allows creating and inserting a new report within the Crowdin project. You can find it in your project’s Reports tab. Este módulo está disponível para membros do projeto com permissões de gerente (ou superior).

Reports module structure:

{
  "reports": [
    {
      "key": "your-module-key",
      "name": "Module name",
      "description": "Module description",
      "logo": "/logo.png",
      "url": "/reports-page"
    }
  ]
}

Propriedades:

`chave`	Tipo: `string` Requerido: sim Descrição: Identificador de módulo no aplicativo Crowdin.
`name`	Tipo: `string` Requerido: sim Descrição: O nome legível por humanos do módulo.
`description`	Tipo: `string` Descrição: A descrição legível por humanos do que o módulo faz. A descrição estará visível na interface do usuário do Crowdin.
`logo`	Tipo: `string` Description: The relative URL to the tool's logo that will be displayed in the Crowdin UI. The recommended resolution is 48x48 pixels.
`url`	Tipo: `string` Requerido: sim Description: The relative URL to the content page of the module that will be integrated into the Crowdin UI.
`environments`	Tipo: `string` Allowed values: `crowdin`, `crowdin-enterprise` Description: Set of environments where a module could be installed. This parameter is needed for cross-product applications.

Custom File Format Module

Use this module to add support of new custom file formats. It’s implemented by delegating a source file parsing to an app with a custom file format module. When translations are completed, Crowdin passes an array with translations to the Custom file format app that generates the translation files. Este módulo está disponível para membros do projeto com permissões de gerente (ou superior).

Custom File Format module structure:

{
  "custom-file-format": [
    {
      "key": "your-module-key-type-xyz",
      "type": "type-xyz",
      "url": "/process",
      "multilingual": true,
      "signaturePatterns": {
        "fileName": "^.+\\.xyz$",
        "fileContent": "<properties>\\s*<property\\s+name=.*value=.*/>"
      }
    }
  ]
}

Propriedades:

`chave`	Tipo: `string` Requerido: sim Descrição: Identificador de módulo no aplicativo Crowdin.
`type`	Tipo: `string` Requerido: sim Description: The custom file format identifier. Can be used in API to force the processing of the files by the Custom file format app. If the `type` parameter is used in API, the `signaturePatterns` will be ignored.
`url`	Tipo: `string` Requerido: sim Description: The relative URL triggered on file import, update, translation upload, and export.
`multilingual`	Type: `bool` Required: no Allowed values: `true`, `false`. Default is `false` Description: This parameter is used to combine the content of multiple languages into one request when uploading and downloading translations in your Crowdin project.
`signaturePatterns`	Tipo: `object` Description: Contains `fileName` and/or `fileContent` regular expressions used to detect file type when uploading a new source file via UI (or via API without specified `type` parameter). If the file matches regular expressions, it's labeled as a custom format file. Note: `fileContent` regular expression checks only the first 64 KB of the file content.

Communication between Custom File Format App and Crowdin

On the initial file import, the system detects custom file format using the signaturePatterns or type parameters and makes an HTTP request to the app’s URL ($baseUrl . $url) for further processing. Then app processes the file in a custom format and responds to the system. The requests and responses to and from the custom file format apps have two-minute timeouts. The maximum request and response payload size is limited to 5 MB.

Request to the App

Request payload example:

// max request payload - 5 MB
// wait timeout - 2 minutes
{
    "jobType": "parse-file | build-file",
    "organization": {
        "id": 1,
        "domain": null,
        "baseUrl": "https://crowdin.com",
        "apiBaseUrl": "https://api.crowdin.com"
    },
    "project": {
        "id": 1,
        "identifier": "your-project-identifier",
        "name": "Your Project Name"
    },
    "file": {
        "id": 1,
        "name": "file.xml",
        "content": "VGhpcyBpcyBmaWxlIGNvbnRlbnQ=", // base64 encoded source file content
        "contentUrl": "https://crowdin-tmp.downloads.crowdin.com/1/file.xml?aws-signature=..." // source file public URL
    },
    "sourceLanguage": {
        "id": "es",
        "name": "Spanish",
        "editorCode": "es",
        "twoLettersCode": "es",
        "threeLettersCode": "spa",
        "locale": "es-ES",
        "androidCode": "es-rES",
        "osxCode": "es.lproj",
        "osxLocale": "es",
        "pluralCategoryNames": ["one"],
        "pluralRules": "(n != 1)"
    },
    "targetLanguages": [{
        // same structure as for sourceLanguage, empty when uploading a new source file, one element for import_translations & export, can be more for miltilingual files
    }],
    "strings": [...], // for the build-file jobs, array of segments
    "stringsUrl": "https://tmp.downloads.crowdin.com/strings.ndjson", // for the build-file jobs, file with segments, in new-line delimited json format
}

Propriedades:

jobType

Tipo: string

Possible values: parse-file, build-file

Description: Specifies the action that should be executed by the app.
parse-file job is used for initial source file upload, source file update, and translation upload. For parse-file jobs, the system passes a source file to the app and expects a parsed source string array in the response.
build-file job is used for translation download. For build-file jobs, the system passes a source file and a string array with translations to the app and expects a generated translation file in the response.

file.content, file.contentUrl

Tipo: string

Description: Parameters used to pass the base64 encoded source file content (file.content) or a source file public URL (file.contentUrl).
Either of these two parameters can be used (Note: Maximum request payload limit is 5 MB).

strings, stringsUrl

Type(strings): array

Type(stringsUrl): string

Description: Parameters used for translations download (for build-file job type only). strings - translation strings array. stringsUrl - public URL to a new-line delimited json with translation strings.
Either of these two parameters can be used (Note: Maximum request payload limit is 5 MB).

Expected Response from the App for the parse-file Job Type

Response payload example:

// max response payload - 5 MB
// wait timeout - 2 minutes
{
    "data": {
        "strings": [...], // segments array
        "stringsUrl": "https://app.example.com/jKe8ujs7a-segments.ndjson", // new-line delimited json file with parsed strings
        "preview": "VGhpbmdzIGFyZSBvbmx5IGltcG9zc2libGUgdW50aWwgdGhleSdyZSBub3Qu", // optional, base64 encoded content of preview html file, not supported if there are plural strings
        "previewUrl": "https://app.example.com/LN3km2K6M-preview.html", // optional, URL of preview html file, not supported if there are plural strings
    },
    "error": {
        "message": "Your error message"
    }
}

Propriedades:

data.strings, data.stringsUrl

Type(data.strings): array

Type(data.stringsUrl): string

Description: Parameters used to pass the parsed strings content.
data.strings - parsed strings array.
data.stringsUrl - public URL to a new-line delimited json with parsed strings.
Either of these two parameters can be used (Note: Maximum response payload limit is 5 MB).

preview, previewUrl

Type(preview): array

Type(previewUrl): string

Description: Parameters used to pass the optional HTML preview of the parsed strings content, which can be generated by the app. The generated HTML preview will be displayed in the Editor. See the HTML Preview file example.

Note: HTML preview won't be displayed in the Crowdin Editor if the app passes strings with plurals.

error.message

Tipo: string

Description: An error message that can be passed from the app to Crowdin and will be visible to a user in UI.

Expected Response from the App for the build-file Job Type

Response payload example:

// max response payload - 5 MB
// wait timeout - 2 minutes
{
    "data": {
        "content": "TWF5IHRoZSBGb3JjZSBiZSB3aXRoIHlvdS4=", // base64 encoded translation file content
        "contentUrl": "https://app.example.com/p5uLEpq8p-result.xml", // translation file public URL
    },
    "error": {
        "message": "Your error message"
    }
}

Propriedades:

data.content, data.contentUrl

Type(data.content): string

Type(data.contentUrl): string

Description: Parameters used to pass the base64 encoded translation file content (data.content) or a translation file public URL (data.contentUrl).
Either of these two parameters can be used (Note: Maximum response payload limit is 5 MB).

error.message

Tipo: string

Description: An error message that can be passed from the app to Crowdin and will be visible to a user in UI.

Strings Array Structure

Below you can see an example of the strings structure expected from the app for parse-file job type and passed to the app for build-file job type.

Payload example:

// strings should be in "new-line delimited json" format if they passed by URL
[{ // non plural string
    "previewId": 1, // only for "parse-file" jobType, required when the HTML preview of the file is generated
    "id": 1, // only for "build-file" jobType
    "identifier": "string-key-1", // required
    "context": "Some context", // optional
    "customData": "max 4 KB of custom data", // optional
    "maxLength": 10, // optional, default null
    "isHidden": false, // optional, default false
    "hasPlurals": false, // optional, default false
    "labels": ["label-one", "label-two"], // optional, default []
    "text": "String source text", // required
    "translations": { // optional
        "uk": { // targetLanguage.id
            "text": "Переклад стрічки", // required
            "status": "untranslated | translated | approved" // optional, default "translated"
        },
        // can be other languages for multilingual, check "targetLanguages" in the request payload
    }
},
{ // plural string
    "previewId": 2,
    "id": 2,
    "identifier": "string-key-2",
    "context": "Some optional context",
    "customData": "max 4 KB of custom data",
    "maxLength": 15,
    "isHidden": false,
    "hasPlurals": true,
    "labels": [],
    "text": { // keys from sourceLanguage.pluralCategoryNames
        "one": "One file",
        "other": "%d files",
    },
    "translations": {
        "uk": {
            "text": { // keys from targetLanguage.pluralCategoryNames
                "one": "One file",
                "few": "%d файла",
                "many": "%d файлів",
            },
            "status": {
                "one": "untranslated",
                "few": "translated",
                "many": "approved",
            }
        }
    }
}]

Propriedades:

`previewId`	Tipo: `integer` Required: yes (only for the `parse-file` job when the HTML preview of the file is generated) Description: Numeric identifier of the string in the HTML Preview file. Used for `parse-file` job type only.
`id`	Tipo: `integer` Description: Numeric identifier of the string in your Crowdin project. Used for `build-file` job type only.
`identifier`	Tipo: `string` Description: Unique string key within the file.
`customData`	Tipo: `string` Description: Any custom data that need to be linked to the string. Added custom data will be exported along the corresponding strings on translation export.

HTML Preview of the file

HTML Preview of the file example:

<html lang="en">
<head>
    <title>Optional Title</title>
    <style>
        table, th, td { border: 1px solid #aaa; }
    </style>
</head>
<body>
    <h1 style="text-align: center">HTML preview of the file</h1>
    <table style="width: 100%">
        <tr>
            <th>Key:</th>
            <th>Text:</th>
        </tr>
        <tr>
            <td>Key 1</td>
            <td><span id="string_preview_id_1">Source Text 1</span></td> <!-- 1 is previewId in strings json -->
        </tr>
        <tr>
            <td>Key 2</td>
            <td><span id="string_preview_id_2">Source Text 2</span></td> <!-- 2 is previewId in strings json -->
        </tr>
    </table>
</body>
</html>

The context menu module allows creating the item in the context menu where it’s possible. Currently, the module can be added to the following context menus:

Context menu item at Resources > TM > TM record.
Context menu item at Resources > Glossary > Glossary record.
Context menu item at Project home page > Language record.
Context menu item at Project > Content > Files > File record.
Context menu item at Project > Content > Screenshots > Screenshot record.
Context menu item at project home page > Language > File record.

Also, this module can perform the following types of actions:

Open a modal dialog with included iframe (see Modal module.
Open a link in the new or the same tab.

Este módulo está disponível para todos os usuários autorizados.

Context menu module structure:

{
  "context-menu": [
    {
      "key": "your-module-key",
      "name": "Module name",
      "description": "Module name",
      "options": {
        "location": "/modal",
        "type": "modal"
      }
    }
  ]
}

Propriedades:

`chave`	Tipo: `string` Requerido: sim Descrição: Identificador de módulo no aplicativo Crowdin.
`name`	Tipo: `string` Requerido: sim Descrição: O nome legível por humanos do módulo. Uses as Context menu text
`description`	Tipo: `string` Description: A human-readable description of what the module does. The description will be visible in the Crowdin UI.
`options.location`	Tipo: `string` Requerido: sim Allowed values: `tm`, `glossary`, `language`, `screenshot`, `source_file`, `translated_file` Description: The location in UI where the context menu can be added.
`options.type`	Tipo: `string` Requerido: sim Allowed values: `modal`, `new_tab`, `redirect` Description: The type of action this module will perform.
`environments`	Tipo: `string` Allowed values: `crowdin`, `crowdin-enterprise` Description: Set of environments where a module could be installed. This parameter is needed for cross-product applications.

The modal module allows creating a new modal dialog. The current module works only with the Context menu module that opens it.

Modal module structure:

{
  "context-menu": [
    {
      "key": "your-module-key",
      "name": "Module name",
      "url": "/module-url"
    }
  ]
}

Propriedades:

`chave`	Tipo: `string` Requerido: sim Descrição: Identificador de módulo no aplicativo Crowdin.
`name`	Tipo: `string` Requerido: sim Descrição: O nome legível por humanos do módulo. Uses as Context menu text
`url`	Tipo: `string` Requerido: sim Description: The relative URL to the content page of the module that will be integrated into the UI.
`environments`	Tipo: `string` Allowed values: `crowdin`, `crowdin-enterprise` Description: Set of environments where a module could be installed. This parameter is needed for cross-product applications.

Add Modules to Your Crowdin App

To use a module in your app, declare the module in your App Descriptor file under modules, including any required properties. The properties you include control the customization options for your module.

Estrutura básica do módulo:

{
  "{module_type}": [
    {
      "key": "your-module-key",
      "name": "Module Name",
      "description": "Module description"
    }
  ]
}

Propriedades:

`{module_type}`	Tipo: `string` Requerido: sim Allowed values `integrations`, `editor-panels`, `resources`, `project-menu`, `custom-mt`, `tools`, `reports`, `custom-file-format` Descrição: O tipo de módulo que o aplicativo Crowdin usa.
`chave`	Tipo: `string` Requerido: sim Descrição: Identificador de módulo no aplicativo Crowdin.
`name`	Tipo: `string` Requerido: sim Descrição: O nome legível por humanos do módulo.
`description`	Tipo: `string` Description: A human-readable description of what the module does. The description will be visible in the Crowdin UI.

Para gerentes de projeto

Começando

Pagamentos

Gerenciamento de projetos

Processo de tradução

Gerenciamento da equipe

Crowdin para empresas

Para tradutores

Começando

Processo de tradução

Para desenvolvedores

Integrações

API

Aplicativos do Crowdin

Notificações e webhooks

Endereços IP e Domínios

Aplicativos OAuth

Escopos

Formatos de arquivo

Empresa

Termos de uso e privacidade

Informações para a imprensa

Neste artigo

Módulos suportados

Módulo de integração

Módulo de painéis do editor

Módulo de recursos

Módulo de menu de projeto

Custom MT (Machine Translation) Module

Tools Module

Reports Module

Custom File Format Module

Communication between Custom File Format App and Crowdin

Request to the App

Expected Response from the App for the parse-file Job Type

Expected Response from the App for the build-file Job Type

Strings Array Structure

Context Menu Module

Modal Module

Add Modules to Your Crowdin App

Este artigo foi útil?