Authenticatie

Alle API-verzoeken naar badges.ninja vereisen authenticatie. Deze pagina legt uit hoe je je verzoeken authenticeert.

Basis-URL

https://api.badges.ninja

Alle API-endpoints zijn relatief ten opzichte van deze basis-URL.

Authenticatie met API-sleutel

De primaire authenticatiemethode is een API-sleutel die wordt meegestuurd in de X-Api-Key-header.

Een API-sleutel verkrijgen

Via het dashboard:

1. Log in op badges.ninja.
2. Ga naar API Keys in de zijbalk.
3. Klik op Create API Key.
4. Kopieer de sleutel (deze wordt maar één keer getoond).

Via de API:

API-sleutels kunnen ook via de API worden beheerd met je JWT-token uit de Cognito-authenticatiestroom. Het dashboard is de eenvoudigste aanpak.

Je API-sleutel gebruiken

Neem de X-Api-Key-header op in elk verzoek:

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

Formaat van de API-sleutel

Sleutels gebruiken het voorvoegsel bws_:

bws_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6

Verzoekformaat

• GET-verzoeken geven parameters mee als querystrings
• POST- en PUT-verzoeken sturen een JSON-body met een parameters-object
• Alle antwoorden geven JSON terug met Content-Type: application/json

Structuur van POST/PUT-verzoeken

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

Voorbeeldverzoek

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"
    }
  }'

Voorbeeldantwoord

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

Openbare endpoints

Sommige endpoints vereisen geen authenticatie. Dit zijn de openbare verificatie-endpoints onder /certify-badge/ waarmee iedereen badge-referenties kan verifiëren.