API-nøgler

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

Opret en API-nøgle

1. Åbn siden API-nøgler fra sidebjælken.
2. Klik på Opret API-nøgle. En indlejret formular åbnes:

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

4. Kopiér nøglen med det samme — den vises kun én gang. Hvis du mister den, skal du oprette en ny. Efter du har lukket banneret, gemmes kun præfikset:

Adgangsområder

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

Område	Tillader
Fuld adgang (standard)	Læs og skriv — vis data og opret, udsted, opdater eller slet.
Skrivebeskyttet	Kun sikre GET-forespørgsler. Enhver ændrende forespørgsel (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. Sæt flueben ved Skrivebeskyttet nøgle i oprettelsesformularen; skrivebeskyttede nøgler viser et Skrivebeskyttet-mærke i listen. Nøgler oprettet, før områder fandtes, beholder fuld adgang.

Nøgleformat

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

bws_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6

Brug af API-nøgler i forespørgsler

Medtag API-nøglen i X-Api-Key-headeren for 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 fulde 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 USD/md)	5
Pro (29 USD/md)	20

Slet en nøgle

1. Åbn siden API-nøgler.
2. Find nøglen, du vil slette.
3. Klik på Slet.
4. Bekræft sletningen.

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