API-nøkler

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

Opprette en API-nøkkel

1. Åpne siden API-nøkler fra sidefeltet.
2. Klikk på Opprett API-nøkkel. Et innebygd skjema åpnes:

3. Gi nøkkelen et navn, og klikk på Opprett. Den komplette nøkkelen vises én gang i et grønt banner:

4. Kopier nøkkelen umiddelbart — den vises bare én gang. Hvis du mister den, må du opprette en ny. Etter at du har lukket banneret, lagres kun prefikset:

Tilgangsområder

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

Område	Tillater
Full tilgang (standard)	Les og skriv — list opp data og opprett, utsted, oppdater eller slett.
Skrivebeskyttet	Kun trygge GET-forespørsler. Enhver endrende forespørsel (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 Skrivebeskyttet nøkkel i opprettingsskjemaet; skrivebeskyttede nøkler viser et Skrivebeskyttet-merke i listen. Nøkler som ble opprettet før områder fantes, beholder full tilgang.

Nøkkelformat

API-nøkler bruker prefikset bws_ etterfulgt av en 32-tegns hex-streng:

bws_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6

Bruke API-nøkler i forespørsler

Inkluder API-nøkkelen i X-Api-Key-headeren for 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

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

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

Slette en nøkkel

1. Åpne siden API-nøkler.
2. Finn nøkkelen du vil slette.
3. Klikk på Slett.
4. Bekreft slettingen.

Når nøkkelen er slettet, slutter den å virke umiddelbart. Eventuelle applikasjoner som bruker nøkkelen, vil få autentiseringsfeil.