Kezelési végpontok
Ezek a végpontok lehetővé teszik az API-kulcsok, űrlapszabályok, riasztási szabályok és egyéb beállítások programozott kezelését. Minden kezelési végpont JWT-hitelesítést igényel.
Base URL: https://api.silentshield.io
API-kulcsok
| Method | Path | Description |
|---|---|---|
GET | /api/v1/keys | Fiókja összes API-kulcsának listázása. |
POST | /api/v1/keys | Új API-kulcs létrehozása. |
GET | /api/v1/keys/{id} | Egy adott API-kulcs részleteinek lekérdezése. |
PUT | /api/v1/keys/{id} | API-kulcs beállításainak frissítése. |
DELETE | /api/v1/keys/{id} | API-kulcs törlése. Ez a művelet visszafordíthatatlan. |
POST | /api/v1/keys/{id}/rotate | API-kulcs rotálása. A régi kulcs azonnal érvénytelenné válik. |
Űrlapszabályok
| Method | Path | Description |
|---|---|---|
GET | /v1/form-rules | Egy kulcs aktív űrlapszabályainak olvasása. Ezt az útvonalat maga a widget hívja; ez az API egyetlen űrlapszabály-végpontja. |
GET | /api/v1/keys/{id}/formrules/dryrun | Egy szabály kipróbálása a legutóbb felismert űrlapokon, mentés nélkül. |
Az űrlapszabályokat az irányítópulton kezeljük, nem az API-n keresztül — létrehozás, módosítás és törlés itt szándékosan nincs.
Riasztási szabályok
| Method | Path | Description |
|---|---|---|
GET | /api/v1/keys/{id}/alerts | Egy API-kulcs összes riasztási szabályának listázása. |
POST | /api/v1/keys/{id}/alerts | Új riasztási szabály létrehozása. |
DELETE | /api/v1/keys/{id}/alerts/{alertId} | Riasztási szabály törlése. |