Skip to content

API-nycklar

API-nycklar låter dig komma åt badges.ninja REST API programmatiskt. Använd dem för att automatisera skapande, utfärdande och hantering av märken från dina egna program.

API-nycklar — tomt läge

Skapa en API-nyckel

  1. Öppna sidan API-nycklar från sidofältet.
  2. Klicka på Skapa API-nyckel. Ett inbäddat formulär öppnas:

Skapa nyckel — namnformulär

  1. Ge nyckeln ett namn och klicka på Skapa. Den fullständiga nyckeln visas en gång i en grön banner:

Nyligen skapad nyckel visad en gång

  1. Kopiera nyckeln omedelbart — den visas bara en gång. Om du tappar bort den måste du skapa en ny. När du stänger bannern lagras endast prefixet:

Nyckellista som visar maskerat prefix

Nyckelformat

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

bws_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6

Använda API-nycklar i begäranden

Inkludera API-nyckeln i X-Api-Key-headern för varje API-begäran:

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

Se sidan Autentisering för fullständiga detaljer om API-autentisering.

Nyckelgränser per plan

Antalet API-nycklar du kan skapa beror på din plan:

PlanGräns för API-nycklar
Free1
Starter (9 USD/mån)5
Pro (29 USD/mån)20

Ta bort en nyckel

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

Bekräftelse av nyckelborttagning — återkallning sker omedelbart

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

badges.ninja Documentation