Crea progetto

Create Crowdin project.

Richiesta

POST https://api.crowdin.com/api/account/create-project?account-key={account-key}

Parametri

Nome Value Descrizione
login required nella stringa Your Crowdin Account login name.
name required nella stringa Nome del progetto.
identifier required nella stringa Identificatore progetto. Should be unique among other Crowdin projects.
source_language required nella stringa Source files language. Crowdin language code.
languages required insieme An array of language codes project should be translate to.
join_policy required nella stringa Project join policy. Valori accettabili sono:
  • apri
  • private
language_access_policy optional nella stringa Defines how project members can access target languages. Valori accettabili sono:
  • "open" - any translator can access any language. (predefinito)
  • "moderate" - translator should be granted with access to certain language.
hide_duplicates optional int Defines whether duplicated strings should be displayed to translators or should be hidden and translated automatically. Valori accettabili sono:
  • 0 - Show – translators will translate each instance separately
  • 1 - Hide – all duplicates will share the same translation
  • 2 - Show, but auto-translate them
  • 3 - Show (recommended for versions) - duplicates will be hidden only between versions
export_translated_only optional booleano Defines whether only translated strings will be exported to the final file. We do not recommend to set this option if you have text (*.html, *.txt, *.docx etc.) documents in your project since it may damage resulted files. Valori accettabili sono: 1 o 0.
export_approved_only optional booleano If set to 1 only approved translations will be exported in resulted ZIP file. Valori accettabili sono: 1 o 0.
auto_translate_dialects optional booleano Untranslated strings of dialect will be translated automatically in exported file, leveraging translations from main language. Valori accettabili sono: 1 o 0.
public_downloads optional booleano Defines whether "Download" button visible to everyone on Crowdin webpages. Valori accettabili sono: 1 o 0.
use_global_tm optional booleano Defines if translations would be leveraged from Crowdin Global Translation Memory. When using this option any translations made in your project will be commited to Crowdin Global TM automatically. Valori accettabili sono: 1 o 0.
logo optional file Project logo at Crowdin.
cname optional nella stringa Custom domain name for Crowdin project.
description optional nella stringa Descrizione del progetto.
in_context optional booleano Defines whether the In-Context should be active in the project. Valori accettabili sono: 1 o 0.
pseudo_language optional nella stringa Specify the language code for the In-Context's pseudo-language that will store some operational data.
qa_checks optional insieme Defines whether the QA checks should be active in the project. As a key you must specify QA check parameter (An Overview of QA Check Parameters). Possible keys are:
  • "enabled" — Enable of disable QA checks
  • "empty" — Empty translation
  • "size" — Length issues
  • "tags" — Tags mismatch
  • "spaces" — Spaces mismatch
  • "variables" — Variables mismatch
  • "punctuation" — Punctuation mismatch
  • "symbol_register" — Character case mismatch
  • "special_symbols" — Special characters mismatch
  • "wrong_translation" — “Incorrect translation” issues
  • "spellcheck" — Spelling
  • "icu" — ICU syntax
Valori accettabili sono: 1 o 0.
Note! This option is available only for organization plans.
webhook_file_translated optional nella stringa Open this URL when one of the project files is translated. URL will be opened with "project" - project identifier, "language" - language code, "file_id" - Crowdin file identifier and "file" - file name.
webhook_file_proofread optional nella stringa Open this URL when one of the project files is proofread. URL will be opened with "project" - project identifier, "language" - language code, "file_id" - Crowdin file identifier and "file" - file name.
webhook_project_translated optional nella stringa Open this URL when project translation is complete. URL will be opened with "project" - project identifier and "language" - language code.
webhook_project_proofread optional nella stringa Open this URL when project proofreading is complete. URL will be opened with "project" - project identifier and "language" - language code.
json optional nella stringa May not contain value. Defines that response should be in JSON format.
jsonp optional nella stringa Callback function name. Defines that response should be in JSONP format.
Variables
chiave-profilo nella stringa Crowdin account API key.

Response

If the method is successful, it responds with an XML structure, as it is shown below (when language_access_policy = open).
<?xml version="1.0" encoding="UTF-8"?>
<project>
  <success>1</success>
  <invitation>http://translate.example.com/project/test-project-api/invite</invitation>
  <url>http://translate.example.com/project/test-project-api</url>
  <key>ca51cef8f852425496b1cdd3e86fea88</key>
</project>
Response example for projects with "Moderate" language_access_policy.
<?xml version="1.0" encoding="UTF-8"?>
<project>
  <success>1</success>
  <invitation>
    <item>
      <language>Ukrainian</language>
      <translator>http://translate.example.com/project/test-project-api/invite?d=7585662585d5d32307d3937373</translator>
      <proofreader>http://translate.example.com/project/test-project-api/invite?d=3585k635r4d5d32307d3937373</proofreader>
    </item>
  </invitation>
  <url>https://crowdin.com/project/test-project-api</url>
  <key>d13720ba72204273af0321ca980945ec</key>
</project>
Campione di risposta non riuscita:
<?xml version="1.0" encoding="UTF-8"?>
<error>
  <code>12</code>
  <message>Account key is invalid</message>
</error>

Esempi

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" \
  -F "qa_checks[enabled]=1" \
  https://api.crowdin.com/api/account/create-project?account-key={account-key}
<?php
$post_params = array();
$request_url = 'https://api.crowdin.com/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[0]'] = 'fr';
$post_params['languages[1]'] = 'uk';
$post_params['source_language'] = 'en';
$post_params['qa_checks[enabled]'] = 1;

$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;

Questo articolo è stato utile?