Zaregistrujte sa ako vývojár a získajte API kľúč

Poskytuje RESTful API pre preklad dokumentov, podporuje automatizované riadenie prekladateľských úloh, terminologickú konzistentnosť založenú na glosároch a dotazy na podporované formáty, jazyky a modely, čo umožňuje jednoduché vytváranie plynulých prekladateľských pracovných postupov a správu používateľských účtov.

Začíname

Pre začiatok sa musíte zaregistrovať ako vývojár.Prihlásiť sa ako vývojár

Po schválení môžete vytvoriť viacero API kľúčov a zahrnúť príslušný API kľúč do každej API požiadavky podľa potreby.

Získať váš API kľúč

Rýchle pripojenie

Základná URL adresa

https://shangyiai.com/api

Spôsob autentifikácie

Authorization: [yourSecretKey]

JSON požiadavka

Okrem rozhrania pre nahrávanie súborov používajú rozhrania štandardne POST JSON požiadavky, Content-Type je application/json.

Nahrávanie súboru

Vytvorenie úlohy prekladu dokumentu používa multipart/form-data, pole file prenáša súbor určený na preklad.

Univerzálna chybová odpoveď

Pri zlyhaní požiadavky rozhranie vráti JSON, pole error obsahuje fixnú anglickú chybovú správu. Odporúča sa prednostne rozvetvovať spracovanie chýb podľa HTTP status code, pole error používať na zobrazenie alebo záznam do logu.

{
  "error": "Invalid API key."
}

Pravidlá kódov chybových stavov

Všetky chybové odpovede v1 API zachovávajú rovnakú štruktúru, prosím spracujte ich podľa nasledujúcich pravidiel HTTP status code.

400 Bad Request: Chýbajúce požadované parametre, neplatné formáty parametrov alebo hodnoty enum, chýbajúce nahratie súboru, zlyhanie uloženia nahratia alebo zlyhanie spracovania úlohy.
401 Unauthorized: Chýbajúci API klúč alebo neplatný API klúč.
402 Payment Required: Nedostatočný zostatok kreditov pre náhľad, úplný preklad alebo preklad textu.
404 Not Found: Úloha alebo glosár neexistuje, bol odstránený, nepatrí k aktuálnemu API účtu, alebo nebol vytvorený prostredníctvom API.
409 Conflict: Súčasný stav úlohy neumožňuje požadovanú operáciu.
500 Internal Server Error: Neočakávaná výnimka servera. Chyba odpovede je určená ako "Interná chyba servera.".

Odporúčaný postup pripojenia

1. Vytvorenie úlohy

Nahrať súbor a vytvoriť prekladovú úlohu, vracia taskId.

2. Kontrola priebehu

Dotazovať stav úlohy, kým nedosiahne Completed, Terminated alebo Cancelled.

3. Získanie výsledkov

Stiahnuť preložený súbor alebo načítať pôvodný a preložený JSON.

4. Správa úloh

Platba podľa použitia za preklad celého textu, reštartovanie úlohy, revíziu textu alebo odstránenie úlohy.

Zdroje

Komunita vývojárov

Ak máte akékoľvek otázky, môžete získať pomoc v komunite vývojárov.