Hallintapäätepisteet
Näillä päätepisteillä voit hallita API-avaimia, lomakesääntöjä, hälytyssääntöjä ja muita asetuksia ohjelmallisesti. Kaikki hallintapäätepisteet vaativat JWT-todennuksen.
Base URL: https://api.silentshield.io
API-avaimet
| Method | Path | Description |
|---|---|---|
GET | /api/v1/keys | Listaa kaikki tilisi API-avaimet. |
POST | /api/v1/keys | Luo uusi API-avain. |
GET | /api/v1/keys/{id} | Hae tietyn API-avaimen tiedot. |
PUT | /api/v1/keys/{id} | Päivitä API-avaimen asetukset. |
DELETE | /api/v1/keys/{id} | Poista API-avain. Tämä toiminto on peruuttamaton. |
POST | /api/v1/keys/{id}/rotate | Kierrä API-avain. Vanha avain mitätöidään välittömästi. |
Lomakesäännöt
| Method | Path | Description |
|---|---|---|
GET | /v1/form-rules | Lue avaimen aktiiviset lomakesäännöt. Vimpain kutsuu tätä reittiä itse; se on API:n ainoa lomakesääntöjen päätepiste. |
GET | /api/v1/keys/{id}/formrules/dryrun | Aja sääntö viimeksi tunnistettuja lomakkeita vasten tallentamatta sitä. |
Lomakesäännöt ylläpidetään hallintanäkymässä, ei API:n kautta — luonti, muokkaus ja poisto puuttuvat täältä tarkoituksella.
Hälytyssäännöt
| Method | Path | Description |
|---|---|---|
GET | /api/v1/keys/{id}/alerts | Listaa kaikki API-avaimen hälytyssäännöt. |
POST | /api/v1/keys/{id}/alerts | Luo uusi hälytyssääntö. |
DELETE | /api/v1/keys/{id}/alerts/{alertId} | Poista hälytyssääntö. |