API-nycklar

Med API-nycklar kan du komma åt REST-API:et i badges.ninja programmatiskt. Använd dem för att automatisera skapande, utfärdande och hantering av märken från dina egna applikationer.

Skapa en API-nyckel

1. Öppna sidan API Keys i sidomenyn.
2. Klicka på Create API Key. Ett infogat formulär öppnas:

3. Ge nyckeln ett namn och klicka på Create. Hela nyckeln visas en enda gång i en grön banner:

4. Kopiera nyckeln direkt — hela nyckeln visas bara en gång. Om du tappar bort den måste du skapa en ny. När du stänger bannern visar instrumentpanelen bara nyckelns prefix (t.ex. bws_a1b2c3d4...); hela nyckeln lagras kvar på serversidan för att autentisera dina förfrågningar:

Varje rad visar också när nyckeln skapades och, när den har använts, en tidsstämpel för last used så att du kan upptäcka oanvända nycklar.

Åtkomstomfång

När du skapar en nyckel kan du göra den skrivskyddad eller låta den ha full åtkomst:

Omfång	Tillåter
Full åtkomst (standard)	Läsa och skriva — lista data samt skapa, utfärda, uppdatera eller ta bort.
Skrivskyddad	Endast säkra GET-förfrågningar. Alla förfrågningar som ändrar data (POST, PUT, PATCH, DELETE) avvisas med 403 Forbidden.

Använd en skrivskyddad nyckel för integrationer som bara behöver läsa dina data (rapportering, instrumentpaneler, säkerhetskopior) så att en läckt nyckel inte kan ändra något. Bocka i Read-only key i skapandeformuläret; skrivskyddade nycklar har märket Read-only i listan. Nycklar som skapades innan omfång fanns behåller full åtkomst.

Nyckelformat

API-nycklar använder prefixet bws_ följt av en hexadecimal sträng på 32 tecken:

bws_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6

Använda API-nycklar i förfrågningar

Ange API-nyckeln i headern X-Api-Key i varje API-förfrågan:

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

På sidan Autentisering hittar du alla detaljer om API-autentisering.

Nyckelgränser per plan

Hur många API-nycklar du kan skapa beror på din plan:

Plan	Gräns för API-nycklar
Free	1
Starter ($9/mo)	5
Pro ($29/mo)	20

Nyckelns giltighetstid

Varje API-nyckel upphör att gälla ett år efter att den skapats. När en nyckel har gått ut autentiserar den inte längre förfrågningar, precis som om den hade tagits bort. Skapa en ny nyckel innan den gamla löper ut för att undvika avbrott.

Ta bort en nyckel

1. Öppna sidan API Keys.
2. Hitta nyckeln du vill ta bort.
3. Klicka på Delete.
4. Bekräfta borttagningen.

När nyckeln har tagits bort slutar den fungera omedelbart. Alla applikationer som använder nyckeln får autentiseringsfel.