Autenticación

Todas las solicitudes a la API de badges.ninja requieren autenticación. Esta página te explica cómo autenticar tus solicitudes.

URL base

https://api.badges.ninja

Todos los endpoints son relativos a esta URL base.

Autenticación con clave de API

El método de autenticación principal es una clave de API enviada en la cabecera X-Api-Key.

Obtener una clave de API

Desde el panel:

1. Inicia sesión en badges.ninja.
2. Ve a API Keys en la barra lateral.
3. Haz clic en Create API Key.
4. Copia la clave (solo se muestra una vez).

Desde la API:

Las claves de API también se pueden gestionar mediante la API usando tu token JWT del flujo de autenticación de Cognito. Para lo más sencillo, usa el panel.

Usar tu clave de API

Incluye la cabecera X-Api-Key en cada solicitud:

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

Formato de la clave de API

Las claves usan el prefijo bws_:

bws_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6

Formato de las solicitudes

• Las solicitudes GET pasan los parámetros como cadena de consulta (query string)
• Las solicitudes POST y PUT envían un cuerpo JSON con un objeto parameters
• Todas las respuestas devuelven JSON con Content-Type: application/json

Estructura de las solicitudes POST/PUT

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

Solicitud de ejemplo

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

Respuesta de ejemplo

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

Endpoints públicos

Algunos endpoints no requieren autenticación. Son los endpoints públicos de verificación bajo /certify-badge/, que permiten a cualquier persona verificar credenciales de insignias.