Overenie a kľúče API
Vytvorte kľúč
Section titled “Vytvorte kľúč”Vytvorte si kľúč API sk_ v Centri API . Celý kľúč sa zobrazí iba raz, pri jeho vytvorení alebo rotácii.
Používajte samostatný kľúč pre každú aplikáciu, prostredie a automatizovanú úlohu, aby mohla mať vlastný rozpočet a aby sa dala samostatne deaktivovať, obnoviť a auditovať.
Odošlite poverenie
Section titled “Odošlite poverenie”Odporúčané:
X-API-Key: sk_your_keyŠtandardná forma Bearer tiež funguje:
Authorization: Bearer sk_your_keyPošlite v požiadavke iba jednu z týchto dvoch možností.
curl https://omnidoc.top/api/v1/jobs \ -H "X-API-Key: $OMNIDOC_API_KEY"Čo predstavuje kľúč
Section titled “Čo predstavuje kľúč”Kľúč slúži pre účet, ktorý ho vytvoril: môže volať služby, ktoré tento účet môže používať, a pristupuje iba ku zdrojom tohto účtu. Kľúč nemôže zmeniť e-mail prihlásenia, heslo, telefónne číslo ani profil a nemôže vytvárať, obmieňať ani rušiť API kľúče.
Voliteľné limity:
allowed_engines: iba uvedené nastavenia prekladu; prázdny poľ sa nepridáva žiadne obmedzenie na úrovni kľúča.expires_at: čas vypršania platnosti.quota_limit: rozpočet životnosti kľúča v celých millicreditech;0nenastavuje žiadny rozpočet na úrovni kľúča a kredity účtu sa vyrovnávajú štandardne.
Otočiť a zrušiť
Section titled “Otočiť a zrušiť”Vytvárajte kľúče, menite ich limity, rotujte ich alebo ich zrušte v centre API . Akonáhle je kľúč zrušený, zakázaný alebo vypršal jeho platnosť, alebo ak je zakázaný príslušný účet, nové požiadavky okamžite zlyhajú.
Rotácia vytvorí nový kľúč a súčasne deaktivuje starý; nový kľúč zachová pôvodné limity a už použitý rozpočet. Vypršaný kľúč nie je možné rotovať; vytvorte nový. Pre plynulý prechod vytvorte nový kľúč a nasadte ho, potvrďte, že volania sú úspešné, a následne zrušte starý kľúč.
Bezpečnosť
Section titled “Bezpečnosť”- Uchovávajte kľúče iba na serveri alebo v riadenom prostredí bežiaceho systému.
- Používajte premenné prostredia alebo správcu tajných informácií; nikdy neuvádzajte kľúče v zdrojovom kóde, protokoloch, balíčkoch pre prehliadače ani vo verejných repozitároch.
- Nikdy neposielajte kľúč na adresy na nahrávanie alebo stiahnutie vrátené API.
- Zaznamenajte ID kľúča, ID požiadavky a ID operácie; nikdy nezaznamenávajte celý kľúč.
- Ak dôjde k úniku kľúča, okamžite ho vymeňte a skontrolujte jeho úlohy a poplatky.