Endpoints de gestao
Estes endpoints permitem gerir API keys, regras de formulário, regras de alerta e outras definições de forma programática. Todos os endpoints de gestão requerem autenticação JWT.
Base URL: https://api.silentshield.io
API Keys
| Method | Path | Description |
|---|---|---|
GET | /api/v1/keys | Listar todas as API keys da conta. |
POST | /api/v1/keys | Criar uma nova API key. |
GET | /api/v1/keys/{id} | Obter detalhes de uma API key específica. |
PUT | /api/v1/keys/{id} | Atualizar as definições de uma API key. |
DELETE | /api/v1/keys/{id} | Eliminar uma API key. Esta ação é irreversível. |
POST | /api/v1/keys/{id}/rotate | Rodar uma API key. A key anterior é imediatamente invalidada. |
Regras de formulário
| Method | Path | Description |
|---|---|---|
GET | /v1/form-rules | Ler as regras de formulário ativas de uma chave. O próprio widget chama esta rota; é o único endpoint de regras de formulário da API. |
GET | /api/v1/keys/{id}/formrules/dryrun | Experimentar uma regra nos formulários detetados mais recentemente, sem a guardar. |
As regras de formulário são geridas no painel, não pela API — criar, alterar e eliminar não existem aqui de propósito.
Regras de alerta
| Method | Path | Description |
|---|---|---|
GET | /api/v1/keys/{id}/alerts | Listar todas as regras de alerta para uma API key. |
POST | /api/v1/keys/{id}/alerts | Criar uma nova regra de alerta. |
DELETE | /api/v1/keys/{id}/alerts/{alertId} | Eliminar uma regra de alerta. |