Create Project

Create new Crowdin project.

Important: The API method requires Account API Key. This key can not be found on your profile pages, please contact us to obtain API key for your account.

Request

POST http://api.crowdin.net/api/account/create-project?account-key={account-key}

Parameters

Name	Value	Description
account-keyrequired	string	Crowdin account API key.
loginrequired	string	Your Crowdin Account login name.
namerequired	string	Project name.
identifierrequired	string	Project identifier. Should be unique among other Crowdin projects.
source_languagerequired	string	Source files language. Should be a two letters language code.
languagesrequired	array	An array of language codes project should be translate to.
join_policyrequired	string	Project join policy. Acceptable values are: open moderate private
hide_duplicatesoptional	bool	Defines whether duplicated strings should be displayed to translators or should be hidden and translated automatically. Acceptable values are: 1 or 0.
export_approved_onlyoptional	bool	If set to 1 only approved translations will be exported to resulted ZIP file. Acceptable values are: 1 or 0.
public_downloadsoptional	bool	Defines whether "Download" button is visible to everyone on Crowdin webpages. Acceptable values are: 1 or 0.
logooptional	file	Project logo at Crowdin.
cnameoptional	string	Custom domain name for Crowdin project.
descriptionoptional	string	Project description.
webhook_file_translatedoptional	string	Open this URL when one of the project files is translated. URL will be opened with "project" - project identifier, "language" - language code and "file" - file name.
webhook_file_proofreadoptional	string	Open this URL when one of the project files is proofread. URL will be opened with "project" - project identifier, "language" - language code and "file" - file name.
webhook_project_translatedoptional	string	Open this URL when project translation is complete. URL will be opened with "project" - project identifier and "language" - language code.
webhook_project_proofreadoptional	string	Open this URL when project proofreading is complete. URL will be opened with "project" - project identifier and "language" - language code.
Variables
project-identifierrequired	string	Should contain the project identifier.

Response

If the method is successful, it responds with an XML structure, as shown below.

<?xml version="1.0" encoding="ISO-8859-1"?>

  1
  http://translate.example.com/project/test-project-api/invite
  http://translate.example.com/project/test-project-api
  ca51cef8f852425496b1cdd3e86fea88

Unsuccessful respose sample:

<?xml version="1.0" encoding="ISO-8859-1"?>

  12
  Account key is invalid

Examples

curl \
  -F "login=admin" \
  -F "logo=@logo.png" \
  -F "name=This is a test project" \
  -F "identifier=test-project-api" \
  -F "description=Brief Description" \
  -F "hide_duplicates=1" \
  -F "cname=translate.example.com" \
  -F "join_policy=open" \
  -F "languages[]=fr" \
  -F "languages[]=ru" \
  -F "export_approved_only=1" \
  -F "public_downloads=1" \
  -F "source_language=en" \
  http://api.crowdin.net/api/account/create-project?account-key={account-key}

<?php
  $post_params = array();
  $request_url = 'http://api.crowdin.net/api/account/create-project?account-key={account-key}';
  $post_params['login'] = 'admin';
  $post_params['name'] = 'Test Project';
  $post_params['identifier'] = 'api-test-project';
  $post_params['join_policy'] = 'private';
  $post_params['languages[]'] = 'fr';
  $post_params['languages[]'] = 'uk';
  $post_params['source_language'] = 'en';

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

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

  echo $result;

Create Project

Request

Parameters

Response

Examples

API Methods

Related articles