跳转到内容

Autentifikacija i API ključevi

Kreirajte sk_ API ključ u API centru . Cijeli ključ prikazan je samo jednom, prilikom kreiranja ili rotacije.

Koristite zasebnu ključ za svaku aplikaciju, okolinu i automatiziranu zadaću, kako bi svaka mogla imati vlastiti proračun te se može samostalno onemogućiti, rotirati i provjeravati.

Preporučeno:

X-API-Key: sk_your_key

Standardni oblik Bearer također funkcionira:

Authorization: Bearer sk_your_key

U zahtjevu pošaljite samo jedan od njih.

Terminal window
curl https://omnidoc.top/api/v1/jobs \
-H "X-API-Key: $OMNIDOC_API_KEY"

Ključ djeluje za račun koji ga je kreirao: može pozivati usluge koje taj račun može koristiti i pristupati samo resursima tog računa. Ključ ne može promijeniti e-mail za prijavu, lozinku, broj telefona ili profil te ne može kreirati, rotirati ili otkazati API ključeve.

Opcionalna ograničenja:

  • allowed_engines: samo navedena postavka prijevoda; prazna nizova ne dodaje nikakvo ograničenje na razini ključa.
  • expires_at: vrijeme isteka.
  • quota_limit: proračun za trajanje ključa u cijelih milikredita; 0 ne postavlja proračun na razini ključa, a krediti računa obrađuju se uobičajeno.

Stvorite ključeve, promijenite njihova ograničenja, rotirajte ih ili otkazajte u središtu API . Nakon što se ključ otkaze, onemogući ili istekne, ili kada se njezin račun onemogući, nove zahtjeve odmah neuspjeh.

Rotacija stvara novi tajni ključ i odmah onemogućava stari; novi ključ zadržava izvorne ograničenja i već iskorišten budžet. Istekli ključ ne može se rotirati; kreirajte novi. Za glatku promjenu, kreirajte novi ključ i implementirajte ga, potvrdite da pozivi uspijevaju, a zatim opozovite stari ključ.

  • Čuvajte ključeve isključivo na poslužitelju ili u kontroliranom runtimeu.
  • Koristite okolišne promjenjive ili upravljač tajni; nikada ne stavljajte ključeve u izvorni kod, logove, pakete za preglednike ili javne repozitorije.
  • Nikada ne šaljite ključ za adrese za preuzimanje ili upload koje vraća API.
  • Zabilježite ID ključa, ID zahtjeva i ID operacije; nikada ne bilježite cijeli ključ.
  • Ako dođe do curenja ključa, odmah ga promijenite i provjerite njegove zadatke i pristupe.