Bir API anahtarıyla kullanabileceğin her uç nokta – alanlara göre sıralanmış, yöntemi, yolu, gereken kapsamı ve ne yaptığıyla.
Bu genel bakış, bir API anahtarından alınan token’la çalışan her uç noktayı listeler. Tüm yollar https://dock.at-harbor.com ile başlar. Her uç noktanın tam alanları https://dock.at-harbor.com/openapi.yaml adresindeki OpenAPI açıklamasındadır.
Güncel taslak: template_key, config, theme_config, custom_css, seo, görsel atamaları ve bağlantılar
PATCH /v1/pages/{id}/draft
write:pages
Şunlardan en az biri: config (JSON olarak en fazla 64 KB, her metin en fazla 5.000 karakter), theme_config, custom_css (en fazla 50.000 karakter ve 65.535 bayt), seo, template_key, template_asset_bindings
GET /v1/pages/{id}/draft/validate
read:pages
Taslağın yayınlanıp yayınlanamayacağını kontrol et
Oluşturabileceğin türler: text, image, embed, spacer, social_links, form, integration, donation, modal, heading, notice, coupon, contact, opening_hours, tour, file, vcard, countdown ve gallery. links bloğu sabittir ve bu uç nokta üzerinden oluşturulmaz. API planının dışındaki blok türlerini 403 block_type_requires_plan ile reddeder. Bir bloğun config’i JSON olarak en fazla 128 KB, içindeki her metin en fazla 10.000 karakter olabilir; bilgi penceresinde modal_body_html en fazla 50.000 karakter ve en fazla 65.535 bayt olabilir.
Bağlantı oluştur; zorunlu: title (1–200) ve target_url_template (8–2048)
GET /v1/pages/{id}/links/{linkId}
read:links
Tek bir bağlantı
PATCH /v1/pages/{id}/links/{linkId}
write:links
Bir bağlantıyı düzenle
DELETE /v1/pages/{id}/links/{linkId}
write:links
Bir bağlantıyı sil
POST /v1/pages/{id}/links/reorder
write:links
Sırayı belirle: {"order":[IDs]}
Oluştururken ve düzenlerken isteğe bağlı alanlar: enabled, geo (allowlist veya denylist modu ve countries ile ülke kuralı), device (cihaz başına ayrı hedefler), starts_at ve ends_at (zamanlama), protection_tier (bot koruması) ve age_restriction. Zamanlama, ülke ve cihaz kuralları Creator Pro’dan itibaren kullanılabilir. Yeniden sıralarken yalnızca öne gelmesi gereken kimlikleri göndermek yeterlidir – diğer tüm bağlantılar önceki sıralarıyla takip eder. API sayfaya ait olmayan kimlikleri 422 validation_failed ile reddeder; details.missing_link_ids bunları listeler.
Form oluştur; zorunlu: name ve fields (1–100 alan)
GET /v1/forms/{id}
read:forms
Tek bir form
PATCH /v1/forms/{id}
write:forms
Bir formu düzenle
DELETE /v1/forms/{id}
write:forms
Bir formu sil
GET /v1/forms/{id}/summary
read:forms
Özet
GET /v1/forms/{id}/submissions
read:forms
Önce en yeni gönderimler (limit 1–500, varsayılan 100; sonraki sayfalar cursor = next_cursor ile)
GET /v1/forms/{id}/submissions/export
read:forms
Planın dışa aktarma limitine kadar tüm gönderimler önce en yeni olarak CSV dosyasında (Creator Pro’dan itibaren); X-Export-Truncated başlığı kısaltılıp kısaltılmadığını gösterir
Dönemi Sayfalama altında anlatıldığı gibi period ile ya da from ve to ile seçersin. Ne kadar geriye bakabileceğin plana bağlıdır: Creator Pro ve Agency’de 365 gün, Enterprise’da 730 gün. Daha eski dönemler bu sınıra kısaltılır.
Callback gizli anahtarları (düz metin gizli değer olmadan)
GET /v1/workspaces/me/callback-secrets/{id}
read:workspaces
Tek bir callback gizli anahtarı (düz metin gizli değer olmadan)
GET /v1/templates
read:workspaces
Tüm şablonlar
GET /v1/templates/available
read:workspaces
Geçerli template_key değerleriyle yerleşik ve etkin çalışma alanı şablonları; çalışma alanı şablonlarının anahtarı ws:<key> ve türü workspace’tir
GET /v1/templates/{key}
read:workspaces
Tek bir şablon
GET /v1/workspaces/me/templates
read:workspaces
Kendi çalışma alanı şablonların
GET /v1/workspaces/me/templates/{id}
read:workspaces
Tek bir çalışma alanı şablonu
POST, PATCH, DELETE /v1/workspaces/me/templates[/{id}]
write:templates
Çalışma alanı şablonları oluştur, düzenle, sil; html en fazla 60.000 bayt (aksi halde details.reason maxBytes ile 422 validation_failed), en fazla 32 asset_slots
Webhook’lar, entegrasyonlar, anlık bildirim gönderme, alan adı yönetimi, üyeler, faturalama ve sayfa silme yalnızca panelde kullanılabilir. Callback gizli anahtarları da yalnızca panelde oluşturulabilir ve yönetilebilir; bunları listelemek ve okumak (düz metin gizli değer olmadan) read:workspaces ile çalışır. Tam liste Ayrıntılı kapsamlar bölümünde. Gelen verileri – satışları ve kendi canlı verilerini – ayrı gizli anahtarlarla Callback’ler bölümünde anlatılan uç noktalara gönderirsin.
