Koncové body správy
Tyto koncové body umožňují programovou správu API klíčů, pravidel formulářů, pravidel upozornění a dalších nastavení. Všechny koncové body správy vyžadují ověřování JWT.
Base URL: https://api.silentshield.io
API klíče
| Method | Path | Description |
|---|---|---|
GET | /api/v1/keys | Zobrazit seznam všech API klíčů vašeho účtu. |
POST | /api/v1/keys | Vytvořit nový API klíč. |
GET | /api/v1/keys/{id} | Získat podrobnosti konkrétního API klíče. |
PUT | /api/v1/keys/{id} | Aktualizovat nastavení API klíče. |
DELETE | /api/v1/keys/{id} | Smazat API klíč. Tato akce je nevratná. |
POST | /api/v1/keys/{id}/rotate | Rotovat API klíč. Starý klíč je okamžitě zneplatněn. |
Pravidla formulářů
| Method | Path | Description |
|---|---|---|
GET | /v1/form-rules | Načtení aktivních pravidel formulářů pro klíč. Tuto trasu volá sám widget; je to jediný koncový bod pro pravidla formulářů. |
GET | /api/v1/keys/{id}/formrules/dryrun | Vyzkoušení pravidla proti naposledy rozpoznaným formulářům bez uložení. |
Pravidla formulářů se spravují v přehledu, ne přes API — vytváření, úpravy a mazání zde záměrně nejsou.
Pravidla upozornění
| Method | Path | Description |
|---|---|---|
GET | /api/v1/keys/{id}/alerts | Zobrazit seznam všech pravidel upozornění pro API klíč. |
POST | /api/v1/keys/{id}/alerts | Vytvořit nové pravidlo upozornění. |
DELETE | /api/v1/keys/{id}/alerts/{alertId} | Smazat pravidlo upozornění. |