API-nøgler

API-nøgler giver dig programmatisk adgang til badges.ninja REST API. Brug dem til at automatisere oprettelse, udstedelse og administration af mærker fra dine egne applikationer.

Opret en API-nøgle

1. Åbn siden API Keys fra sidebjælken.
2. Klik på Create API Key. En indlejret formular åbnes:

3. Giv nøglen et navn, og klik på Create. Den fulde nøgle vises kun én gang på et grønt banner:

4. Kopiér nøglen med det samme — den fulde nøgle vises kun én gang. Mister du den, skal du oprette en ny. Når du lukker banneret, viser dashboardet kun nøglens præfiks (f.eks. bws_a1b2c3d4...); den fulde nøgle forbliver gemt på serversiden, så den kan godkende dine forespørgsler:

Hver række viser også, hvornår nøglen blev oprettet, og når den har været brugt, et tidsstempel for sidst brugt, så du kan finde forældede nøgler.

Adgangsomfang

Når du opretter en nøgle, kan du gøre den skrivebeskyttet eller lade den have fuld adgang:

Omfang	Tillader
Fuld adgang (standard)	Læse og skrive — vise data samt oprette, udstede, opdatere eller slette.
Skrivebeskyttet	Kun sikre GET-forespørgsler. Enhver forespørgsel, der ændrer data (POST, PUT, PATCH, DELETE), afvises med 403 Forbidden.

Brug en skrivebeskyttet nøgle til integrationer, der kun har brug for at læse dine data (rapportering, dashboards, sikkerhedskopier), så en lækket nøgle ikke kan ændre noget. Markér Read-only key i oprettelsesformularen; skrivebeskyttede nøgler har et Read-only-mærke i listen. Nøgler oprettet før omfang blev indført beholder fuld adgang.

Nøgleformat

API-nøgler bruger præfikset bws_ efterfulgt af en hex-streng på 32 tegn:

bws_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6

Brug af API-nøgler i forespørgsler

Inkludér API-nøglen i headeren X-Api-Key i hver API-forespørgsel:

curl -X GET https://api.badges.ninja/issuers \
  -H "X-Api-Key: bws_your_api_key_here"

Se siden Godkendelse for alle detaljer om API-godkendelse.

Nøglegrænser pr. plan

Antallet af API-nøgler, du kan oprette, afhænger af din plan:

Plan	Grænse for API-nøgler
Free	1
Starter ($9/mo)	5
Pro ($29/mo)	20

Nøglens udløb

Hver API-nøgle udløber et år efter oprettelsen. Når en nøgle er udløbet, kan den ikke længere godkende forespørgsler, præcis som hvis den var blevet slettet. Opret en ny nøgle, før den gamle udløber, for at undgå afbrydelser.

Slet en nøgle

1. Åbn siden API Keys.
2. Find den nøgle, du vil slette.
3. Klik på Delete.
4. Bekræft sletningen.

Når nøglen er slettet, holder den straks op med at virke. Alle applikationer, der bruger nøglen, vil få godkendelsesfejl.