Hopp til innholdet
Bekreftet

God praksis for API-nøkler

Full eller egendefinert tilgang, å trekke tilbake og bytte ut en nøkkel, og å finne en som ingen bruker.

En API-nøkkel handler på kontoen din uten at du er til stede: fra hvor som helst, helt til den trekkes tilbake. Autentisering forklarer hvordan en nøkkel opprettes og sendes med et kall. Denne siden handler om å holde orden på nøklene du allerede har.

Gi en nøkkel bare det den trenger

Hver nøkkel har enten Full tilgang eller Egendefinert tilgang. Du velger det når nøkkelen opprettes, og kan endre det senere i samme skjema.

  • Full tilgang gir tilgang til alle metoder kontoen din kan kalle, også metoder som er lagt til etter at nøkkelen ble opprettet. Ingenting som er merket privat blir noen gang inkludert, uansett hvilken tilgangsmodus nøkkelen har.
  • Egendefinert tilgang gir bare tilgang til metodene du uttrykkelig har huket av, gruppert etter mikrotjeneste, med parameterne til hver metode vist ved siden av. En metode som legges til senere, er ikke dekket før du kommer tilbake og huker den av.
Foretrekk egendefinert tilgang for alt som er automatisert

En nøkkel som brukes i et skript, en CI-jobb eller en server, trenger bare de få metodene jobben faktisk kaller. Egendefinert tilgang gjør at en lekket nøkkel ikke kan gjøre mer enn det den ble laget for.

Opprett, vis og kopier

For å opprette en nøkkel må kontoen din være verifisert til nivå 2, se Verifisering. Knappen Opprett nøkkel forklarer dette og lenker deg rett til neste uferdige trinn hvis du ikke er der ennå. Verdien til en nyopprettet nøkkel vises én gang i panelet Hurtigkopi øverst i listen. Etter det er den maskert i hver rad, og radens egen visknapp viser den igjen i 20 sekunder før den maskeres på nytt.

En nøkkel er en hemmelighet, ikke en etikett

Verdien skrives aldri til en logg, en toast eller adressefeltet, bare til utklippstavlen din. Behandle den akkurat som et passord. Alle som har den, kan handle som kontoen din.

Bytt ut, trekk tilbake og finn en som ikke brukes

Det finnes ingen egen rotasjonshandling, fordi verdien til en nøkkel er identifikatoren dens. Bytt ut oppretter en ny nøkkel med samme navn og tilgang, trekker den gamle tilbake og viser den nye verdien én gang, slik at du kan kopiere den før du lukker dialogen. Trekk tilbake fjerner en nøkkel helt, og ber deg først bekrefte med navnet, siden det ikke kan angres.

Hver nøkkels rad viser når den sist ble brukt, basert på aktiviteten de siste 7 dagene. En nøkkel uten en slik linje har ikke gjort noe kall i den perioden. Det er raden som fortjener et ekstra blikk.

Bytt ut en nøkkel som kan ha lekket

Åpne nøkkelen, trykk Bytt ut, og kopier den nye verdien med en gang den vises. Den gamle verdien slutter å virke i det øyeblikket utskiftingen er ferdig.

Trekk tilbake en nøkkel du ikke trenger lenger

Trykk Trekk tilbake på raden og bekreft med navnet. En tilbaketrukket nøkkel forsvinner fra den aktive listen, og det er ingen måte å få den tilbake på.

Se etter en som ingen bruker

Gå gjennom listen etter en rad uten linjen "Sist brukt", særlig blant nøkler med Full tilgang, og trekk den tilbake hvis du ikke kan gjøre rede for den.