Все эндпоинты, доступные с API-ключом, — по разделам, с методом, путём, нужной областью доступа и описанием того, что они делают.
В этом обзоре перечислены все эндпоинты, которые работают с токеном от API-ключа. Все пути начинаются с https://dock.at-harbor.com. Точные поля каждого эндпоинта описаны в OpenAPI-описании по адресу https://dock.at-harbor.com/openapi.yaml.
Текущий черновик: template_key, config, theme_config, custom_css, seo, привязки изображений и ссылки
PATCH /v1/pages/{id}/draft
write:pages
Хотя бы одно из: config (не больше 64 КБ в виде JSON, каждый текст до 5000 символов), theme_config, custom_css (до 50 000 символов и 65 535 байт), seo, template_key, template_asset_bindings
Типы, которые можно создавать: text, image, embed, spacer, social_links, form, integration, donation, modal, heading, notice, coupon, contact, opening_hours, tour, file, vcard, countdown и gallery. Блок ссылок фиксированный и через этот эндпоинт не создаётся. Типы блоков, не входящие в ваш тариф, API отклоняет с 403 block_type_requires_plan. config блока может занимать не больше 128 КБ в виде JSON, а каждый текст в нём — не больше 10 000 символов; в информационном модальном окне modal_body_html может содержать до 50 000 символов и не больше 65 535 байт.
Создать ссылку; обязательно: title (1–200) и target_url_template (8–2048)
GET /v1/pages/{id}/links/{linkId}
read:links
Одна ссылка
PATCH /v1/pages/{id}/links/{linkId}
write:links
Изменить ссылку
DELETE /v1/pages/{id}/links/{linkId}
write:links
Удалить ссылку
POST /v1/pages/{id}/links/reorder
write:links
Задать порядок: {"order":[IDs]}
Необязательные поля при создании и редактировании: enabled, geo (правило по странам с mode allowlist или denylist и countries), device (отдельные цели для разных устройств), starts_at и ends_at (расписание), protection_tier (защита от ботов) и age_restriction. Расписание, правила по странам и устройствам доступны начиная с Creator Pro. При сортировке достаточно отправить ID, которые должны переместиться в начало, — все остальные ссылки следуют за ними в прежнем порядке. ID, которые не принадлежат странице, API отклоняет с 422 validation_failed; они перечислены в details.missing_link_ids.
Создать форму; обязательно: name и fields (1–100 полей)
GET /v1/forms/{id}
read:forms
Одна форма
PATCH /v1/forms/{id}
write:forms
Изменить форму
DELETE /v1/forms/{id}
write:forms
Удалить форму
GET /v1/forms/{id}/summary
read:forms
Сводка
GET /v1/forms/{id}/submissions
read:forms
Заявки, сначала новые (limit 1–500, по умолчанию 100; следующие страницы через cursor = next_cursor)
GET /v1/forms/{id}/submissions/export
read:forms
Все заявки в CSV-файле, сначала новые, в пределах лимита экспорта по тарифу (начиная с Creator Pro); заголовок X-Export-Truncated показывает, был ли файл обрезан
Период задаётся так, как описано в разделе Пагинация: через period или через from и to. Насколько далеко назад можно смотреть, зависит от тарифа: 365 дней в Creator Pro и Agency, 730 дней в Enterprise. Более ранние периоды обрезаются до этого предела.
Встроенные и активные шаблоны рабочего пространства с допустимыми значениями template_key; у шаблонов рабочего пространства ключ ws:<key> и type workspace
GET /v1/templates/{key}
read:workspaces
Один шаблон
GET /v1/workspaces/me/templates
read:workspaces
Ваши собственные шаблоны рабочего пространства
GET /v1/workspaces/me/templates/{id}
read:workspaces
Один шаблон рабочего пространства
POST, PATCH, DELETE /v1/workspaces/me/templates[/{id}]
write:templates
Создание, редактирование, удаление шаблонов рабочего пространства; html не больше 60 000 байт (иначе 422 validation_failed с details.reason maxBytes), до 32 asset_slots
Вебхуки, интеграции, отправка push-уведомлений, управление доменами, участники, оплата и удаление страниц доступны только в панели управления. Секреты колбэков тоже создаются и управляются только там; просматривать их список и читать отдельные секреты (без секрета в открытом виде) можно с read:workspaces. Полный список — в статье Области доступа подробно. Входящие данные — продажи и ваши собственные живые данные — вы отправляете с отдельными секретами на эндпоинты, описанные в статье Колбэки.
