Autentificare

Toate cererile către API-ul badges.ninja necesită autentificare. Această pagină explică cum să autentifici apelurile.

URL de bază

https://api.badges.ninja

Toate endpoint-urile sunt relative la acest URL.

Autentificare cu cheie API

Metoda principală de autentificare este o cheie API transmisă în antetul X-Api-Key.

Obținerea unei chei API

Din panou:

1. Autentifică-te pe badges.ninja.
2. Accesează Chei API din bara laterală.
3. Apasă Creează cheie API.
4. Copiază cheia (este afișată o singură dată).

Din API:

Cheile API pot fi gestionate și prin API folosind token-ul JWT obținut prin fluxul de autentificare Cognito. Pentru cea mai simplă abordare, folosește panoul.

Utilizarea cheii API

Inserează antetul X-Api-Key în fiecare cerere:

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

Formatul cheii API

Cheile utilizează prefixul bws_:

bws_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6

Formatul cererilor

• Cererile GET transmit parametrii ca query string
• Cererile POST și PUT trimit un corp JSON cu un obiect parameters
• Toate răspunsurile returnează JSON cu Content-Type: application/json

Structura cererii POST/PUT

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

Exemplu de cerere

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

Exemplu de răspuns

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

Limite de frecvență

Cererile API sunt supuse unor limite de frecvență. Dacă depășești limita, vei primi un răspuns 429 Too Many Requests. Așteaptă câteva secunde și reîncearcă.

Endpoint-uri publice

Unele endpoint-uri nu necesită autentificare. Sunt endpoint-urile publice de verificare aflate sub /certify-badge/, care permit oricui să verifice credențialele.