dokumentacja · dla deweloperów
REST API
Wszystko, co panel może zrobić ze stroną, przez HTTPS. 71 tras pod /v1, uwierzytelnianych tokenami workspace’u, opisanych dokumentem OpenAPI 3.1.
Uwierzytelnianie i zakresy
curl https://api.cookiecrumbs.eu/v1/sites \
-H "Authorization: Bearer cc_…"Twórz tokeny w Ustawienia workspace’u → Deweloperzy (sekret jest pokazywany raz) lub przez cookiecrumbs tokens create. Każda trasa deklaruje potrzebny zakres: sites:read, sites:write, banner:read, banner:write, banner:publish, scans:read, scans:run, logs:read, logs:export, analytics:read. Tokeny można przypiąć do jednej strony lub środowiska i ustawić im datę wygaśnięcia.
Powierzchnia
| Grupa | Co obejmuje |
|---|---|
| sites | Listowanie, tworzenie, odczyt i aktualizacja stron (PATCH /sites/:id: nazwa, retencja, ustawienia), ich domeny i weryfikacja domen. |
| config | Odczyt i zapis szkicu (GET/PUT /sites/:id/config/draft), walidacja po stronie serwera (POST …/config/validate). |
| versions | Publikacja (POST /sites/:id/versions), listowanie, cofanie, promocja podglądu na produkcję. |
| scans | Kolejkowanie i odczyt skanów, znaleziska jako JSON, CSV lub SARIF (GET /scans/:id/findings?format=…), diff względem poprzedniego uruchomienia, harmonogram skanów (GET/PATCH /sites/:id/scan-schedule) i testy instalacji (GET/POST /sites/:id/install-checks). |
| services | Zarejestrowane trackery: listowanie, tworzenie, aktualizacja, usuwanie; problemy zgodności i ich wyciszanie (POST /issues/:id/suppress). |
| declaration | Publiczna lista cookies jako .json, .html lub .md, per język. |
| consents | Odczyt rekordów zgód; identyfikatory podmiotów są maskowane bez logs:export. |
| exports | Tworzenie i pobieranie podpisanych eksportów dowodów. Pobrania mają X-Content-SHA256, X-Signature-Ed25519 i X-Signing-Kid, więc każdy może zweryfikować plik względem opublikowanych kluczy. |
| alerts · webhooks · templates · tokens | Skrzynka alertów i kanały alertów, endpointy i dostarczenia webhooków, szablony banerów (listowanie, odczyt, zapis, aktualizacja, usuwanie, stosowanie), zarządzanie tokenami. |
| me · r | GET /v1/me opisuje token; GET /v1/r rozstrzyga kraj odwiedzającego na reżim (używane przez runtime). |
Endpointy rozliczeń istnieją, ale przyjmują tylko zalogowanego użytkownika, nigdy tokenu cc_*.
Limity i błędy
600 żądań na minutę na token. Błędy to problem+json wg RFC 9457 ze stabilnym type, więc dopasowuj po nim, nie po treści komunikatu.
Dokument OpenAPI
GET https://api.cookiecrumbs.eu/v1/openapi.json to kontrakt czytelny maszynowo, nadający się do generowania klientów. Strona Deweloperzy w panelu linkuje wyrenderowaną kopię.