Claus d'API

Les claus d'API et permeten accedir a l'API REST de badges.ninja de manera programàtica. Fes-les servir per automatitzar la creació, l'emissió i la gestió d'insígnies des de les teves pròpies aplicacions.

Crear una clau d'API

1. Obre la pàgina API Keys des de la barra lateral.
2. Prem Create API Key. S'obre un formulari en línia:

3. Posa un nom a la clau i prem Create. La clau completa es mostra una sola vegada en un bàner verd:

4. Copia la clau immediatament — la clau completa només es mostra una vegada. Si la perds, n'hauràs de crear una de nova. Quan tanquis el bàner, el tauler només mostrarà el prefix de la clau (p. ex. bws_a1b2c3d4...); la clau completa continua emmagatzemada al servidor per autenticar les teves peticions:

Cada fila també mostra quan es va crear la clau i, un cop s'ha fet servir, una marca de temps last used perquè puguis detectar claus sense ús.

Àmbits d'accés

En crear 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 — consultar dades i crear, emetre, actualitzar o eliminar.
Només lectura	Només peticions GET segures. Qualsevol petició que modifiqui dades (POST, PUT, PATCH, DELETE) es rebutja amb 403 Forbidden.

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

Format de la clau

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

bws_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6

Utilitzar les claus d'API en les peticions

Inclou la clau d'API a la capçalera X-Api-Key de cada petició a l'API:

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

Consulta la pàgina d'Autenticació per a tots els detalls sobre l'autenticació de l'API.

Límits de claus per pla

El nombre de claus d'API que pots crear depèn del teu pla:

Pla	Límit de claus d'API
Free	1
Starter ($9/mo)	5
Pro ($29/mo)	20

Caducitat de les claus

Cada clau d'API caduca un any després de crear-se. Quan una clau caduca deixa d'autenticar peticions, exactament com si s'hagués eliminat. Crea una clau nova abans que l'antiga caduqui per evitar interrupcions.

Eliminar una clau

1. Obre la pàgina API Keys.
2. Cerca la clau que vols eliminar.
3. Prem Delete.
4. Confirma l'eliminació.

Un cop eliminada, la clau deixa de funcionar a l'instant. Qualsevol aplicació que la faci servir rebrà errors d'autenticació.