Skip to main content
API-nøgler autentificerer forespørgsler til /v1 Public API. Hver nøgle tilhører en servicekonto og oprettes fra den pågældende kontos detaljeside i Developer Hub. Brug en API-nøgle med afgrænset omfang til en privat backend-integration, når sikker opbevaring og rotation af en hemmelighed opfylder jeres krav. Der er ikke behov for en OAuth-klient eller udveksling af tokens. Se Autentificering, hvis jeres organisation i stedet kræver kortlivede OAuth-adgangstokens.

​
Nøglens opbygning

  • Identifikator — begynder med ak_. Kan sikkert angives i tickets, logge og konfiguration; den giver ikke i sig selv nogen adgang.
  • Hemmelighed — begynder med lsk_live_. Det er de legitimationsoplysninger, som jeres integration fremviser. Den vises én gang, ved oprettelse eller rotation, og kan ikke hentes senere. Nøglelisten viser kun de sidste fire tegn (for eksempel lsk_live_…xQc4), så I kan matche en række med de legitimationsoplysninger, som en kalder har.
  • Tilladelser — en delmængde af den ejende servicekontos tilladelser, valgt ved oprettelsen. En nøgle kan aldrig gøre mere, end kontoen tillader.
  • Udløb — obligatorisk. Hver nøgle har en udløbsdato.
Gem hemmeligheder i en secret manager, så snart de vises. Commit dem aldrig til versionsstyring, indlejr dem aldrig i kode på klientsiden, og del dem aldrig i chat. Enhver, der er i besiddelse af hemmeligheden, kan handle med nøglens tilladelser.

​
Opret en nøgle

På servicekontoens detaljeside opretter I en nøgle i fire trin: giv den et navn, vælg de tilladelser, som netop denne nøgle har brug for, vælg et udløb — 30, 90 eller 365 dage eller en brugerdefineret periode på op til et år — og gennemgå. Hemmeligheden vises ved afslutningen, én gang. Afgræns hver nøgle til det snævreste sæt tilladelser, som dens kalder har brug for, også selv om kontoen tillader mere. Hvis en nøgle lækkes, afgør dens tilladelser omfanget af skaden.

​
Roter uden nedetid

Rotation udsteder en ny hemmelighed og starter et overlapsvindue — 1 time, 24 timer eller 7 dage — hvor den gamle hemmelighed fortsat fungerer. Det giver jer mulighed for at udrulle den nye hemmelighed i jeres miljøer i jeres eget tempo:
1

Roter nøglen

Vælg et overlapsvindue, der dækker jeres langsomste udrulningsvej. Den nye hemmelighed vises én gang — gem den med det samme.
2

Opdater jeres integrationer

Erstat den gamle hemmelighed overalt, hvor den er konfigureret. Nøglens status vises som i overlap, indtil vinduet udløber.
3

Verificer, før vinduet lukker

Brug forespørgselslogge til at bekræfte, at trafikken er flyttet til den nye hemmelighed. Når overlappet ophører, kan den gamle hemmelighed ikke længere autentificere.
Roter også inden udløb: nøgler, der nærmer sig deres udløbsdato, markeres som udløbende i nøglelisten. En udløbet nøgle kan ikke længere autentificere — forespørgsler med den returnerer 401 med koden credential_expired.

​
Tilbagekald med det samme

Tilbagekaldelse træder i kraft med det samme og er permanent — der er intet overlapsvindue, og den kan ikke fortrydes. Tilbagekald en nøgle i det øjeblik, I har mistanke om, at dens hemmelighed er blevet eksponeret; roter i stedet, når I udskifter en intakt legitimation. Forespørgsler med en tilbagekaldt nøgle returnerer 401 med koden credential_revoked. Hvis I har brug for at stoppe alle de nøgler, en integration har, på én gang, kan I i stedet deaktivere dens servicekonto.