For Project Managers

For Translators

For Developers

API Methods

Company

Export File

This method exports single translated files from Crowdin. Additionally, it can be applied to export XLIFF files for offline localization.

Request

Note: Either use the combination of project identifier and project key or combination of project identifier, username, and account key to pass to this endpoint.

GET https://api.crowdin.com/api/project/{project-identifier}/export-file?key={project-key}
GET https://api.crowdin.com/api/project/{project-identifier}/export-file?login={username}&account-key={account-key}
Note: Exporting files from Crowdin you’ll receive an Etag identifier in response header. Store this identifier so you can use it next time exporting files. Add Etag identifier to the If-None-Match request header to see whether any changes were applied to the file. In case the file was changed it would be downloaded. If not you’ll receive a 304 (Not Modified) status code.

Parameters

Name Value Description
key required string Project API key
project-identifier required string Should contain the project identifier.
file required string This parameter specifies a path to the file that should be exported from the project.
language required string Crowdin language code.
branch optional string The name of related version branch (Versions Management).
format optional string Specify xliff to export file in the XLIFF file format.
export_translated_only optional bool Use this parameter if you want to get only translated strings in the exported file. We don't recommend to set this option if you have text (*.html, *.txt, *.docx etc.) documents in your project since it may damage resulted files. Acceptable values are: 1 or 0.
export_translated_files_only optional bool Use this parameter if you want to get only translated files on export. Acceptable values are: 1 or 0.
export_approved_only optional bool If set to 1 only approved translations will be exported in resulted file. Acceptable values are: 1 or 0.

Examples

#Download file in the same file format as source
wget -O de.xml "https://api.crowdin.com/api/project/{project-identifier}/export-file?file=en.xml&language=de&key={project-key}"

#Download file for offline translation in XLIFF file format
wget -O de.xliff "https://api.crowdin.com/api/project/{project-identifier}/export-file?file=en.html&format=xliff&language=de&key={project-key}"
<?php
ini_set('default_socket_timeout', 5); // socket timeout, just in case

$request_url = 'https://api.crowdin.com/api/project/{project-identifier}/export-file?file=en.html&format=xliff&language=de&key={project-key}';

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $request_url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

$result = curl_exec($ch);
curl_close($ch);

echo $result;

Was this article helpful?