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'emissió i la gestió de credencials des de les teves aplicacions.

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:

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

4. 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:

Àmbits d'accés

Quan crees una clau pots fer-la de només lectura o deixar-la amb accés complet:

Àmbit	Permet
Accés complet (per defecte)	Lectura i escriptura — llistar dades i crear, emetre, actualitzar o esborrar.
Només lectura	Només sol·licituds GET segures. Qualsevol sol·licitud que modifiqui dades (POST, PUT, PATCH, DELETE) es rebutja amb 403 Forbidden.

Fes servir una clau de només lectura per a integracions que només necessiten llegir les teves dades (informes, taulers, còpies de seguretat), de manera que una clau filtrada no pugui canviar res. Marca Clau de només lectura al formulari de creació; les claus de només lectura mostren una etiqueta Només lectura a la llista. Les claus creades abans que existissin els àmbits conserven l'accés complet.

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:

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:

Pla	Límit de claus API
Free	1
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ó.

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