Máte obsah v jednom jazyce a uživatele, kteří čtou v mnoha dalších. Tohle API tuhle mezeru programově překlene: pošlete text, dostanete zpět překlad a každý překlad projde přes lokalizační engine, který nastavíte jednou. Engine při každém volání uplatní váš glosář, hlas značky, instrukce a výběr modelu pro jednotlivé jazyky – takže výstup zní přesně tak, jak se váš tým rozhodl, ne tak, jak to odhadl obecný model.
Zbývá už jen jedno rozhodnutí: kolik toho potřebujete přeložit najednou. Přeložte jeden jazyk v jednom požadavku a výsledek si vezměte přímo z odpovědi, nebo platformě předejte více jazyků a nechte ji každý z nich přeložit jako samostatnou úlohu na pozadí, zatímco vaše aplikace zůstane responzivní. Tato stránka pokrývá základní URL, právě toto rozhodnutí a to, kam pokračovat dál.
Co toto API předpokládá
Toto je Reference pro programový překlad. Předpokládá, že jste se rozhodli lokalizovat z vlastního kódu nebo pipeline – ne přes dashboard – a že máte API klíč. Pokud jste na platformě noví, první koncept, kterému je potřeba porozumět, je lokalizační engine; vše tady přes něj prochází.
Na této stránce
- Základní URL
- Dva způsoby překladu
- Asynchronně: více jazyků jako úlohy
- Synchronně: jeden požadavek, jedna odpověď
- Další kroky
Základní URL#
Všechny REST endpointy v této referenci běží pod jedním hostitelem:
https://api.lingo.devKaždý požadavek navíc nese jednu hlavičku, X-API-Key. Klíč je vázaný na organizaci a při vytvoření se zobrazí jen jednou; úplná pravidla pro jeho posílání najdete v části Authentication a informace o tom, co se vrací při zamítnutí požadavku, v části Errors and status codes.
Dva způsoby překladu#
Za oběma režimy stojí stejný engine, stejný glosář i stejný hlas značky. Liší se jen to, kdo nese čekání.
Synchronní volání přeloží jeden pár jazyků a vrátí přeložená data v odpovědi. Je to jednodušší varianta – jeden požadavek, jedna odpověď, žádný endpoint, který byste museli provozovat na své straně – a správná volba ve chvíli, kdy potřebujete jeden jazyk a můžete počkat na jeden round-trip.
Obsah se ale zřídka vydává jen v jednom jazyce. Školicí modul míří do 14 jazyků; položka v CMS se rozšíří do všech trhů, na kterých prodáváte. Pokud spustíte jedno sync volání pro každý jazyk, nesete 14 round-tripů i retry logiku pro případ, že některé selže; pokud budete čekat na jedno sync volání pro všechny, zablokujete se na tom nejpomalejším. Proto API nabízí také asynchronní režim: jednou odešlete obsah metodou POST s cílovými jazyky, okamžitě získáte 202 a platforma přeloží každý jazyk jako samostatnou úlohu na pozadí – převezme retry logiku i izolaci selhání, zatímco vaše aplikace zůstane responzivní.
Po async sáhněte ve chvíli, kdy je úloha příliš velká, příliš pomalá nebo zahrnuje příliš mnoho jazyků na to, abyste na ni blokovali. Po sync sáhněte, když vám stačí jeden pár jazyků v jedné odpovědi. Stránky o async režimu jsou níže uvedené jako první, protože pokrývají víc, ale ani jeden z těchto režimů není „to pravé“ API – jsou to dvě podoby téhož engine.
Asynchronně: více jazyků jako úlohy#
Jeden požadavek, všechny jazyky, výsledky průběžně podle toho, jak přicházejí. Async API přijme jedno odeslání, vytvoří jednu úlohu pro každý cílový jazyk a doručí každý výsledek ve chvíli, kdy je hotový – přes webhook nebo WebSocket – aniž by vaše aplikace na cokoli z toho musela čekat.
Synchronně: jeden požadavek, jedna odpověď#
Když potřebujete jeden pár jazyků a můžete počkat na round-trip, zavolejte sync endpoint a přečtěte si výsledek přímo z odpovědi – bez webhook endpointu a bez pollingu.
Další kroky#
Ať už zvolíte kterýkoli režim, engine, který za ním stojí, ladíte vy. Vygenerujte klíč a pak určete, co má engine při každém volání dělat – jaký model má vybrat pro každý jazyk a které termíny musí překládat přesně.
