Autentisering

Alle API-forespørsler til badges.ninja krever autentisering. Denne siden forklarer hvordan du autentiserer forespørslene dine.

Basis-URL

https://api.badges.ninja

Alle API-endepunkter er relative til denne basis-URL-en.

API-nøkkelautentisering

Den primære autentiseringsmetoden er en API-nøkkel som sendes i X-Api-Key-headeren.

Hente en API-nøkkel

Fra dashbordet:

1. Logg inn på badges.ninja.
2. Gå til API-nøkler i sidefeltet.
3. Klikk på Opprett API-nøkkel.
4. Kopier nøkkelen (den vises kun én gang).

Fra API-et:

API-nøkler kan også administreres via API-et ved hjelp av JWT-tokenet ditt fra Cognito-autentiseringsflyten. Se dashbordet for den enkleste tilnærmingen.

Bruke API-nøkkelen din

Inkluder X-Api-Key-headeren i hver forespørsel:

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

API-nøkkelformat

Nøkler bruker prefikset bws_:

bws_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6

Forespørselsformat

• GET-forespørsler sender parametere som spørrestrenger
• POST- og PUT-forespørsler sender en JSON-body med et parameters-objekt
• Alle svar returnerer JSON med Content-Type: application/json

Struktur for POST/PUT-forespørsel

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

Eksempelforespørsel

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

Eksempelsvar

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

Hastighetsgrenser

API-forespørsler er underlagt hastighetsbegrensning. Hvis du overskrider grensen, mottar du et 429 Too Many Requests-svar. Vent noen sekunder, og prøv igjen.

Offentlige endepunkter

Noen endepunkter krever ikke autentisering. Det er de offentlige verifiserings-endepunktene under /certify-badge/ som lar alle verifisere merkebevis.