Skip to main content
Les claus d’API autentiquen les sol·licituds a l’API pública de /v1. Cada clau pertany a un compte de servei i es crea des de la pàgina de detall d’aquest compte al Developer Hub. Feu servir una clau d’API amb abast limitat per a una integració de backend privada quan l’emmagatzematge segur i la rotació d’un secret compleixin els vostres requisits. No cal cap client OAuth ni intercanvi de testimonis. Consulteu Authentication si la vostra organització requereix testimonis d’accés OAuth de curta durada.

​
Anatomia d’una clau

  • Identificador: comença per ak_. Es pot referenciar amb seguretat en incidències, registres i configuració; per si sol no atorga cap accés.
  • Secret: comença per lsk_live_. És la credencial que presenta la vostra integració. Es mostra una sola vegada, en crear-lo o renovar-lo, i no es pot recuperar posteriorment. La llista de claus només mostra els últims quatre caràcters (per exemple, lsk_live_…xQc4) perquè pugueu associar una fila a la credencial que té un emissor de sol·licituds.
  • Permissions: un subconjunt dels permisos del compte de servei propietari, triats en el moment de la creació. Una clau mai no pot fer més del que permet el seu compte.
  • Expiration: obligatòria. Totes les claus tenen una data de caducitat.
Deseu els secrets en un gestor de secrets en el mateix moment en què es mostrin. No els publiqueu mai al control de versions, no els incrusteu en codi del costat del client ni els compartiu per xat. Qualsevol persona que tingui el secret pot actuar amb els permisos de la clau.

​
Crear una clau

A la pàgina de detall del compte de servei, creeu una clau seguint quatre passos: poseu-li un nom, trieu els permisos que necessita aquesta clau concreta, escolliu una caducitat (30, 90 o 365 dies, o un període personalitzat de fins a un any) i reviseu-ho. El secret es mostra en finalitzar, una sola vegada. Limiteu l’abast de cada clau al conjunt de permisos més restringit que necessiti qui l’utilitzi, encara que el compte en permeti més. Si una clau es filtra, els seus permisos determinen l’abast de l’impacte.

​
Renovar sense temps d’inactivitat

La rotació emet un secret nou i inicia una finestra de superposició (1 hora, 24 hores o 7 dies) durant la qual el secret antic continua funcionant. Així podeu desplegar el secret nou als vostres entorns al ritme que us convingui:
1

Rotate the key

Trieu una finestra de superposició que cobreixi el camí de desplegament més lent. El nou secret es mostra una sola vegada: deseu-lo immediatament.
2

Update your integrations

Substituïu el secret antic a tots els llocs on estigui configurat. L’estat de la clau apareix com a in-overlap fins que finalitzi la finestra.
3

Verify before the window closes

Feu servir els registres de sol·licituds per confirmar que el trànsit ha passat al secret nou. Quan finalitzi la superposició, el secret antic deixarà d’autenticar.
Renoveu també abans de la caducitat: les claus que s’acosten a la data de caducitat es marquen com a expiring a la llista de claus. Una clau caducada deixa d’autenticar: les sol·licituds fetes amb aquesta clau retornen un 401 amb el codi credential_expired.

​
Revocar immediatament

La revocació té efecte immediat i és permanent: no hi ha finestra de superposició ni es pot desfer. Reviqueu una clau en el moment en què sospiteu que el seu secret s’ha exposat; feu una rotació quan substituïu una credencial que està en bon estat. Les sol·licituds fetes amb una clau revocada retornen un 401 amb el codi credential_revoked. Si heu d’aturar alhora totes les claus que té una integració, inhabiliteu-ne el compte de servei.