Wszystkie endpointy, których możesz używać z kluczem API – posortowane według obszarów, z metodą, ścieżką, wymaganym zakresem i opisem działania.
Ten przegląd wymienia wszystkie endpointy, które działają z tokenem z klucza API. Wszystkie ścieżki zaczynają się od https://dock.at-harbor.com. Dokładne pola każdego endpointu znajdziesz w opisie OpenAPI pod adresem https://dock.at-harbor.com/openapi.yaml.
Bieżąca wersja robocza: template_key, config, theme_config, custom_css, seo, przypisania obrazów i linki
PATCH /v1/pages/{id}/draft
write:pages
Co najmniej jedno z pól: config (najwyżej 64 KB jako JSON, każdy tekst do 5 000 znaków), theme_config, custom_css (do 50 000 znaków i 65 535 bajtów), seo, template_key, template_asset_bindings
Typy, które możesz tworzyć: text, image, embed, spacer, social_links, form, integration, donation, modal, heading, notice, coupon, contact, opening_hours, tour, file, vcard, countdown i gallery. Blok linków jest stały i nie tworzy się go przez ten endpoint. Typy bloków spoza Twojego planu API odrzuca z kodem 403 block_type_requires_plan. config bloku może mieć najwyżej 128 KB jako JSON, a każdy tekst w nim najwyżej 10 000 znaków; w bloku „Okno informacyjne” pole modal_body_html może mieć do 50 000 znaków i najwyżej 65 535 bajtów.
Utworzenie linku; wymagane: title (1–200) i target_url_template (8–2048)
GET /v1/pages/{id}/links/{linkId}
read:links
Jeden link
PATCH /v1/pages/{id}/links/{linkId}
write:links
Edycja linku
DELETE /v1/pages/{id}/links/{linkId}
write:links
Usunięcie linku
POST /v1/pages/{id}/links/reorder
write:links
Ustalenie kolejności: {"order":[IDs]}
Opcjonalne pola przy tworzeniu i edycji: enabled, geo (reguła krajów z trybem allowlist lub denylist i countries), device (osobne cele dla każdego urządzenia), starts_at i ends_at (harmonogram), protection_tier (ochrona przed botami) oraz age_restriction. Harmonogram oraz reguły krajów i urządzeń są dostępne od planu Creator Pro. Przy zmianie kolejności wystarczy wysłać ID, które mają przejść na początek – wszystkie pozostałe linki idą za nimi w dotychczasowej kolejności. ID, które nie należą do strony, API odrzuca z kodem 422 validation_failed; wymienia je details.missing_link_ids.
Utworzenie formularza; wymagane: name i fields (1–100 pól)
GET /v1/forms/{id}
read:forms
Jeden formularz
PATCH /v1/forms/{id}
write:forms
Edycja formularza
DELETE /v1/forms/{id}
write:forms
Usunięcie formularza
GET /v1/forms/{id}/summary
read:forms
Podsumowanie
GET /v1/forms/{id}/submissions
read:forms
Zgłoszenia, najnowsze najpierw (limit 1–500, domyślnie 100; kolejne strony przez cursor = next_cursor)
GET /v1/forms/{id}/submissions/export
read:forms
Wszystkie zgłoszenia jako plik CSV, najnowsze najpierw, do limitu eksportu planu (od Creator Pro); nagłówek X-Export-Truncated pokazuje, czy eksport został przycięty
Okres wybierasz tak, jak opisano w sekcji Paginacja, za pomocą period albo from i to. Jak daleko wstecz możesz sięgnąć, zależy od planu: 365 dni w Creator Pro i Agency, 730 dni w Enterprise. Starsze okresy są przycinane do tego limitu.
Jeden sekret callbacku (bez sekretu w postaci jawnej)
GET /v1/templates
read:workspaces
Wszystkie szablony
GET /v1/templates/available
read:workspaces
Wbudowane i aktywne szablony workspace z prawidłowymi wartościami template_key; szablony workspace mają klucz ws:<key> i type workspace
GET /v1/templates/{key}
read:workspaces
Jeden szablon
GET /v1/workspaces/me/templates
read:workspaces
Twoje własne szablony workspace
GET /v1/workspaces/me/templates/{id}
read:workspaces
Jeden szablon workspace
POST, PATCH, DELETE /v1/workspaces/me/templates[/{id}]
write:templates
Tworzenie, edycja i usuwanie szablonów workspace; html najwyżej 60 000 bajtów (w przeciwnym razie 422 validation_failed z details.reason maxBytes), do 32 asset_slots
Webhooki, integracje, wysyłanie powiadomień push, zarządzanie domenami, członkowie, płatności i usuwanie stron są dostępne tylko w panelu. Także sekrety callbacków można tworzyć i nimi zarządzać tylko w panelu; ich listę i odczyt (bez sekretu w postaci jawnej) umożliwia read:workspaces. Pełną listę znajdziesz w artykule Zakresy w szczegółach. Dane przychodzące – sprzedaże i Twoje własne dane na żywo – wysyłasz z osobnymi sekretami do endpointów opisanych w artykule Callbacki.
