Endpoint di gestione

Questi endpoint consentono di gestire API key, regole dei moduli, regole di avviso e altre impostazioni in modo programmatico. Tutti gli endpoint di gestione richiedono l'autenticazione JWT.

Base URL: https://api.silentshield.io

API Keys

MethodPathDescription
GET/api/v1/keysElencare tutte le API key dell'account.
POST/api/v1/keysCreare una nuova API key.
GET/api/v1/keys/{id}Ottenere i dettagli di una API key specifica.
PUT/api/v1/keys/{id}Aggiornare le impostazioni di una API key.
DELETE/api/v1/keys/{id}Eliminare una API key. Questa azione è irreversibile.
POST/api/v1/keys/{id}/rotateRuotare una API key. La key precedente viene immediatamente invalidata.

Regole dei moduli

MethodPathDescription
GET/v1/form-rulesLegge le regole di modulo attive di una chiave. Il widget stesso richiama questa rotta; è l’unico endpoint di regole di modulo dell’API.
GET/api/v1/keys/{id}/formrules/dryrunProva una regola sui moduli rilevati più di recente, senza salvarla.

Le regole di modulo si gestiscono nella dashboard, non tramite API: creazione, modifica ed eliminazione qui non esistono di proposito.

Regole di avviso

MethodPathDescription
GET/api/v1/keys/{id}/alertsElencare tutte le regole di avviso per una API key.
POST/api/v1/keys/{id}/alertsCreare una nuova regola di avviso.
DELETE/api/v1/keys/{id}/alerts/{alertId}Eliminare una regola di avviso.