Autenticazione

Tutte le richieste API a badges.ninja richiedono l'autenticazione. Questa pagina spiega come autenticare le tue richieste.

URL di base

https://api.badges.ninja

Tutti gli endpoint dell'API sono relativi a questo URL di base.

Autenticazione con chiave API

Il metodo di autenticazione principale è una chiave API passata nell'header X-Api-Key.

Ottenere una chiave API

Dalla dashboard:

1. Accedi a badges.ninja.
2. Vai su API Keys nella barra laterale.
3. Fai clic su Create API Key.
4. Copia la chiave (viene mostrata una sola volta).

Dall'API:

Le chiavi API possono essere gestite anche tramite l'API usando il tuo token JWT del flusso di autenticazione Cognito. Per l'approccio più semplice, usa la dashboard.

Usare la tua chiave API

Includi l'header X-Api-Key in ogni richiesta:

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

Formato della chiave API

Le chiavi usano il prefisso bws_:

bws_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6

Formato delle richieste

• Le richieste GET passano i parametri come query string
• Le richieste POST e PUT inviano un corpo JSON con un oggetto parameters
• Tutte le risposte restituiscono JSON con Content-Type: application/json

Struttura delle richieste POST/PUT

{
  "parameters": {
    "name": "My Badge",
    "description": "A sample badge"
  }
}

Esempio di richiesta

curl -X POST https://api.badges.ninja/issuers \
  -H "X-Api-Key: bws_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "parameters": {
      "name": "My Organization",
      "url": "https://example.com",
      "email": "admin@example.com"
    }
  }'

Esempio di risposta

{
  "issuerId": "https://api.badges.ninja/certify-badge/issuer/abc123-def456"
}

Endpoint pubblici

Alcuni endpoint non richiedono l'autenticazione. Sono gli endpoint di verifica pubblici sotto /certify-badge/ che permettono a chiunque di verificare le credenziali dei badge.