Setting up API Integration

Crowdin provides RESTful API with XML or JSON over HTTP using GET or POST methods. Listed below are all the available API methods, which allows you to create projects in Crowdin, add and update files, download translations or integrate localization with your development process.

Acquiring and Using an API Key

To find your project API key you have to login to your Crowdin account. Find the project, open Project Settings page and activate API tab.

Please note that almost all API calls require the Project Identifier (ID). You can find your project identifier right above the API key.

Making Requests

For every API request you make, you'll need to present the API access key as the main URI parameter to be authenticated. Keep the API key in secret! It should be guarded just as your regular account password.

Here's an example and principle of API request URI forming.

GET https://api.crowdin.com/api/project/{project-identifier}/download/all.zip?key={project-key}

Typical API call URL looks like this: https://api.crowdin.com/api/project/. First placeholder (keyword in brackets) holds project identifier. API access key is specified as a URI parameter.

Methods

Add File

Add new file to Crowdin project.

Update File

Upload latest version of your localization file to Crowdin.

Delete File

Delete file from Crowdin project. All the translations will be lost without ability to restore them.

Upload Translation

Upload existing translations to your Crowdin project.

Translation Status

Track overall translation and proofreading progresses of each target language. Default response format is XML.

Language Status

Get the detailed translation progress for specified language.

Project Details

Get Crowdin Project details.

Reported Issues

Get a list of issues reported in the Editor.

Download Translations

Download a ZIP file with translations. You can choose the language of translation you need or download all of them at once.

Export File

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

Export Translations

Build ZIP archive with the latest translations.

Pre-Translate

Pre-translate Crowdin project files.

Account Projects

Get projects list.

Create Project

Create Crowdin project.

Edit Project

Edit Crowdin project.

Delete Project

Delete Crowdin project with all translations.

Add Directory

Add directory to Crowdin project.

Change Directory

Rename directory or modify its attributes. When renaming directory the path can not be changed (it means new_name parameter can not contain path, name only).

Delete Directory

Delete Crowdin project directory. All nested files and directories will be deleted too.

Download Glossary

Download Crowdin project glossaries as TBX file.

Upload Glossary

Upload your glossaries for Crowdin Project in TBX, CSV or XLS/XLSX file formats.

Download TM

Download Crowdin project Translation Memory as TMX file.

Upload TM

Upload your Translation Memory for Crowdin Project in TMX, CSV or XLS/XLSX file format.

Supported Languages

Get supported languages list with Crowdin codes mapped to locale name and standardized codes.

Pseudo Export

Generate pseudotranslation files for the whole project.

Pseudo Download

Download ZIP file with pseudo translations.

Export Costs Estimation Report

Generate Costs Estimation report to have an insight on how to plan the budget. This report allows you to calculate the approximate translation cost of currently untranslated strings in the project.

Download Costs Estimation Report

Download previously generated Costs Estimation report.

Export Translation Costs Report

Generate Translation Costs report to calculate the real translation cost and know how much your translators and proofreaders should be paid.

Download Translation Costs Report

Download previously generated Translation Costs report.

Export Top Members Report

Generate Top Members report to know who contributed the most to your project's translation during the specified date range.

Download Top Members Report

Download previously generated Top Members report.

Was this article helpful?