Your application needs to identify itself every time it sends a request to the Crowdin API by an API Key with each request. Each Crowdin project has its own API Key.

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 secret! It should be guarded just as you would your regular account password.

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

http://api.crowdin.net/api/project/{project-identifier}/download/all.zip?key={project-key}

Typical API call URL looks like this: http://api.crowdin.net/api/project/. First placeholder (keyword in brackets) holds project identifier and action needed (download as shown in the example). API access key is specified as a URI parameter.

Error codes

0: Internal error
1: The Project Identifier value passed in is not valid.
2: Invalid API method specified.
3: The API key pass is not valid.
4: The files HTTP POST variable are required and must be provided.
5: You're trying to add already existing file.
6: An error occurred while uploading file.
7: Invalid file extension provided.
8: Requested file not found.
9: Language parameter missing
10: Invalid language code
11: Account does not exists
12: Account key is not valid
13: General error
14: File type parameter not specified
15: File type parameter is not valid
16: File schema for CSV file is not specified
17: Directory not found
18: No user id specified in request
19: User with such id already exists
20: User not found
21: Specified value for "files" parameter is not valid. Array expected
22: Specified value for "titles" parameter is not valid. Array expected
23: Specified value for "export_patterns" parameter is not valid. Array expected
24: Specified value for "languages" parameter is not valid. Array expected
25: An error occurred while uploading glossary
26: Directory or path does not exist

The Crowdin API gives you access to almost all of the features available in your account, letting you automate a lot of common operations. If you need help working with the API please do not hesitate to contact us.