Autentificare

Toate cererile API către badges.ninja necesită autentificare. Această pagină explică cum îți autentifici cererile.

URL de bază

https://api.badges.ninja

Toate endpoint-urile API sunt relative la acest URL de bază.

Autentificare cu cheie API

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

Obținerea unei chei API

Din panoul de control:

1. Autentifică-te la badges.ninja.
2. Mergi la API Keys în bara laterală.
3. Fă clic pe Create API Key.
4. Copiază cheia (este afișată o singură dată).

Din API:

Cheile API pot fi gestionate și prin API, folosind tokenul tău JWT din fluxul de autentificare Cognito. Cea mai simplă variantă este panoul de control.

Utilizarea cheii API

Include 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 folosesc prefixul bws_:

bws_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6

Formatul cererii

• Cererile GET transmit parametrii ca șiruri de interogare (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 cererilor 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

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

Endpoint-uri publice

Unele endpoint-uri nu necesită autentificare. Acestea sunt endpoint-urile publice de verificare de sub /certify-badge/, care permit oricui să verifice acreditările insignelor.