Autentizace a API klíče
Vytvořte klíč
Section titled “Vytvořte klíč”Vytvořte klíč API sk_ v /centru API . Plný klíč je zobrazen pouze jednou, při jeho vytvoření nebo rotaci.
Používejte pro každou aplikaci, prostředí a automatizovanou úlohu samostatný klíč, aby mohl mít vlastní rozpočet a byl nezávisle na ostatních deaktivován, obměněn a auditován.
Odešlete přihlašovací údaje
Section titled “Odešlete přihlašovací údaje”Doporučeno:
X-API-Key: sk_your_keyStandardní forma Bearer také funguje:
Authorization: Bearer sk_your_keyV požadavku odešlete pouze jeden z nich.
curl https://omnidoc.top/api/v1/jobs \ -H "X-API-Key: $OMNIDOC_API_KEY"Co představuje klíč
Section titled “Co představuje klíč”Klíč platí pro účet, který byl vytvořen: může volat služby, které tento účet může používat, a přistupovat pouze ke zdrojům tohoto účtu. Klíč nemůže změnit e-mail pro přihlášení, heslo, telefonní číslo ani profil a nemůže vytvářet, otáčet nebo rušit API klíče.
Volitelné limity:
allowed_engines: pouze uvedená nastavení překladu; prázdný pole nezadá žádné omezení na úrovni klíče.expires_at: čas vypršení platnosti.quota_limit: rozpočet životnosti klíče v celých millicredeitech;0nenastavuje rozpočet na úrovni klíče a kredity účtu jsou vyrovnány standardně.
Otočit a zrušit
Section titled “Otočit a zrušit”Vytvářejte klíče, měňte jejich limity, rotujte je nebo je zrušte v centru API . Jakmile je klíč zrušen, deaktivován nebo vypršel jeho platnost, případně je-li deaktivován jeho účet, nové požadavky okamžitě selžou.
Rotace vytvoří nové tajné heslo a okamžitě deaktivuje to staré; nové heslo zachová původní limity a již použitý rozpočet. Propadlé heslo nelze rotovat; vytvořte nové. Pro plynulý přechod vytvořte nové heslo a nasazením ověřte, že volání jsou úspěšná, a teprve poté zrušte staré heslo.
Bezpečnost
Section titled “Bezpečnost”- Uchovávejte klíče pouze na serveru nebo v řízeném runtime.
- Používejte proměnné prostředí nebo správce tajných informací; nikdy neuvádějte klíče v zdrojovém kódu, protokolech, balíčcích pro prohlížeče ani ve veřejných repozitářích.
- Nikdy neodesílejte klíč na adresy pro nahrávání nebo stahování vrácené API.
- Zaznamenejte ID klíče, ID požadavku a ID operace; nikdy nezaznamenávejte celý klíč.
- Pokud dojde k úniku klíče, okamžitě jej zmeňte a zkontrolujte jeho úkoly a poplatky.