Projekt szerkesztése

Please consider that API 2.0 is now the preferred version to be used. The old API will remain fully functional until the end of 2021.

Crowdin API v2
Crowdin projekt szerkesztése.

Kérelem

Note: Use the combination of project identifier, username, and account key to pass to this endpoint.

POST https://api.crowdin.com/api/project/{project-identifier}/edit-project?login={username}&account-key={account-key}

Paraméterek

Név Érték Leírás
name opcionális string Projekt neve.
languages opcionális array A nyelvkódok tömbje, melyre a projektet le kell fordítani.
join_policy opcionális 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.
  • "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. 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. 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. 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.
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.
Megjegyzés! Ez az opció csak üzleti előfizetésekhez é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 é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 é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 legyen.
jsonp opcionális string Visszahívási függvény neve. Meghatározza, hogy a válasz JSONP formátumban legyen.
Változók
project-identifier string Projekt azonosítója.
login string A felhasználóneve a Crowdinban.
account-key string A fiókja API kulcsa.

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="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>
</project>
Példa válasz a "Moderate" language_access_policy projektekhez.
<?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>
</project>
Sikertelen válasz példa:
<?xml version="1.0" encoding="UTF-8"?>
<error>
  <code>3</code>
  <message>API key is not valid</message>
</error>

Példák

curl \
  -F "logo=@logo.png" \
  -F "name=new project name" \
  -F "description=new project description" \
  -F "cname=new.example.com" \
  -F "languages[]=de" \
  -F "languages[]=fr" \
  -F "languages[]=zh-CN" \
  -F "hide_duplicates=1" \
  -F "export_approved_only=0" \
  -F "public_downloads=1" \
  -F "qa_checks[enabled]=1" \
  https://api.crowdin.com/api/project/{project-identifier}/edit-project?login={username}&account-key={account-key}
<?php
$post_params = array();
$request_url = 'https://api.crowdin.com/api/project/{project-identifier}/edit-project?login={username}&account-key={account-key}';
$post_params['name'] = 'new project name';
$post_params['join_policy'] = 'open';
$post_params['languages[0]'] = 'fr';
$post_params['languages[1]'] = 'de';
$post_params['languages[2]'] = 'zh-CN';
$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?