Mọi endpoint bạn dùng được với khóa API – sắp xếp theo khu vực, kèm phương thức, đường dẫn, phạm vi cần thiết và chức năng.
Phần tổng quan này liệt kê mọi endpoint hoạt động với token từ khóa API. Mọi đường dẫn đều bắt đầu bằng https://dock.at-harbor.com. Các trường chính xác của từng endpoint có trong bản mô tả OpenAPI tại https://dock.at-harbor.com/openapi.yaml.
Bản nháp hiện tại: template_key, config, theme_config, custom_css, seo, gán ảnh và liên kết
PATCH /v1/pages/{id}/draft
write:pages
Ít nhất một trong config (tối đa 64 KB dạng JSON, mỗi văn bản tối đa 5.000 ký tự), theme_config, custom_css (tối đa 50.000 ký tự và 65.535 byte), seo, template_key, template_asset_bindings
Các loại bạn tạo được: text, image, embed, spacer, social_links, form, integration, donation, modal, heading, notice, coupon, contact, opening_hours, tour, file, vcard, countdown và gallery. Khối liên kết là cố định và không được tạo qua endpoint này. API từ chối loại khối ngoài gói của bạn với 403 block_type_requires_plan. config của một khối tối đa 128 KB dạng JSON, và mỗi văn bản trong đó tối đa 10.000 ký tự; trong hộp thoại thông tin, modal_body_html có thể có tối đa 50.000 ký tự và tối đa 65.535 byte.
Tạo liên kết; bắt buộc: title (1–200) và target_url_template (8–2048)
GET /v1/pages/{id}/links/{linkId}
read:links
Một liên kết
PATCH /v1/pages/{id}/links/{linkId}
write:links
Chỉnh sửa liên kết
DELETE /v1/pages/{id}/links/{linkId}
write:links
Xóa liên kết
POST /v1/pages/{id}/links/reorder
write:links
Đặt thứ tự: {"order":[IDs]}
Các trường tùy chọn khi tạo và chỉnh sửa: enabled, geo (quy tắc quốc gia với mode allowlist hoặc denylist và countries), device (đích riêng cho từng thiết bị), starts_at và ends_at (lên lịch), protection_tier (chống bot) và age_restriction. Lên lịch, quy tắc quốc gia và thiết bị có từ gói Creator Pro. Khi sắp xếp, chỉ cần gửi các ID cần đưa lên trước – mọi liên kết khác theo sau theo thứ tự cũ. API từ chối các ID không thuộc trang với 422 validation_failed; details.missing_link_ids liệt kê chúng.
Bạn chọn khoảng thời gian như mô tả trong Phân trang, với period hoặc với from và to. Bạn xem được lùi xa đến đâu tùy gói: 365 ngày ở Creator Pro và Agency, 730 ngày ở Enterprise. Các khoảng cũ hơn bị cắt về giới hạn này.
Mã bí mật callback (không có mã bí mật dạng văn bản thuần)
GET /v1/workspaces/me/callback-secrets/{id}
read:workspaces
Một mã bí mật callback (không có mã bí mật dạng văn bản thuần)
GET /v1/templates
read:workspaces
Mọi mẫu
GET /v1/templates/available
read:workspaces
Mẫu có sẵn và mẫu không gian làm việc đang hoạt động với giá trị template_key hợp lệ; mẫu không gian làm việc có key ws:<key> và type workspace
GET /v1/templates/{key}
read:workspaces
Một mẫu
GET /v1/workspaces/me/templates
read:workspaces
Mẫu không gian làm việc của riêng bạn
GET /v1/workspaces/me/templates/{id}
read:workspaces
Một mẫu không gian làm việc
POST, PATCH, DELETE /v1/workspaces/me/templates[/{id}]
write:templates
Tạo, chỉnh sửa, xóa mẫu không gian làm việc; html tối đa 60.000 byte (nếu không thì 422 validation_failed với details.reason maxBytes), tối đa 32 asset_slots
Webhook, tích hợp, gửi thông báo đẩy, quản lý tên miền, thành viên, thanh toán và xóa trang chỉ có trong bảng điều khiển. Mã bí mật callback cũng chỉ tạo và quản lý được trong bảng điều khiển; việc liệt kê và đọc chúng (không có mã bí mật dạng văn bản thuần) hoạt động với read:workspaces. Danh sách đầy đủ có trong Chi tiết về phạm vi. Dữ liệu đến – doanh số và dữ liệu trực tiếp của riêng bạn – bạn gửi bằng các secret riêng đến những endpoint được mô tả trong Callback.
