Tous les endpoints utilisables avec une clé API – classés par domaine, avec la méthode, le chemin, la portée requise et leur fonction.
Cette vue d’ensemble liste tous les endpoints qui fonctionnent avec un jeton issu d’une clé API. Tous les chemins commencent par https://dock.at-harbor.com. Les champs exacts de chaque endpoint figurent dans la description OpenAPI à l’adresse https://dock.at-harbor.com/openapi.yaml.
Brouillon actuel : template_key, config, theme_config, custom_css, seo, affectations d’images et liens
PATCH /v1/pages/{id}/draft
write:pages
Au moins l’un de : config (64 Ko au maximum en JSON, chaque texte jusqu’à 5 000 caractères), theme_config, custom_css (jusqu’à 50 000 caractères et 65 535 octets), seo, template_key, template_asset_bindings
Tous les types de blocs avec le schéma de leur config
Types que vous pouvez créer : text, image, embed, spacer, social_links, form, integration, donation, modal, heading, notice, coupon, contact, opening_hours, tour, file, vcard, countdown et gallery. Le bloc Liens est fixe et n’est pas créé via cet endpoint. L’API refuse les types de blocs hors de votre offre avec 403 block_type_requires_plan. La config d’un bloc peut faire au maximum 128 Ko en JSON, et chaque texte qu’elle contient au maximum 10 000 caractères ; dans la modale d’info, modal_body_html peut compter jusqu’à 50 000 caractères et au maximum 65 535 octets.
Créer un lien ; obligatoires : title (1–200) et target_url_template (8–2048)
GET /v1/pages/{id}/links/{linkId}
read:links
Un lien
PATCH /v1/pages/{id}/links/{linkId}
write:links
Modifier un lien
DELETE /v1/pages/{id}/links/{linkId}
write:links
Supprimer un lien
POST /v1/pages/{id}/links/reorder
write:links
Définir l’ordre : {"order":[IDs]}
Champs facultatifs à la création et à la modification : enabled, geo (règle par pays avec mode allowlist ou denylist et countries), device (cibles distinctes par appareil), starts_at et ends_at (planification), protection_tier (protection anti-bots) et age_restriction. La planification et les règles par pays et par appareil sont disponibles à partir de Creator Pro. Pour réordonner, il suffit d’envoyer les ID qui doivent passer en tête – tous les autres liens suivent dans leur ordre précédent. L’API refuse les ID qui n’appartiennent pas à la page avec 422 validation_failed ; details.missing_link_ids les liste.
Créer un formulaire ; obligatoires : name et fields (1–100 champs)
GET /v1/forms/{id}
read:forms
Un formulaire
PATCH /v1/forms/{id}
write:forms
Modifier un formulaire
DELETE /v1/forms/{id}
write:forms
Supprimer un formulaire
GET /v1/forms/{id}/summary
read:forms
Résumé
GET /v1/forms/{id}/submissions
read:forms
Envois, les plus récents d’abord (limit 1–500, 100 par défaut ; pages suivantes via cursor = next_cursor)
GET /v1/forms/{id}/submissions/export
read:forms
Tous les envois dans un fichier CSV, les plus récents d’abord, jusqu’à la limite d’export de l’offre (à partir de Creator Pro) ; l’en-tête X-Export-Truncated indique si le fichier a été tronqué
Vous choisissez la période comme décrit sous Pagination, avec period ou avec from et to. La profondeur disponible dépend de l’offre : 365 jours avec Creator Pro et Agency, 730 jours avec Enterprise. Les périodes plus anciennes sont ramenées à cette limite.
Modèles intégrés et modèles d’espace de travail actifs avec des valeurs template_key valides ; les modèles d’espace de travail ont la clé ws:<key> et le type workspace
GET /v1/templates/{key}
read:workspaces
Un modèle
GET /v1/workspaces/me/templates
read:workspaces
Vos propres modèles d’espace de travail
GET /v1/workspaces/me/templates/{id}
read:workspaces
Un modèle d’espace de travail
POST, PATCH, DELETE /v1/workspaces/me/templates[/{id}]
write:templates
Créer, modifier, supprimer des modèles d’espace de travail ; html au maximum 60 000 octets (sinon 422 validation_failed avec details.reason maxBytes), jusqu’à 32 asset_slots
Les webhooks, les intégrations, l’envoi de notifications push, la gestion des domaines, les membres, la facturation et la suppression de pages ne sont disponibles que dans le tableau de bord. Les secrets de callback se créent et se gèrent aussi uniquement dans le tableau de bord ; avec read:workspaces, vous pouvez seulement les lister et les lire (sans le secret en clair). La liste complète figure dans Les portées en détail. Les données entrantes – ventes et vos propres données en direct – s’envoient avec des secrets distincts aux endpoints décrits dans Callbacks.
