Autenticació

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

URL base

https://api.badges.ninja

Tots els endpoints són relatius a aquesta URL base.

Autenticació amb clau API

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

Obtenir una clau API

Des del panell:

Inicia sessió a badges.ninja.
Vés a Claus API des de la barra lateral.
Prem Crear clau API.
Copia la clau (només es mostra una vegada).

Des de l'API:

Les claus API també es poden gestionar via API fent servir el teu token JWT del flux d'autenticació de Cognito. Per a l'opció més senzilla, fes-ho des del panell.

Utilitzar la teva clau API

Inclou la capçalera X-Api-Key a cada sol·licitud:

bash

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

Format de la clau API

Les claus duen el prefix bws_:

bws_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6

Format de les sol·licituds

Les sol·licituds GET passen els paràmetres com a query string
Les sol·licituds POST i PUT envien un cos JSON amb un objecte parameters
Totes les respostes retornen JSON amb Content-Type: application/json

Estructura de sol·licitud POST/PUT

json

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

Sol·licitud d'exemple

bash

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

Resposta d'exemple

json

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

Límits de freqüència

Les sol·licituds estan subjectes a límits de freqüència. Si supereu el límit, rebreu una resposta 429 Too Many Requests. Espereu uns segons i torneu a provar.

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 credencials.

Autenticació ​

URL base ​

Autenticació amb clau API ​

Obtenir una clau API ​

Utilitzar la teva clau API ​

Format de la clau API ​

Format de les sol·licituds ​

Estructura de sol·licitud POST/PUT ​

Sol·licitud d'exemple ​

Resposta d'exemple ​

Límits de freqüència ​

Endpoints públics ​