Skip to content

Claves API

Las claves API te dan acceso programático a la REST API de badges.ninja. Úsalas para automatizar la creación, la emisión y la gestión de credenciales desde tus propias aplicaciones.

API Keys — estado vacío

Crear una clave API

  1. Abre la sección API Keys desde la barra lateral.
  2. Pulsa Create API Key. Se despliega un formulario en línea:

Crear clave — formulario de nombre

  1. Dale un nombre a la clave y pulsa Create. La clave íntegra aparece una sola vez en un banner verde:

Clave recién creada revelada una vez

  1. Copia la clave de inmediato — solo se muestra una vez. Si la pierdes, tendrás que crear otra. Al cerrar el banner, solo queda guardado el prefijo:

Listado de claves con el prefijo enmascarado

Ámbitos de acceso

Cuando creas una clave puedes hacerla de solo lectura o dejarla con acceso completo:

ÁmbitoPermite
Acceso completo (por defecto)Lectura y escritura — listar datos y crear, emitir, actualizar o eliminar.
Solo lecturaSolo solicitudes GET seguras. Cualquier solicitud que modifique datos (POST, PUT, PATCH, DELETE) se rechaza con 403 Forbidden.

Usa una clave de solo lectura para integraciones que solo necesitan leer tus datos (informes, paneles, copias de seguridad), de modo que una clave filtrada no pueda cambiar nada. Marca Clave de solo lectura en el formulario de creación; las claves de solo lectura muestran una etiqueta Solo lectura en la lista. Las claves creadas antes de que existieran los ámbitos conservan el acceso completo.

Formato de la clave

Las claves API llevan el prefijo bws_ seguido de una cadena hexadecimal de 32 caracteres:

bws_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6

Usar claves API en tus 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 Autenticación para conocer los detalles completos de autenticación en la API.

Límites de claves por plan

La cantidad de claves API que puedes crear varía según tu plan:

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

Eliminar una clave

  1. Abre la sección API Keys.
  2. Localiza la clave que deseas suprimir.
  3. Pulsa Delete.
  4. Confirma la eliminación.

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

Tras eliminarla, la clave deja de funcionar al instante. Las aplicaciones que la usen recibirán errores de autenticación.

badges.ninja Documentation