Skip to content

Claves API

Las claves API te permiten acceder a la REST API de badges.ninja de forma programática. Úsalas para automatizar la creación, el otorgamiento y la gestión de insignias desde tus propias aplicaciones.

Claves API — estado vacío

Crear una clave API

  1. Abre la página Claves API desde la barra lateral.
  2. Haz clic en Crear clave API. Se abre un formulario en línea:

Crear clave — formulario de nombre

  1. Dale un nombre a la clave y haz clic en Crear. La clave completa se muestra una sola vez en un banner verde:

Clave recién creada mostrada una sola vez

  1. Copia la clave inmediatamente — la clave completa solo se muestra una vez. Si la pierdes, tendrás que crear una nueva. Tras cerrar el banner, el panel solo muestra el prefijo de la clave (p. ej. bws_a1b2c3d4...); la clave completa permanece almacenada en el servidor para autenticar tus solicitudes:

Lista de claves mostrando el prefijo enmascarado

Cada fila también muestra cuándo se creó la clave y, una vez que se ha usado, una marca de tiempo de último uso para que puedas detectar claves obsoletas.

Formato de la clave

Las claves API usan el prefijo bws_ seguido de una cadena hex de 32 caracteres:

bws_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6

Usar claves API en solicitudes

Incluye la clave API en la cabecera X-Api-Key de cada solicitud:

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

Consulta la página de Autenticación para todos los detalles sobre la autenticación en la API.

Límites de claves por plan

El número de claves API que puedes crear depende de tu plan:

PlanLímite de claves API
Free1
Starter (9 $/mes)5
Pro (29 $/mes)20

Caducidad de la clave

Cada clave API caduca un año después de su creación. Una vez que una clave caduca, deja de autenticar solicitudes, exactamente como si se hubiera eliminado. Crea una clave nueva antes de que la anterior caduque para evitar interrupciones.

Eliminar una clave

  1. Abre la página Claves API.
  2. Busca la clave que quieres eliminar.
  3. Haz clic en Eliminar.
  4. Confirma la eliminación.

Confirmación de eliminación de clave — la revocación es inmediata

Una vez eliminada, la clave deja de funcionar inmediatamente. Cualquier aplicación que la use recibirá errores de autenticación.

badges.ninja Documentation