跳转到内容

Autentifikacija i API ključevi

Kreirajte sk_ API ključ u API centru . Potpuni ključ se prikazuje samo jednom, prilikom kreiranja ili rotacije.

Koristite poseban ključ za svaku aplikaciju, okruženje i automatizovanu zadaču, kako bi svaka imala svoj budžet i mogla da se samostalno onemogući, rotira i kontroliše.

Preporučeno:

X-API-Key: sk_your_key

Standardni oblik Bearer takođe funkcioniše:

Authorization: Bearer sk_your_key

U zahtevu pošaljite samo jedan od ta dva.

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

Ključ deluje za nalog koji ga je kreirao: može da poziva usluge koje taj nalog može da koristi i pristupa samo resursima tog naloga. Ključ ne može da promeni adresu e-pošte za prijavljivanje, lozinku, broj telefona ili profil, niti može da kreira, rotira ili opozove API ključeve.

Opcionalni ograničenja:

  • allowed_engines: samo navedena podešavanja prevoda; prazna niz ne dodaje nikakvo ograničenje na nivou ključa.
  • expires_at: vreme isteka.
  • quota_limit: budžet za životni vek ključa u celim milikreditima; 0 ne postavlja budžet na nivou ključa, a krediti naloga se obračunavaju kao i obično.

Kreirajte ključeve, menjajte njihova ograničenja, rotirajte ih ili ih opozovite u /API centru . Čim se ključ opozove, onemogući ili istekne, ili kada se njen nalog onemogući, novi zahtevi odmah ne uspevaju.

Rotacija odmah kreira novu tajnu i onemogućava staru; novi ključ zadržava prvobitna ograničenja i već iskorišćeni budžet. Istekli ključ se ne može rotirati; kreirajte novi. Za glatku zamenu, kreirajte novi ključ i primenite ga, potvrdite da pozivi uspevaju, a zatim opozovite stari ključ.

  • Čuvajte ključeve isključivo na serveru ili u kontrolisanom okruženju za pokretanje.
  • Koristite promenljive okruženja ili menadžer tajnih podataka; nikada ne stavljajte ključeve u izvorni kod, logove, pakete za pregledač ili javne repozitorijume.
  • Nikada ne šaljite ključ na adrese za otpremanje ili preuzimanje koje vraća API.
  • Zapisujte ID ključa, ID zahteva i ID operacije; nikada ne zapisujte ceo ključ.
  • Ako dođe do curenja ključa, odmah ga zamenite i pregledajte njegove zadatke i naplate.