Atualizado a 1 de novembro de 2026·7 min de leitura
/
Todos os endpoints que pode usar com uma chave de API – ordenados por área, com o método, o caminho, o scope necessário e a respetiva função.
Esta visão geral lista todos os endpoints que funcionam com um token de uma chave de API. Todos os caminhos começam por https://dock.at-harbor.com. Os campos exatos de cada endpoint estão na descrição OpenAPI em https://dock.at-harbor.com/openapi.yaml.
Rascunho atual: template_key, config, theme_config, custom_css, seo, atribuições de imagens e links
PATCH /v1/pages/{id}/draft
write:pages
Pelo menos um de config (no máximo 64 KB como JSON, cada texto até 5000 caracteres), theme_config, custom_css (até 50 000 caracteres e 65 535 bytes), seo, template_key, template_asset_bindings
Todos os tipos de bloco com o esquema da respetiva config
Tipos que pode criar: text, image, embed, spacer, social_links, form, integration, donation, modal, heading, notice, coupon, contact, opening_hours, tour, file, vcard, countdown e gallery. O bloco de links é fixo e não é criado através deste endpoint. A API recusa tipos de bloco fora do seu plano com 403 block_type_requires_plan. A config de um bloco pode ter no máximo 128 KB como JSON, e cada texto nela no máximo 10 000 caracteres; na janela de informação, modal_body_html pode ter até 50 000 caracteres e no máximo 65 535 bytes.
Criar um link; obrigatórios: title (1–200) e target_url_template (8–2048)
GET /v1/pages/{id}/links/{linkId}
read:links
Um link
PATCH /v1/pages/{id}/links/{linkId}
write:links
Editar um link
DELETE /v1/pages/{id}/links/{linkId}
write:links
Eliminar um link
POST /v1/pages/{id}/links/reorder
write:links
Definir a ordem: {"order":[IDs]}
Campos opcionais ao criar e editar: enabled, geo (regra de países com mode allowlist ou denylist e countries), device (destinos separados por dispositivo), starts_at e ends_at (agendamento), protection_tier (proteção contra bots) e age_restriction. As regras de agendamento, país e dispositivo estão disponíveis a partir do Creator Pro. Ao reordenar, basta enviar os IDs que devem passar para a frente – todos os outros links seguem na ordem anterior. A API recusa IDs que não pertencem à página com 422 validation_failed; details.missing_link_ids indica-os.
Criar um formulário; obrigatórios: name e fields (1–100 campos)
GET /v1/forms/{id}
read:forms
Um formulário
PATCH /v1/forms/{id}
write:forms
Editar um formulário
DELETE /v1/forms/{id}
write:forms
Eliminar um formulário
GET /v1/forms/{id}/summary
read:forms
Resumo
GET /v1/forms/{id}/submissions
read:forms
Submissões, mais recentes primeiro (limit 1–500, predefinição 100; páginas seguintes via cursor = next_cursor)
GET /v1/forms/{id}/submissions/export
read:forms
Todas as submissões como ficheiro CSV, mais recentes primeiro, até ao limite de exportação do plano (a partir do Creator Pro); o cabeçalho X-Export-Truncated indica se foi cortado
Escolhe o período como descrito em Paginação, com period ou com from e to. O tempo que pode recuar depende do plano: 365 dias no Creator Pro e no Agency, 730 dias no Enterprise. Os períodos mais antigos são reduzidos a este limite.
Segredos de callback (sem o segredo em texto simples)
GET /v1/workspaces/me/callback-secrets/{id}
read:workspaces
Um segredo de callback (sem o segredo em texto simples)
GET /v1/templates
read:workspaces
Todos os modelos
GET /v1/templates/available
read:workspaces
Modelos incluídos e modelos ativos do espaço de trabalho com valores válidos de template_key; os modelos do espaço de trabalho têm a chave ws:<key> e o tipo workspace
GET /v1/templates/{key}
read:workspaces
Um modelo
GET /v1/workspaces/me/templates
read:workspaces
Os seus próprios modelos do espaço de trabalho
GET /v1/workspaces/me/templates/{id}
read:workspaces
Um modelo do espaço de trabalho
POST, PATCH, DELETE /v1/workspaces/me/templates[/{id}]
write:templates
Criar, editar e eliminar modelos do espaço de trabalho; html no máximo 60 000 bytes (caso contrário, 422 validation_failed com details.reason maxBytes), até 32 asset_slots
Webhooks, a criação e a gestão de segredos de callback, integrações, envio de notificações push, gestão de domínios, membros, faturação e eliminação de páginas só estão disponíveis no painel. Listar e ler os segredos de callback (sem o segredo em texto simples) funciona com read:workspaces. A lista completa está em Scopes em pormenor. Os dados recebidos – vendas e os seus próprios dados em direto – são enviados com segredos próprios para os endpoints descritos em Callbacks.
