Skip to main content
Cheile API autentifică solicitările către API-ul public /v1. Fiecare cheie aparține unui cont de serviciu și este creată din pagina de detalii a acelui cont din Developer Hub. Utilizați o cheie API cu domeniu limitat pentru o integrare backend privată atunci când stocarea și rotirea în siguranță a unui secret răspund cerințelor dumneavoastră. Nu este necesar niciun client OAuth și nicio schimbare de token. Consultați Autentificare dacă organizația dumneavoastră necesită, în schimb, token-uri de acces OAuth cu durată scurtă de viață.

​
Structura unei chei

  • Identificator — începe cu ak_. Poate fi menționat în siguranță în tichete, jurnale și configurații; în sine, nu acordă niciun drept.
  • Secret — începe cu lsk_live_. Aceasta este acreditarea pe care o prezintă integrarea dumneavoastră. Este afișat o singură dată, la creare sau la rotire, și nu mai poate fi recuperat ulterior. Lista de chei afișează doar ultimele patru caractere (de exemplu lsk_live_…xQc4), astfel încât să puteți asocia un rând cu acreditarea deținută de un apelant.
  • Permisiuni — un subset al permisiunilor contului de serviciu proprietar, ales la creare. O cheie nu poate face niciodată mai mult decât permite contul său.
  • Expirare — obligatorie. Fiecare cheie are o dată de expirare.
Stocați secretele într-un manager de secrete imediat ce sunt afișate. Nu le includeți niciodată în controlul versiunilor, nu le încorporați în codul din partea clientului și nu le partajați în chat. Oricine deține secretul poate acționa cu permisiunile cheii.

​
Crearea unei chei

Pe pagina de detalii a contului de serviciu, creați o cheie parcurgând patru pași: denumiți-o, selectați permisiunile necesare acestei chei anume, alegeți o expirare — 30, 90 sau 365 de zile, ori o perioadă personalizată de cel mult un an — și verificați. Secretul este afișat la final, o singură dată. Limitați fiecare cheie la cel mai restrâns set de permisiuni de care are nevoie apelantul, chiar dacă contul permite mai mult. Dacă o cheie este compromisă, permisiunile sale definesc amploarea impactului.

​
Rotirea fără timp de nefuncționare

Rotirea emite un secret nou și începe o fereastră de suprapunere — 1 oră, 24 de ore sau 7 zile — în care vechiul secret continuă să funcționeze. Astfel puteți distribui noul secret în implementările dumneavoastră în ritmul propriu:
1

Rotiți cheia

Alegeți o fereastră de suprapunere care acoperă cea mai lentă cale de implementare. Noul secret este afișat o singură dată — stocați-l imediat.
2

Actualizați integrările

Înlocuiți vechiul secret peste tot unde este configurat. Starea cheii apare ca „în suprapunere” până la încheierea ferestrei.
3

Verificați înainte de închiderea ferestrei

Utilizați jurnalele de solicitări pentru a confirma că traficul a trecut la noul secret. La încheierea suprapunerii, vechiul secret nu mai autentifică.
Rotiți cheia și înainte de expirare: cheile care se apropie de data expirării sunt marcate ca „în curs de expirare” în lista de chei. O cheie expirată nu mai autentifică — solicitările efectuate cu ea returnează 401 cu codul credential_expired.

​
Revocarea imediată

Revocarea are efect imediat și este permanentă — nu există fereastră de suprapunere și nu poate fi anulată. Revocați o cheie în momentul în care suspectați că secretul său a fost expus; rotiți-o în schimb atunci când înlocuiți o acreditare funcțională. Solicitările efectuate cu o cheie revocată returnează 401 cu codul credential_revoked. Dacă trebuie să opriți simultan toate cheile deținute de o integrare, dezactivați în schimb contul său de serviciu.