Autenticació

Totes les peticions a l'API de badges.ninja requereixen autenticació. Aquesta pàgina explica com autenticar les teves peticions.

URL base

https://api.badges.ninja

Tots els endpoints de l'API són relatius a aquesta URL base.

Autenticació amb clau d'API

El mètode d'autenticació principal és una clau d'API enviada a la capçalera X-Api-Key.

Obtenir una clau d'API

Des del tauler:

1. Inicia la sessió a badges.ninja.
2. Ves a API Keys a la barra lateral.
3. Fes clic a Create API Key.
4. Copia la clau (només es mostra una vegada).

Des de l'API:

Les claus d'API també es poden gestionar mitjançant l'API amb el teu token JWT del flux d'autenticació de Cognito. Consulta el tauler per a l'opció més senzilla.

Utilitzar la clau d'API

Inclou la capçalera X-Api-Key a cada petició:

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

Format de la clau d'API

Les claus utilitzen el prefix bws_:

bws_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6

Format de les peticions

• Les peticions GET passen els paràmetres com a cadenes de consulta
• Les peticions POST i PUT envien un cos JSON amb un objecte parameters
• Totes les respostes retornen JSON amb Content-Type: application/json

Estructura d'una petició POST/PUT

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

Exemple de petició

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

Exemple de resposta

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

Endpoints públics

Alguns endpoints no requereixen autenticació. Són els endpoints públics de verificació sota /certify-badge/, que permeten a qualsevol persona verificar les credencials d'insígnia.