Autentificare și chei API
Creați o cheie
Section titled “Creați o cheie”Creaza o cheie API sk_ în centrul API . Cheia completă este afișată doar o dată, la creare sau rotație.
Utilizați o cheie separată pentru fiecare aplicație, mediu și sarcină automatizată, astfel încât fiecare să poată avea propriul buget și să poată fi dezactivată, rotită și verificată independent.
Trimiteți credențiala
Section titled “Trimiteți credențiala”Recomandat:
X-API-Key: sk_your_keyForma standard Bearer funcționează de asemenea:
Authorization: Bearer sk_your_keyTrimiteți doar una dintre cele două într-o cerere.
curl https://omnidoc.top/api/v1/jobs \ -H "X-API-Key: $OMNIDOC_API_KEY"Ce reprezintă o cheie
Section titled “Ce reprezintă o cheie”O cheie funcționează pentru contul care a creat-o: poate apela serviciile pe care acel cont le poate utiliza și accesează doar resursele acelui cont. O cheie nu poate schimba adresa de e-mail de autentificare, parola, numărul de telefon sau profilul, iar în plus nu poate crea, roti sau revoca chei API.
Limite opționale:
allowed_engines: doar setările de traducere enumerate; un array gol nu adaugă nicio limită la nivel de cheie.expires_at: timp de expirare.quota_limit: bugetul de viață al cheii în milicredite întregi;0nu setează un buget la nivel de cheie, iar creditele contului sunt calculate cum se obișnuiește.
Rotiți și revocați
Section titled “Rotiți și revocați”Creați chei, modificați limitele acestora, rotiți-le sau revocați-le în centrul API . Odată ce o cheie este revocată, dezactivată sau expirată, sau contul asociat este dezactivat, noi cereri eșuează imediat.
Rotarea generează un nou secret și dezactivează imediat cel vechi; noul cheie păstrează limitele originale și bugetul deja utilizat. O cheie expirată nu poate fi rotită; creați una nouă. Pentru o schimbare fără probleme, creați o cheie nouă și implementați-o, confirmați că apelurile au succes, apoi retraeți cheia veche.
Securitate
Section titled “Securitate”- Păstrați cheile doar pe server sau într-un mediu de execuție controlat.
- Utilizați variabilele de mediu sau un manager de secrete; nu introduceți niciodată cheile în codul sursă, registrele, pachetele browserului sau repo-urile publice.
- Nu trimite niciodată cheia către adresele de încărcare sau descărcare returnate de API.
- Logați ID-ul cheii, ID-ul cererii și ID-ul operației; nu logați niciodată cheia completă.
- Dacă o cheie se scurge, rotește-o imediat și revizuieste sarcinile și încărcările asociate.