Koncové body správy
Tieto koncové body umožňujú programovú správu API kľúčov, pravidiel formulárov, pravidiel upozornení a ďalších nastavení. Všetky koncové body správy vyžadujú overovanie JWT.
Base URL: https://api.silentshield.io
API kľúče
| Method | Path | Description |
|---|---|---|
GET | /api/v1/keys | Zobraziť zoznam všetkých API kľúčov vášho účtu. |
POST | /api/v1/keys | Vytvoriť nový API kľúč. |
GET | /api/v1/keys/{id} | Získať podrobnosti konkrétneho API kľúča. |
PUT | /api/v1/keys/{id} | Aktualizovať nastavenia API kľúča. |
DELETE | /api/v1/keys/{id} | Zmazať API kľúč. Táto akcia je nevratná. |
POST | /api/v1/keys/{id}/rotate | Rotovať API kľúč. Starý kľúč je okamžite zneplatnený. |
Pravidlá formulárov
| Method | Path | Description |
|---|---|---|
GET | /v1/form-rules | Načítanie aktívnych pravidiel formulárov pre kľúč. Túto trasu volá samotný widget; je to jediný koncový bod pre pravidlá formulárov. |
GET | /api/v1/keys/{id}/formrules/dryrun | Vyskúšanie pravidla proti naposledy rozpoznaným formulárom bez uloženia. |
Pravidlá formulárov sa spravujú v prehľade, nie cez API — vytváranie, úprava a mazanie tu zámerne nie sú.
Pravidlá upozornení
| Method | Path | Description |
|---|---|---|
GET | /api/v1/keys/{id}/alerts | Zobraziť zoznam všetkých pravidiel upozornení pre API kľúč. |
POST | /api/v1/keys/{id}/alerts | Vytvoriť nové pravidlo upozornenia. |
DELETE | /api/v1/keys/{id}/alerts/{alertId} | Zmazať pravidlo upozornenia. |