Ověřování API

Ověřujte požadavky API a udělujte přístup potřebný pro jednotlivé operace.

Klíč API Lingo.dev posílejte v hlavičce X-API-Key. Pro referenční dokumentaci API v této sekci použijte jako základní URL adresu https://api.lingo.dev/v2.

http
GET /v2/organizations/YOUR_ORGANIZATION_ID/localization/jobs HTTP/1.1
Host: api.lingo.dev
X-API-Key: YOUR_API_KEY

Vytvořte klíč v části Klíče API. Uložte ho do prostředí serveru nebo správce tajných údajů. Neukládejte ho do repozitářů, balíčků pro prohlížeč, URL adres ani zdrojových dokumentů.

Zvolte přihlašovací údaj #

Osobní klíč využívá aktuální členství a oprávnění svého uživatele. Servisní klíč organizace patří organizaci a hodí se pro službu běžící bez obsluhy. Jeho přístup určují oprávnění udělená rolí a oprávnění ke zdrojům; užší, výslovně udělené oprávnění neomezuje přístup, který už poskytuje jeho role.

API přijímá také přístupový token relace přihlášeného uživatele jako Authorization: Bearer <access-token>. Uživatel provádějící kontrolu může k odesílání rozhodnutí o kontrole použít svou uživatelskou relaci nebo osobní klíč. Servisní klíče nelze používat k rozhodování v rámci lidské kontroly, protože u těchto akcí musí být možné určit konkrétní osobu.

Pro každý požadavek používejte jen jednu metodu ověřování. V názvech hlaviček se nerozlišují velká a malá písmena.

Vyberte organizaci a engine #

Trasy omezené na konkrétní organizaci obsahují v cestě orgId. ID organizací pro uživatele nebo osobní klíč zjistíte pomocí GET /v2/users/me/memberships. U servisního klíče použijte organizaci, která ho vlastní. ID engine označují engine nakonfigurované v prostředí Studio; seznam přístupných engine získáte pomocí GET /v2/organizations/:orgId/engines.

Vytvoření, spuštění, načtení a stažení lokalizační úlohy vyžaduje přístup k její organizaci a oprávnění k překladu v příslušném engine. Zřizování vyžaduje oprávnění upravit nebo vytvořit engine a vytvořit požadované pokyny. Při kontrole překladů se používají oprávnění a směrování uživatele provádějícího kontrolu.

Samotné předání ID organizace nebo engine přístup neuděluje. Zdroj mimo rozsah přístupu volajícího může vrátit 404. Pokud tedy známý zdroj nelze najít, ověřte jeho ID i oprávnění volajícího.

Zjistěte příčinu selhání přístupu #

Přečtěte si odpověď s podrobnostmi o problému i její stavový kód HTTP. Kód 401 označuje chybějící či neplatný přihlašovací údaj nebo údaj s vypršenou platností. Kód 402 označuje stav související s fakturací nebo plánem, včetně servisního klíče, který je po přechodu na nižší úroveň RBAC neaktivní. Kód 403 označuje zamítnuté oprávnění nebo požadavek na identitu uživatele. Konfiguraci engine a limity účtu je třeba řešit samostatně.

Pro diagnostiku uchovejte type problému, stavový kód a ID zdrojů, která nejsou tajná. Ověřovací hlavičku nikdy nezapisujte do logu.

Obměňte klíč #

Vytvořte náhradní klíč, udělte mu potřebný přístup a aktualizujte tajný údaj služby. Než starý klíč zneplatníte, ověřte, že s novým klíčem lze načíst existující úlohu a stáhnout výsledek. Zaznamenaná ID úloh si ponechte: obměna přihlašovacích údajů identitu úloh nemění.