Autentisering

Alla API-begäranden till badges.ninja kräver autentisering. Denna sida förklarar hur du autentiserar dina begäranden.

Bas-URL

https://api.badges.ninja

Alla API-ändpunkter är relativa till denna bas-URL.

API-nyckelautentisering

Den primära autentiseringsmetoden är en API-nyckel som skickas i X-Api-Key-headern.

Hämta en API-nyckel

Från instrumentpanelen:

1. Logga in på badges.ninja.
2. Gå till API-nycklar i sidofältet.
3. Klicka på Skapa API-nyckel.
4. Kopiera nyckeln (den visas endast en gång).

Från API:et:

API-nycklar kan också hanteras via API:et med hjälp av din JWT-token från Cognito-autentiseringsflödet. Se instrumentpanelen för det enklaste tillvägagångssättet.

Använda din API-nyckel

Inkludera X-Api-Key-headern i varje begäran:

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

API-nyckelformat

Nycklar använder prefixet bws_:

bws_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6

Begäranformat

• GET-begäranden skickar parametrar som frågesträngar
• POST- och PUT-begäranden skickar en JSON-body med ett parameters-objekt
• Alla svar returnerar JSON med Content-Type: application/json

Struktur för POST/PUT-begäran

{
  "parameters": {
    "name": "My Badge",
    "description": "A sample badge"
  }
}

Exempelbegäran

curl -X POST https://api.badges.ninja/issuers \
  -H "X-Api-Key: bws_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "parameters": {
      "name": "My Organization",
      "url": "https://example.com",
      "email": "admin@example.com"
    }
  }'

Exempelsvar

{
  "statusCode": 200,
  "info": {
    "issuerId": "https://api.badges.ninja/certify-badge/issuer/abc123-def456"
  }
}

Hastighetsgränser

API-begäranden omfattas av hastighetsbegränsning. Om du överskrider gränsen får du ett 429 Too Many Requests-svar. Vänta några sekunder och försök igen.

Offentliga ändpunkter

Vissa ändpunkter kräver inte autentisering. Det är de offentliga verifieringsändpunkterna under /certify-badge/ som låter vem som helst verifiera märkesmeriter.