Skip to content

Claus API

Les claus API permeten accedir a la REST API de badges.ninja de manera programàtica. Utilitza-les per automatitzar la creació, l'atorgament i la gestió de credencials des de les teves aplicacions.

Claus API — estat buit

Crear una clau API

  1. Obre la secció Claus API des de la barra lateral.
  2. Prem Crear clau API. Apareix un formulari en línia:

Crear clau — formulari del nom

  1. Posa un nom a la clau i prem Crear. La clau sencera es mostra una sola vegada en una cinta verda:

Clau acabada de crear mostrada un sol cop

  1. Copia la clau immediatament — només es mostra una vegada. Si la perds, n'hauràs de crear una de nova. Quan tanquis la cinta, només queda desat el prefix:

Llistat de claus amb el prefix emmascarat

Format de la clau

Les claus API porten el prefix bws_ seguit d'una cadena hexadecimal de 32 caràcters:

bws_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6

Utilitzar claus API a les sol·licituds

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

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

Consulta la pàgina Autenticació per als detalls complets d'autenticació de l'API.

Límits de claus per pla

La quantitat de claus API que pots crear depèn del teu pla:

PlaLímit de claus API
Free1
Starter ($9/mes)5
Pro ($29/mes)20

Esborrar una clau

  1. Obre la secció Claus API.
  2. Localitza la clau que vols suprimir.
  3. Prem Esborrar.
  4. Confirma la supressió.

Confirmació d'esborrat de clau — la revocació és immediata

Un cop esborrada, la clau deixa de funcionar a l'instant. Les aplicacions que la facin servir rebran errors d'autenticació.

badges.ninja Documentation