Godkendelse

Alle API-forespørgsler til badges.ninja kræver godkendelse. Denne side forklarer, hvordan du godkender dine forespørgsler.

Basis-URL

https://api.badges.ninja

Alle API-endpoints er relative til denne basis-URL.

Godkendelse med API-nøgle

Den primære godkendelsesmetode er en API-nøgle, der sendes i headeren X-Api-Key.

Sådan får du en API-nøgle

Fra dashboardet:

1. Log ind på badges.ninja.
2. Gå til API-nøgler i sidemenuen.
3. Klik på Opret API-nøgle.
4. Kopiér nøglen (den vises kun én gang).

Fra API'et:

API-nøgler kan også administreres via API'et med dit JWT-token fra Cognito-godkendelsesforløbet. Den nemmeste vej er dashboardet.

Brug af din API-nøgle

Medsend headeren X-Api-Key i hver forespørgsel:

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

Format på API-nøglen

Nøgler bruger præfikset bws_:

bws_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6

Forespørgselsformat

• GET-forespørgsler sender parametre som query string
• POST- og PUT-forespørgsler sender en JSON-body med et parameters-objekt
• Alle svar returnerer JSON med Content-Type: application/json

Struktur på POST/PUT-forespørgsler

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

Eksempel på forespørgsel

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

Eksempel på svar

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

Offentlige endpoints

Nogle endpoints kræver ikke godkendelse. Det er de offentlige verificeringsendpoints under /certify-badge/, som giver alle mulighed for at verificere badge-beviser.