Chiavi API

Le chiavi API consentono l'accesso programmatico alla REST API di badges.ninja. Utilizzale per automatizzare creazione, rilascio e gestione delle credenziali dalle tue applicazioni.

Creare una chiave API

1. Apri la sezione Chiavi API dalla barra laterale.
2. Premi Crea chiave API. Compare un modulo integrato:

3. Assegna un nome alla chiave e premi Crea. La chiave completa viene rivelata una sola volta su un banner verde:

4. Copia la chiave immediatamente — viene mostrata un'unica volta. Se la perdi, dovrai crearne un'altra. Chiudendo il banner resta memorizzato soltanto il prefisso:

Scope di accesso

Quando crei una chiave puoi renderla in sola lettura o lasciarla ad accesso completo:

Scope	Consente
Accesso completo (predefinito)	Lettura e scrittura — elencare dati e creare, rilasciare, aggiornare o eliminare.
Sola lettura	Solo richieste GET sicure. Qualsiasi richiesta di modifica (POST, PUT, PATCH, DELETE) viene rifiutata con 403 Forbidden.

Usa una chiave in sola lettura per le integrazioni che devono solo leggere i tuoi dati (report, dashboard, backup), così che una chiave trapelata non possa modificare nulla. Spunta Chiave in sola lettura nel modulo di creazione; le chiavi in sola lettura mostrano un badge Read-only nell'elenco. Le chiavi create prima dell'esistenza degli scope mantengono l'accesso completo.

Formato della chiave

Le chiavi API utilizzano il prefisso bws_ seguito da una stringa esadecimale di 32 caratteri:

bws_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6

Uso delle chiavi nelle richieste

Inserisci la chiave API nell'intestazione X-Api-Key di ogni richiesta:

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

Consulta la pagina Autenticazione per i dettagli completi sull'autenticazione API.

Limiti di chiavi per piano

Il numero di chiavi API che puoi creare dipende dal tuo piano:

Piano	Limite chiavi API
Free	1
Starter ($9/mese)	5
Pro ($29/mese)	20

Eliminare una chiave

1. Apri la sezione Chiavi API.
2. Individua la chiave da rimuovere.
3. Premi Elimina.
4. Conferma la rimozione.

Una volta eliminata, la chiave smette istantaneamente di funzionare. Le applicazioni che la usano riceveranno errori di autenticazione.