Skip to main content

Endpoint CaseBender

Visualizza il file di specifica OpenAPI

Autenticazione

Tutti gli endpoint dell’API richiedono l’autenticazione tramite chiavi API. Includi la tua chiave API in ogni richiesta utilizzando uno dei seguenti metodi:

Consigliato: token Bearer

Includi la tua chiave API come token Bearer nell’intestazione Authorization:

Alternativa: intestazione X-Api-Key

Puoi anche utilizzare l’intestazione X-Api-Key:
Importante: la tua chiave API concede l’accesso alla tua istanza di CaseBender. Conservala in modo sicuro e non condividerla mai pubblicamente.

Creare chiavi API

Per creare chiavi API:
  1. Accedi alla tua istanza di CaseBender
  2. Vai su AccountChiavi API
  3. Fai clic su Crea chiave API
  4. Configura nome, descrizione, livello (tier) e ambiti (scope) della chiave
  5. Salva subito la chiave: viene mostrata una sola volta e non può essere recuperata in seguito
Quando crei una chiave API, ricevi un’unica chiave simile a questa:

Usare le chiavi API

Includi la chiave API in tutte le richieste:

Con cURL

Con Python (libreria requests)

Con JavaScript/Node.js (fetch)

Livelli delle chiavi API

Alle chiavi API vengono assegnati livelli che determinano i limiti di frequenza:

Ambiti delle chiavi API

Quando crei una chiave API, puoi limitarne l’accesso a operazioni specifiche:
  • alerts:read - Leggere gli avvisi
  • alerts:write - Creare e aggiornare gli avvisi
  • cases:read - Leggere i casi
  • cases:write - Creare e aggiornare i casi
  • observables:read - Leggere gli observable
  • observables:write - Creare e aggiornare gli observable
  • users:read - Leggere le informazioni degli utenti
  • admin:* - Operazioni amministrative

Errori di autenticazione comuni

  • 401 Unauthorized:
    • Intestazione Authorization mancante
    • Chiave API non valida o scaduta
    • La chiave API è stata revocata o sospesa
  • 403 Forbidden:
    • La chiave API non dispone dell’ambito richiesto per l’operazione
    • Restrizioni di accesso TLP/PAP
  • 429 Too Many Requests:
    • Limite di frequenza superato per il tuo livello

Buone pratiche di sicurezza

  • Non condividere mai la tua chiave API: trattala come una password
  • Ruota regolarmente le chiavi API: revoca le chiavi vecchie e creane di nuove periodicamente
  • Usa chiavi diverse per applicazioni diverse: così puoi revocare l’accesso per singola applicazione
  • Imposta date di scadenza: configura le chiavi API affinché scadano automaticamente quando possibile
  • Usa gli ambiti minimi necessari: concedi solo i permessi di cui la tua applicazione ha bisogno

Autenticazione legacy (deprecata)

Le intestazioni legacy x-api-key e x-api-secret sono ancora supportate per retrocompatibilità ma sono deprecate. Migra all’autenticazione con token Bearer.