Opret en API-nøgle
Trin-for-trin guide til at oprette, bruge og rotere en API-nøgle
En API-nøgle er en langlivet hemmelighed, som din integration sender med hver forespørgsel. Den passer bedst til server-til-server-integrationer.
Før du går i gang
- Du skal være firmaadministrator – fanen API-nøgler ("API Keys") er kun synlig for administratorer.
- Find ud af, hvilke scopes (tilladelser) integrationen har brug for, så du kan vælge det snævrest mulige sæt.
Sådan opretter du nøglen
- Gå til venstremenuen > Integrationer, og åbn fanen API-nøgler.
- Klik på Opret API-nøgle ("Create API Key").
- Indtast et navn til nøglen, og udfyld eventuelt en beskrivelse og en udløbsdato. Lader du udløbsdatoen stå tom, udløber nøglen aldrig.
- Vælg de scopes, integrationen har brug for – altid det snævrest mulige sæt. Du kan desuden begrænse nøglen til bestemte IP-adresser.
- Gem, og kopiér nøgleværdien fra bekræftelsen med det samme – den vises ikke igen.
Nøglen vises nu i listen som Aktiv med sine scopes, oprettelsesdato, senest brugt-dato og antal kald.
Sådan bruger integrationen nøglen
- Send nøgleværdien i request-headeren
x-api-key. Sender du den i stedet som Bearer-token, afvises kaldet med 401 – Bearer-headeren er reserveret til OAuth-tokens. - Nøglen kan også sendes som query-parameter, men det frarådes i dokumentationen.
- En nøgle kan slå sig selv op (scopes, IP-liste, udløb og rate-niveauer) via et selvopslags-endpoint, der autentificeres med nøglen selv.
Rotation, deaktivering og sletning
- Rotation genererer en ny nøgleværdi. Den gamle værdi bliver ved med at virke i 10 minutter, så du kan nå at opdatere dine applikationer – derefter deaktiveres den. Brugerfladen advarer udtrykkeligt om dette.
- Deaktivering, sletning og tilbagekaldelse træder i kraft med det samme.
- Har nøglen en IP-whitelist, får forespørgsler fra andre IP-adresser 401 med årsagen "ip_whitelist_mismatch".
- Visse scopes kan aldrig tildeles en API-nøgle manuelt: MCP-læse/skrive-scopes udstedes kun gennem et brugergodkendt agent-login, og partner-provisioneringsscopes til Portal SSO udstedes kun gennem det dedikerede Portal SSO-indstillingsflow. Ældre leverandør-scopes på gamle nøgler er fortsat gyldige, men nye nøgler får de aktuelle leverandør-scopes.