API

Překládejte JSON i soubory, sledujte průběh úloh a stahujte hotové překlady ze svého serveru.

Pomocí API Lingo.dev překládejte obsah, který spravuje vaše aplikace. Lokalizační úloha propojuje engine, zdrojový jazyk, cílové jazyky a jeden či více dokumentů. U každého dokumentu se sleduje cílový výstup pro každý požadovaný jazyk. U většiny formátů vznikají samostatné cílové soubory; katalogy Apple String Catalogs spojují více jazyků do jednoho souboru.

Základní URL API je https://api.lingo.dev/v2. Přihlašovací údaje k API uchovávejte na svém serveru. Začněte prvním požadavkem na překlad: přeložte dvě zprávy a uložte výsledek.

Vyberte vstup #

Váš obsahZačněte zde
Objekt JSON, který už má vaše aplikace k dispoziciPřeklad JSON. Odešlete objekt přímo v požadavku na vytvoření úlohy.
Soubory ve formátu JSON, Markdown či HTML nebo soubory prostředků pro mobilní aplikacePřeklad dokumentů. Nahrajte původní bajtový obsah a stáhněte soubory ve stejném formátu.
Více dokumentů nebo cílových jazykůVytvoření překladové úlohy. Jedna úloha může obsahovat přímo vložený JSON i nahrané soubory.

Všechny tři možnosti mají stejný životní cyklus:

  1. Vytvořte úlohu a uložte její ID spolu s revizí zdroje.
  2. Nahrajte všechny artefakty uvedené v poli uploads v odpovědi. Přímo vložené zdroje JSON se ukládají už při vytváření úlohy.
  3. Spusťte úlohu.
  4. Sledujte její průběh, dokud nebudou dokončeny požadované cílové výstupy dokumentů.
  5. Stáhněte každý dokončený cílový výstup z jeho status.downloadUrl.

Vytvořením úlohy se uloží zadání práce; teprve spuštěním se práce přijme ke zpracování a začne se zpracovávat. Úspěšná odpověď na požadavek na vytvoření úlohy tedy ještě neobsahuje hotový překlad.

Pokud potřebujete zjistit, co lze znovu využít a jaké budou přibližné náklady, odhadněte rozsah práce ještě před vytvořením úlohy.

Nastavte překlad #

Pomocí engineId výslovně vyberte engine. Ten poskytuje modely, glosáře, pravidla a hlas značky i překladovou pipeline. Klíč API musí mít oprávnění používat tento engine k překladu.

U JSON přidejte pomocí format.options kontext pro konkrétní dokument, nápovědy a chráněné cesty. Při překladu další revize poskytněte předchozí zdroj a překlady, abyste mohli znovu využít nezměněný obsah.

Lidská kontrola umožňuje oprávněným osobám schválit nebo upravit překlady, které splňují podmínky, než bude pipeline pokračovat. Průvodce workflow kontroly vysvětluje, jak propojit odeslání, kontrolu a doručení.

Uchovávejte stav aplikace spolu s úlohou #

Než budete pokračovat, trvale uložte ID úlohy, revizi zdroje, klíče dokumentů a požadované jazyky. Při vytváření úlohy použijte hlavičku Idempotency-Key, abyste při nejednoznačné odpovědi mohli požadavek zopakovat, aniž by vznikla další úloha. Než odešlete náhradní úlohu, načtěte tu stávající.

Stáhněte dokončené cílové výstupy, i když jiný cílový výstup selže. Výsledek publikujte pouze tehdy, pokud stále odpovídá revizi zdroje, kterou vaše aplikace očekává. Tuto koordinaci popisuje tvorba překladového workflow.

Informace o přístupu a obnově po chybách najdete v částech ověřování, chyby a katalog chyb.

Připravte a vylepšujte engine #

Počáteční nastavení naplní glosáře, pravidla a hlas značky na základě obsahu webu nebo textu. Návrhy engine převádějí zpětnou vazbu na návrhy, které si můžete prohlédnout a použít. Než se při překladu začnete řídit vygenerovanými pokyny, zkontrolujte je.