API-nøkler

API-nøkler gir deg programmatisk tilgang til badges.ninja REST API. Bruk dem til å automatisere opprettelse, utstedelse og administrasjon av merker fra dine egne applikasjoner.

Opprette en API-nøkkel

1. Åpne siden API Keys fra sidemenyen.
2. Klikk Create API Key. Et innebygd skjema åpnes:

3. Gi nøkkelen et navn og klikk Create. Hele nøkkelen vises én gang i et grønt banner:

4. Kopier nøkkelen umiddelbart — hele nøkkelen vises bare én gang. Hvis du mister den, må du opprette en ny. Etter at du har lukket banneret, viser dashbordet bare nøkkelens prefiks (f.eks. bws_a1b2c3d4...); hele nøkkelen forblir lagret på serversiden for å autentisere forespørslene dine:

Hver rad viser også når nøkkelen ble opprettet og, når den har blitt brukt, et last used-tidsstempel slik at du kan oppdage ubrukte nøkler.

Tilgangsomfang

Når du oppretter en nøkkel, kan du gjøre den skrivebeskyttet eller la den ha full tilgang:

Omfang	Tillater
Full tilgang (standard)	Lese og skrive — liste opp data og opprette, utstede, oppdatere eller slette.
Skrivebeskyttet	Kun trygge GET-forespørsler. Alle forespørsler som endrer data (POST, PUT, PATCH, DELETE) avvises med 403 Forbidden.

Bruk en skrivebeskyttet nøkkel for integrasjoner som bare trenger å lese dataene dine (rapportering, dashbord, sikkerhetskopier), slik at en lekket nøkkel ikke kan endre noe. Kryss av for Read-only key i opprettelsesskjemaet; skrivebeskyttede nøkler viser et Read-only-merke i listen. Nøkler opprettet før omfang fantes beholder full tilgang.

Nøkkelformat

API-nøkler bruker prefikset bws_ etterfulgt av en heksadesimal streng på 32 tegn:

bws_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6

Bruke API-nøkler i forespørsler

Ta med API-nøkkelen i X-Api-Key-headeren i hver API-forespørsel:

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

Se siden Autentisering for fullstendige detaljer om API-autentisering.

Nøkkelgrenser per plan

Hvor mange API-nøkler du kan opprette, avhenger av planen din:

Plan	Grense for API-nøkler
Free	1
Starter ($9/mo)	5
Pro ($29/mo)	20

Utløp av nøkler

Hver API-nøkkel utløper ett år etter at den ble opprettet. Når en nøkkel utløper, slutter den å autentisere forespørsler, akkurat som om den var slettet. Opprett en ny nøkkel før den gamle utløper for å unngå avbrudd.

Slette en nøkkel

1. Åpne siden API Keys.
2. Finn nøkkelen du vil slette.
3. Klikk Delete.
4. Bekreft slettingen.

Når nøkkelen er slettet, slutter den umiddelbart å fungere. Alle applikasjoner som bruker nøkkelen, får autentiseringsfeil.