Punkty końcowe zarządzania

Te punkty końcowe umożliwiają programowe zarządzanie kluczami API, regułami formularzy, regułami alertów i innymi ustawieniami. Wszystkie punkty końcowe zarządzania wymagają uwierzytelniania JWT.

Base URL: https://api.silentshield.io

Klucze API

MethodPathDescription
GET/api/v1/keysWyświetl listę wszystkich kluczy API dla Twojego konta.
POST/api/v1/keysUtwórz nowy klucz API.
GET/api/v1/keys/{id}Pobierz szczegóły konkretnego klucza API.
PUT/api/v1/keys/{id}Zaktualizuj ustawienia klucza API.
DELETE/api/v1/keys/{id}Usuń klucz API. Ta operacja jest nieodwracalna.
POST/api/v1/keys/{id}/rotateRotuj klucz API. Stary klucz zostaje natychmiast unieważniony.

Reguły formularzy

MethodPathDescription
GET/v1/form-rulesOdczyt aktywnych reguł formularzy dla klucza. Tę trasę wywołuje sam widget; to jedyny punkt końcowy reguł formularzy.
GET/api/v1/keys/{id}/formrules/dryrunWypróbowanie reguły na ostatnio wykrytych formularzach, bez zapisu.

Reguły formularzy są zarządzane w panelu, nie przez API — tworzenia, zmiany i usuwania celowo tu nie ma.

Reguły alertów

MethodPathDescription
GET/api/v1/keys/{id}/alertsWyświetl listę wszystkich reguł alertów dla klucza API.
POST/api/v1/keys/{id}/alertsUtwórz nową regułę alertu.
DELETE/api/v1/keys/{id}/alerts/{alertId}Usuń regułę alertu.