Projekt létrehozása

Crowdin projekt létrehozása.

Kérelem

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

Paraméterek

Név Érték Leírás
login szükséges string Az Ön Crowdin fiók bejelentkezési neve.
name szükséges string Projekt neve.
identifier szükséges string Projekt azonosítója. Egyedinek kell lennie a többi Crowdin projekt miatt.
source_language szükséges string Forrásfájlok nyelve. Crowdin nyelvkód.
languages szükséges array A nyelvkódok tömbje, melyre a projektet le kell fordítani.
join_policy szükséges string Projekt csatlakozási irányelv. Elfogadható értékek:
  • open
  • private
language_access_policy opcionális string Meghatározza, hogy a projekt tagjai hogyan érhetik el a célnyelveket. Elfogadható értékek:
  • "open" - bármely fordító hozzáférhet bármilyen nyelvhez. (alapértelmezett)
  • "moderate" - a fordító bizonyos nyelvhez való hozzáférése biztosított.
hide_duplicates opcionális int Meghatározza, hogy az ismétlődő karakterláncok megjelenjenek-e a fordítóknak, vagy rejtettek legyenek és fordításuk automatikus legyen. Elfogadható értékek:
  • 0 - Megjelenít – fordítók minden példányt külön-külön fordítanak
  • 1 - Elrejt - minden ismétlődő azonos fordításon osztozik
  • 2 - Megjelenít, de automatikusan fordítja őket
  • 3 - Megjelenít (verziókhoz ajánlott) - ismétlődések csak a verziók között lesznek rejtve
export_translated_only opcionális bool Meghatározza, hogy csak a lefordított karakterláncokat kell e exportálni a végleges fájlba. Nem javasoljuk ezt a beállítást, ha szöveges (*.html, *.txt, *.docx, stb.) dokumentumok vannak a projektben, mivel károsíthatja az eredményül kapott fájlokat. Elfogadható értékek: 1 vagy 0.
export_approved_only opcionális bool Ha az értéke 1-re van állítva, csak a jóváhagyott fordítások lesznek exportálva az eredményül kapott ZIP fájlban. Az elfogadható értékek: 1 vagy 0.
auto_translate_dialects opcionális bool Az exportált fájlban a le nem fordított karakterláncok a dialektusokban automatikusan lefordításra kerülnek a főnyelven történt fordítások segítségével. Az elfogadható értékek: 1 vagy 0.
public_downloads opcionális bool Meghatározza, hogy a "Letöltés" gomb mindenki számára látható-e a Crowdin weboldalain. Az elfogadható értékek: 1 vagy 0.
use_global_tm opcionális bool Meghatározza, hogy a fordítások használják-e a Crowdin globális Fordítási memóriát. Az opció használata esetén a projektben végrehajtott fordítások automatikusan a Crowdin globális FM-be kerülnek. Elfogadható értékek: 1 vagy 0.
logo opcionális file Projekt logója a Crowdinon.
cname opcionális string A Crowdin projekt egyéni tartományneve.
description opcionális string Projekt leírása.
in_context opcionális bool Meghatározza, hogy a Szövegkörnyezeti fordítás aktív legyen e a projektben. Az elfogadható értékek: 1 vagy 0.
pseudo_language opcionális string Adja meg a nyelvkódot a Szövegkörnyezeti látszat-nyelvhez, amely bizonyos működési adatokat tárol.
qa_checks opcionális array Meghatározza, hogy a minőség-ellenőrzési vizsgálatok aktívak legyenek e a projektben. Kulcsként meg kell adnia a minőség-ellenőrzési paramétert (Minőség-ellenőrzési vizsgálatok paramétereinek áttekintése). Lehetséges kulcsok a következők:
  • "enabled" — Minőség-ellenőrzési vizsgálatok engedélyezése/tiltása
  • "empty" — Üres fordítás
  • "size" — Hossz problémák
  • "tags" — Jelölő eltérések
  • "spaces" — Szóköz eltérések
  • "variables" — Változó eltérések
  • "punctuation" — Írásjel eltérések
  • "symbol_register" — Karakterméret eltérések
  • "special_symbols" — Különleges karakter eltérések
  • "wrong_translation" — "Helytelen fordítás" problémák
  • "spellcheck" — Helyesírás
  • "icu" — ICU szintaxis
Elfogadható értékek: 1 vagy 0.
Figyelem! Ez az opció csak üzleti díjcsomagokhoz érhető el.
webhook_file_translated opcionális string Nyissa meg ezt az URL-t, ha az egyik projektfájl fordításra került. Az URL a "project" - projekt azonosító, a "language" - nyelvkód, a "file_id" - a Crowdin fájl azonosítója és a "file" - fájlnév segítségével kerül megnyitásra.
webhook_file_proofread opcionális string Nyissa meg ezt az URL-t, ha az egyik projektfájl lektorálásra került. Az URL a "project" - projekt azonosító, a "language" - nyelvkód, a "file_id" - a Crowdin fájl azonosítója és a "file" - fájlnév segítségével kerül megnyitásra.
webhook_project_translated opcionális string Nyissa meg ezt az URL-t, ha a projekt fordítása elkészült. Az URL a "project" - projekt azonosító és a "language" - nyelvkód segítségével kerül megnyitásra.
webhook_project_proofread opcionális string Nyissa meg ezt az URL-t, ha a projekt lektorálása elkészült. Az URL a "project" - projekt azonosító és a "language" - nyelvkód segítségével kerül megnyitásra.
json opcionális string Nem tartalmazhat értéket. Meghatározza, hogy a válasz JSON formátumban kell legyen.
jsonp opcionális string Visszahívási funkció neve. Meghatározza, hogy a válasz JSONP formátumban legyen.
Változók
account-key szükséges string Crowdin fiók API kulcs.

Válasz

Ha a módszer sikeres, akkor XML struktúrával válaszol, ahogy az az alábbiakban látható (ha a language_access_policy = open).
<?xml version="1.0" encoding="ISO-8859-1"?>
<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>
Példa válasz a "Moderate" language_access_policy projektekhez.
<?xml version="1.0" encoding="ISO-8859-1"?>
<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>
Sikertelen válasz példa:
<?xml version="1.0" encoding="ISO-8859-1"?>
<error>
  <code>12</code>
  <message>Account key is invalid</message>
</error>

Példák

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;

Hasznos volt ez a cikk?