Tutti gli endpoint che puoi usare con una chiave API, ordinati per area, con metodo, percorso, scope richiesto e funzione.
Questa panoramica elenca tutti gli endpoint che funzionano con un token di una chiave API. Tutti i percorsi iniziano con https://dock.at-harbor.com. I campi esatti di ogni endpoint sono nella descrizione OpenAPI su https://dock.at-harbor.com/openapi.yaml.
Bozza attuale: template_key, config, theme_config, custom_css, seo, assegnazioni delle immagini e link
PATCH /v1/pages/{id}/draft
write:pages
Almeno uno tra config (al massimo 64 KB come JSON, ogni testo fino a 5.000 caratteri), theme_config, custom_css (fino a 50.000 caratteri e 65.535 byte), seo, template_key, template_asset_bindings
Tutti i tipi di blocco con lo schema della loro config
Tipi che puoi creare: text, image, embed, spacer, social_links, form, integration, donation, modal, heading, notice, coupon, contact, opening_hours, tour, file, vcard, countdown e gallery. Il blocco dei link è fisso e non si crea con questo endpoint. L’API rifiuta i tipi di blocco non compresi nel tuo piano con 403 block_type_requires_plan. La config di un blocco può essere al massimo di 128 KB come JSON e ogni testo al suo interno di al massimo 10.000 caratteri; nel modale informativo, modal_body_html può avere fino a 50.000 caratteri e al massimo 65.535 byte.
Creare un link; obbligatori: title (1–200) e target_url_template (8–2048)
GET /v1/pages/{id}/links/{linkId}
read:links
Un link
PATCH /v1/pages/{id}/links/{linkId}
write:links
Modificare un link
DELETE /v1/pages/{id}/links/{linkId}
write:links
Eliminare un link
POST /v1/pages/{id}/links/reorder
write:links
Impostare l’ordine: {"order":[IDs]}
Campi facoltativi in creazione e modifica: enabled, geo (regola per paese con mode allowlist o denylist e countries), device (destinazioni separate per dispositivo), starts_at ed ends_at (programmazione), protection_tier (protezione dai bot) e age_restriction. Programmazione, regole per paese e per dispositivo sono disponibili da Creator Pro. Per riordinare basta inviare gli ID che devono passare in testa – tutti gli altri link seguono nell’ordine precedente. L’API rifiuta gli ID che non appartengono alla pagina con 422 validation_failed; details.missing_link_ids li elenca.
Creare un modulo; obbligatori: name e fields (1–100 campi)
GET /v1/forms/{id}
read:forms
Un modulo
PATCH /v1/forms/{id}
write:forms
Modificare un modulo
DELETE /v1/forms/{id}
write:forms
Eliminare un modulo
GET /v1/forms/{id}/summary
read:forms
Riepilogo
GET /v1/forms/{id}/submissions
read:forms
Invii, prima i più recenti (limit 1–500, predefinito 100; pagine successive con cursor = next_cursor)
GET /v1/forms/{id}/submissions/export
read:forms
Tutti gli invii come file CSV, prima i più recenti, fino al limite di esportazione del piano (da Creator Pro); l’header X-Export-Truncated indica se è stato troncato
Scegli il periodo come descritto in Paginazione, con period oppure con from e to. Quanto indietro puoi guardare dipende dal piano: 365 giorni in Creator Pro e Agency, 730 giorni in Enterprise. I periodi più vecchi vengono ridotti a questo limite.
Modelli integrati e modelli del workspace attivi con valori di template_key validi; i modelli del workspace hanno la chiave ws:<key> e il tipo workspace
GET /v1/templates/{key}
read:workspaces
Un modello
GET /v1/workspaces/me/templates
read:workspaces
I tuoi modelli del workspace
GET /v1/workspaces/me/templates/{id}
read:workspaces
Un modello del workspace
POST, PATCH, DELETE /v1/workspaces/me/templates[/{id}]
write:templates
Creare, modificare, eliminare modelli del workspace; html al massimo 60.000 byte (altrimenti 422 validation_failed con details.reason maxBytes), fino a 32 asset_slots
Webhook, integrazioni, invio di notifiche push, gestione di domini, membri, fatturazione ed eliminazione di pagine sono disponibili solo nella dashboard. Anche i secret di callback si possono creare e gestire solo nella dashboard; elencarli e leggerli (senza il secret in chiaro) funziona con read:workspaces. L’elenco completo è in Scope nel dettaglio. I dati in entrata – vendite e i tuoi dati live – li invii con secret separati agli endpoint descritti in Callback.
