Setiap endpoint yang bisa Anda pakai dengan kunci API – diurutkan per area, dengan metode, path, scope yang diperlukan, dan fungsinya.

Ringkasan ini mencantumkan setiap endpoint yang berfungsi dengan token dari kunci API. Semua path diawali https://dock.at-harbor.com. Kolom persis setiap endpoint ada di deskripsi OpenAPI di https://dock.at-harbor.com/openapi.yaml.

Autentikasi dan endpoint publik

Metode dan path	Autentikasi	Tujuan
POST /v1/token	Tidak ada (ID kunci dan rahasia di body)	Menukar kunci API dengan access token
GET /v1/plans	Tidak ada	Paket dan harga
GET /v1/pages/available?handle=…	Tidak ada	Memeriksa apakah sebuah handle masih tersedia

Halaman

Metode dan path	Scope	Tujuan
GET /v1/pages	read:pages	Semua halaman di workspace dengan ID, handle, judul, status, versi tayang, visibilitas, dan URL
POST /v1/pages	write:pages	Membuat halaman; wajib: handle (2–64 karakter, huruf, angka, tanda hubung) dan template_key; opsional title, domain_id, theme_config
GET /v1/pages/{id}	read:pages	Satu halaman; juga has_unpublished_changes (true jika draf berbeda dari versi yang dipublikasikan)
PATCH /v1/pages/{id}	write:pages	Mengubah title, handle, atau discoverable (pencantuman di direktori)
PATCH /v1/pages/{id}/visibility	write:pages	public, private, atau password (dengan password, 4–72 karakter); langsung berlaku
POST /v1/pages/{id}/publish	write:pages	Memublikasikan draf; respons berisi versi baru
GET /v1/pages/{id}/versions	read:pages	Versi yang dipublikasikan
GET /v1/pages/{id}/versions/{version}	read:pages	Satu versi
POST /v1/pages/{id}/versions/{version}/restore	write:pages	Mengembalikan versi ke draf; current membuang semua perubahan draf
GET /v1/pages/{id}/seo	read:pages	Teks SEO dan teks berbagi
PATCH /v1/pages/{id}/seo	write:pages	seo_title, seo_description, og_title, og_description, og_image_asset_id, canonical_url, noindex
POST /v1/pages/{id}/invite-link	write:pages	Tautan undangan untuk halaman privat yang sudah dipublikasikan; days 1–30, bawaan 7. Jika tidak, 409 page_not_private atau page_not_published
POST /v1/pages/{id}/invite-link/revoke	write:pages	Mencabut tautan undangan
POST /v1/pages/{id}/uploads	write:assets	Mengunggah file untuk sebuah halaman

Draf

Metode dan path	Scope	Tujuan
GET /v1/pages/{id}/draft	read:pages	Draf saat ini: template_key, config, theme_config, custom_css, seo, penetapan gambar, dan tautan
PATCH /v1/pages/{id}/draft	write:pages	Minimal salah satu dari config (paling besar 64 KB sebagai JSON, setiap teks hingga 5.000 karakter), theme_config, custom_css (hingga 50.000 karakter dan 65.535 byte), seo, template_key, template_asset_bindings
GET /v1/pages/{id}/draft/validate	read:pages	Memeriksa apakah draf bisa dipublikasikan

Blok

Metode dan path	Scope	Tujuan
GET /v1/pages/{id}/blocks	read:pages	Blok-blok halaman
POST /v1/pages/{id}/blocks	write:pages	Membuat blok; wajib: type dan config
PATCH /v1/pages/{id}/blocks/{blockId}	write:pages	Mengedit blok
DELETE /v1/pages/{id}/blocks/{blockId}	write:pages	Menghapus blok
POST /v1/pages/{id}/blocks/reorder	write:pages	Menetapkan urutan
GET /v1/blocks/schemas	read:pages	Semua jenis blok beserta skema config-nya

Jenis yang bisa Anda buat: text, image, embed, spacer, social_links, form, integration, donation, modal, heading, notice, coupon, contact, opening_hours, tour, file, vcard, countdown, dan gallery. Blok tautan bersifat tetap dan tidak dibuat lewat endpoint ini. API menolak jenis blok di luar paket Anda dengan 403 block_type_requires_plan. config sebuah blok paling besar 128 KB sebagai JSON, dan setiap teks di dalamnya paling banyak 10.000 karakter; di modal info, modal_body_html boleh berisi hingga 50.000 karakter dan paling banyak 65.535 byte.

Tautan

Metode dan path	Scope	Tujuan
GET /v1/pages/{id}/links	read:links	Tautan-tautan halaman
POST /v1/pages/{id}/links	write:links	Membuat tautan; wajib: title (1–200) dan target_url_template (8–2048)
GET /v1/pages/{id}/links/{linkId}	read:links	Satu tautan
PATCH /v1/pages/{id}/links/{linkId}	write:links	Mengedit tautan
DELETE /v1/pages/{id}/links/{linkId}	write:links	Menghapus tautan
POST /v1/pages/{id}/links/reorder	write:links	Menetapkan urutan: {"order":[ID]}

Kolom opsional saat membuat dan mengedit: enabled, geo (aturan negara dengan mode allowlist atau denylist dan countries), device (tujuan terpisah per perangkat), starts_at dan ends_at (penjadwalan), protection_tier (perlindungan bot), dan age_restriction. Penjadwalan, aturan negara, dan aturan perangkat tersedia mulai Creator Pro. Saat mengurutkan ulang, cukup kirim ID yang harus pindah ke depan – semua tautan lain mengikuti dalam urutan sebelumnya. API menolak ID yang bukan milik halaman tersebut dengan 422 validation_failed; details.missing_link_ids mencantumkannya.

Tautan pendek

Metode dan path	Scope	Tujuan
GET /v1/short-links	read:short_links	Tautan pendek dengan limit, offset, sort, dan pencarian q; respons berisi total
POST /v1/short-links	write:short_links	Membuat; wajib: target_url (http atau https, 8–2048); opsional title (hingga 120) dan custom_slug (3–32, huruf kecil, angka, tanda hubung)
GET /v1/short-links/{id}	read:short_links	Satu tautan pendek
PATCH /v1/short-links/{id}	write:short_links	Mengubah target_url atau title
DELETE /v1/short-links/{id}	write:short_links	Menghapus tautan pendek

Jika batas tautan pendek paket sudah tercapai, API merespons dengan 402 plan_limit_reached.

Aset

Metode dan path	Scope	Tujuan
GET /v1/assets	read:assets	Aset-aset workspace
POST /v1/assets	write:assets	Mengunggah file (multipart/form-data, kolom file; opsional page_id, kind, title, alt_text)
DELETE /v1/assets/{assetId}	write:assets	Menghapus aset

Formulir

Metode dan path	Scope	Tujuan
GET /v1/forms	read:forms	Formulir
POST /v1/forms	write:forms	Membuat formulir; wajib: name dan fields (1–100 kolom)
GET /v1/forms/{id}	read:forms	Satu formulir
PATCH /v1/forms/{id}	write:forms	Mengedit formulir
DELETE /v1/forms/{id}	write:forms	Menghapus formulir
GET /v1/forms/{id}/summary	read:forms	Ringkasan
GET /v1/forms/{id}/submissions	read:forms	Kiriman, yang terbaru lebih dulu (limit 1–500, bawaan 100; halaman berikutnya lewat cursor = next_cursor)
GET /v1/forms/{id}/submissions/export	read:forms	Semua kiriman sebagai file CSV, yang terbaru lebih dulu, hingga batas ekspor paket (mulai Creator Pro); header X-Export-Truncated menunjukkan apakah file terpotong

Statistik

Metode dan path	Scope	Tujuan
GET /v1/stats/pages/{id}/summary	read:stats	Angka utama sebuah halaman
GET /v1/stats/pages/{id}/timeseries	read:stats	Deret waktu sebuah halaman
GET /v1/stats/pages/{id}/compare	read:stats	Perbandingan dengan periode sebelumnya
GET /v1/stats/pages/{id}/links	read:stats	Klik per tautan
GET /v1/stats/pages/{id}/widgets	read:stats	Klik pada widget
GET /v1/stats/pages/{id}/conversions/breakdown	read:stats	Konversi sebuah halaman
GET /v1/stats/workspaces/me/summary	read:stats	Angka utama semua halaman
GET /v1/stats/workspaces/me/timeseries	read:stats	Deret waktu semua halaman
GET /v1/stats/workspaces/me/compare	read:stats	Perbandingan dengan periode sebelumnya
GET /v1/stats/workspaces/me/top-pages	read:stats	Halaman teratas
GET /v1/stats/workspaces/me/conversions/breakdown	read:stats	Konversi workspace
GET /v1/stats/workspaces/me/donations	read:donations	Total pembayaran pendukung

Periode Anda pilih seperti dijelaskan di Paginasi, dengan period atau dengan from dan to. Seberapa jauh ke belakang Anda bisa melihat tergantung paketnya: 365 hari di Creator Pro dan Agency, 730 hari di Enterprise. Periode yang lebih lama dipangkas ke batas ini.

Push (hanya baca)

Metode dan path	Scope	Tujuan
GET /v1/push/history	read:stats	Riwayat push (limit, offset)
GET /v1/push/usage	read:stats	Pemakaian batas mingguan

Mengirim notifikasi push dan mengelola aturan push hanya bisa dilakukan di dasbor.

Workspace, templat, dan domain

Metode dan path	Scope	Tujuan
GET /v1/workspaces/me/entitlements	read:workspaces	Fitur dan batas paket
GET /v1/workspaces/me/usage	read:workspaces	Pemakaian saat ini
GET /v1/workspaces/me/usage/metering	read:workspaces	Riwayat pemakaian
GET /v1/workspaces/me/members	read:workspaces	Daftar anggota
GET /v1/workspaces/me/settings	read:workspaces	Pengaturan workspace
GET /v1/workspaces/me/callback-secrets	read:workspaces	Rahasia callback (tanpa rahasia dalam teks biasa)
GET /v1/workspaces/me/callback-secrets/{id}	read:workspaces	Satu rahasia callback (tanpa rahasia dalam teks biasa)
GET /v1/templates	read:workspaces	Semua templat
GET /v1/templates/available	read:workspaces	Templat bawaan dan templat workspace aktif dengan nilai template_key yang valid; templat workspace punya kunci ws:<key> dan type workspace
GET /v1/templates/{key}	read:workspaces	Satu templat
GET /v1/workspaces/me/templates	read:workspaces	Templat workspace Anda sendiri
GET /v1/workspaces/me/templates/{id}	read:workspaces	Satu templat workspace
POST, PATCH, DELETE /v1/workspaces/me/templates[/{id}]	write:templates	Membuat, mengedit, menghapus templat workspace; html paling besar 60.000 byte (jika tidak, 422 validation_failed dengan details.reason maxBytes), hingga 32 asset_slots
GET /v1/domains	read:workspaces	Domain kustom
GET /v1/domains/available	read:workspaces	Domain yang tersedia untuk halaman

Tidak tersedia dengan kunci API

Webhook, integrasi, mengirim notifikasi push, mengelola domain, anggota, penagihan, dan menghapus halaman hanya tersedia di dasbor. Rahasia callback juga hanya bisa dibuat dan dikelola di dasbor; mendaftar dan membacanya (tanpa rahasia dalam teks biasa) berfungsi dengan read:workspaces. Daftar lengkapnya ada di Scope secara detail. Data masuk – penjualan dan data langsung Anda sendiri – Anda kirim dengan secret terpisah ke endpoint yang dijelaskan di Callback.

Tidak menemukan jawabannya?

Beri tahu kami apa yang Anda perlukan, dan tim dukungan kami akan membantu Anda secara langsung.

Hubungi dukungan

Endpoint API per area

#Autentikasi dan endpoint publik

#Halaman

#Draf

#Blok

#Tautan

#Tautan pendek

#Aset

#Formulir

#Statistik

#Push (hanya baca)

#Workspace, templat, dan domain

#Tidak tersedia dengan kunci API

Mungkin ini juga berguna