v2
latestOpenAPI 3.0.02026-08-07103189636.5 KBDownload multiple translated files (DEPRECATED)
Download ZIP archive with the requested translated files.
Unlike "Download all translations of the file" you can specify multiple file URIs (limit is 300 files) and locale IDs to select which files and languages you want to download.
It is important to check the HTTP response status code. If Smartling finds and returns the file normally, you will receive a 200 SUCCESS response. If you receive any other response status code than 200, the requested files will not be part of the response.
When you upload a UTF-16 character encoded file, then /file/get requests for that file will have a character encoding of UTF-16. All other uploaded files will return with a character encoding of UTF-8.
You can always use the content-type header in the response of a file/get request to determine the character encoding.
Example:
curl -X GET -H "Authorization: Bearer {token}" 'https://api.smartling.com/files-api/v2/projects/{projectId}/files/zip?localeIds[]=de-DE&fileUris[]=yourfile.json'
Path parameters
A unique project identifier. This can be found in the Smartling Dashboard under Account Settings > API.
Query parameters
Smartling values that each uniquely identify a file. The limit is 300 files.
List of locales to download.
Determines the desired format for the download. Applies only to translated files.
| retrievalType | Description |
|---|---|
| pending | Smartling returns any translations (including non-published translations) |
| published | Smartling returns only published/pre-published translations. |
| pseudo | Smartling returns a modified version of the original text with certain characters transformed and the text expanded. For example, the uploaded string "This is a sample string", will return as "T |
| contextMatchingInstrumented | Smartling returns a modified version of the original file with strings wrapped in a specific set of Unicode symbols that can later be recognized and matched by the Chrome Context Capture Extension. |
Specifies whether Smartling will return the original string or an empty string where no translation is available. This parameter is only supported for ANDROID, ARB, GETTEXT, IDML, IOS, JAVA Properties, JSON, QT, STRINGSDICT, XLIFF, XML, and YAML files. If unset, the default is <code>true</code>.
| Value | Description |
|---|---|
| true | If there is no translation, Smartling returns the original string. |
| false | If there is no translation, Smartling returns an empty string. |
Determines how files in the ZIP file will be named. If not set, the full original file path will be used as the filename.
| fileNameMode | Description |
|---|---|
| UNCHANGED | Full original file path is used |
| TRIM_LEADING | Remove all except the last path segment. e.g. /en/strings/nav.properties becomes nav.properties |
| LOCALE_LAST | Adds a locale folder to the file path directly before the filename. e.g. /strings/nav.properties becomes /strings/en/nav.properties |
Determines how locales will be handled in the downloaded zip
| localeMode | Description |
|---|---|
| LOCALE_IN_PATH | Locale code is added to the end of the file path. e.g. /strings/es-ES/nav.properties. |
| LOCALE_IN_NAME | Locale code is added to the end of the file name e.g. /strings/nav_es-ES.properties. |
| LOCALE_IN_NAME_AND_PATH | Locale code is added to both the path and the filename. e.g. /strings/es-ES/nav_es-ES.properties. |
Name for the downloaded ZIP file. If unset, default is translations.zip
Response
OK