Autentisering

Alla API-anrop till badges.ninja kräver autentisering. Den här sidan förklarar hur du autentiserar dina anrop.

Bas-URL

https://api.badges.ninja

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

Autentisering med API-nyckel

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

Skaffa en API-nyckel

Från instrumentpanelen:

1. Logga in på badges.ninja.
2. Gå till API Keys i sidofältet.
3. Klicka på Create API Key.
4. Kopiera nyckeln (den visas bara en gång).

Via API:et:

API-nycklar kan också hanteras via API:et med din JWT-token från Cognito-autentiseringsflödet. Det enklaste är att använda instrumentpanelen.

Använda din API-nyckel

Inkludera headern X-Api-Key i varje anrop:

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

Format för API-nyckel

Nycklar använder prefixet bws_:

bws_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6

Anropsformat

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

Struktur för POST/PUT-anrop

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

Exempelanrop

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

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

Publika slutpunkter

Vissa slutpunkter kräver ingen autentisering. Det är de publika verifieringsslutpunkterna under /certify-badge/ som gör det möjligt för vem som helst att verifiera märkens credentials.