हर वह एंडपॉइंट जिसे आप API key से इस्तेमाल कर सकते हैं – हिस्सों के हिसाब से, मेथड, पाथ, ज़रूरी स्कोप और उसके काम के साथ।

यह ओवरव्यू हर उस एंडपॉइंट की सूची है जो API key के टोकन के साथ काम करता है। सभी पाथ https://dock.at-harbor.com से शुरू होते हैं। हर एंडपॉइंट के सटीक फ़ील्ड https://dock.at-harbor.com/openapi.yaml पर OpenAPI विवरण में हैं।

ऑथेंटिकेशन और सार्वजनिक एंडपॉइंट

मेथड और पाथ	ऑथेंटिकेशन	उद्देश्य
POST /v1/token	कोई नहीं (बॉडी में key ID और secret)	API key के बदले access token लेना
GET /v1/plans	कोई नहीं	प्लान और कीमतें
GET /v1/pages/available?handle=…	कोई नहीं	जाँचना कि हैंडल ख़ाली है या नहीं

पेज

मेथड और पाथ	स्कोप	उद्देश्य
GET /v1/pages	read:pages	वर्कस्पेस के सभी पेज, ID, हैंडल, शीर्षक, स्थिति, लाइव वर्ज़न, दृश्यता और URL के साथ
POST /v1/pages	write:pages	पेज बनाना; ज़रूरी: handle (2–64 अक्षर, अक्षर, अंक, हाइफ़न) और template_key; वैकल्पिक title, domain_id, theme_config
GET /v1/pages/{id}	read:pages	एक पेज; साथ में has_unpublished_changes (true अगर ड्राफ़्ट पब्लिश किए वर्ज़न से अलग है)
PATCH /v1/pages/{id}	write:pages	title, handle या discoverable (डायरेक्टरी में लिस्टिंग) बदलना
PATCH /v1/pages/{id}/visibility	write:pages	public, private या password (password के साथ, 4–72 अक्षर); तुरंत लागू
POST /v1/pages/{id}/publish	write:pages	ड्राफ़्ट पब्लिश करना; जवाब में नया वर्ज़न होता है
GET /v1/pages/{id}/versions	read:pages	पब्लिश किए गए वर्ज़न
GET /v1/pages/{id}/versions/{version}	read:pages	एक वर्ज़न
POST /v1/pages/{id}/versions/{version}/restore	write:pages	किसी वर्ज़न को ड्राफ़्ट में लाना; current ड्राफ़्ट के सभी बदलाव छोड़ देता है
GET /v1/pages/{id}/seo	read:pages	SEO और शेयरिंग टेक्स्ट
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	निजी, पब्लिश किए पेज का आमंत्रण लिंक; days 1–30, डिफ़ॉल्ट 7। वरना 409 page_not_private या page_not_published
POST /v1/pages/{id}/invite-link/revoke	write:pages	आमंत्रण लिंक रद्द करना
POST /v1/pages/{id}/uploads	write:assets	किसी पेज के लिए फ़ाइल अपलोड करना

ड्राफ़्ट

मेथड और पाथ	स्कोप	उद्देश्य
GET /v1/pages/{id}/draft	read:pages	मौजूदा ड्राफ़्ट: template_key, config, theme_config, custom_css, seo, इमेज असाइनमेंट और लिंक
PATCH /v1/pages/{id}/draft	write:pages	इनमें से कम से कम एक: config (JSON के रूप में ज़्यादा से ज़्यादा 64 KB, हर टेक्स्ट 5,000 अक्षर तक), theme_config, custom_css (50,000 अक्षर और 65,535 बाइट तक), seo, template_key, template_asset_bindings
GET /v1/pages/{id}/draft/validate	read:pages	जाँचना कि ड्राफ़्ट पब्लिश हो सकता है या नहीं

ब्लॉक

मेथड और पाथ	स्कोप	उद्देश्य
GET /v1/pages/{id}/blocks	read:pages	पेज के ब्लॉक
POST /v1/pages/{id}/blocks	write:pages	ब्लॉक बनाना; ज़रूरी: type और config
PATCH /v1/pages/{id}/blocks/{blockId}	write:pages	ब्लॉक बदलना
DELETE /v1/pages/{id}/blocks/{blockId}	write:pages	ब्लॉक हटाना
POST /v1/pages/{id}/blocks/reorder	write:pages	क्रम तय करना
GET /v1/blocks/schemas	read:pages	सभी ब्लॉक प्रकार, उनके config के स्कीमा के साथ

जो प्रकार आप बना सकते हैं: text, image, embed, spacer, social_links, form, integration, donation, modal, heading, notice, coupon, contact, opening_hours, tour, file, vcard, countdown और gallery। लिंक ब्लॉक तय है और इस एंडपॉइंट से नहीं बनता। आपके प्लान से बाहर के ब्लॉक प्रकार API 403 block_type_requires_plan के साथ अस्वीकार करता है। किसी ब्लॉक का config JSON के रूप में ज़्यादा से ज़्यादा 128 KB का हो सकता है, और उसका हर टेक्स्ट ज़्यादा से ज़्यादा 10,000 अक्षर; जानकारी मोडल में modal_body_html में 50,000 अक्षर तक और ज़्यादा से ज़्यादा 65,535 बाइट हो सकते हैं।

लिंक

मेथड और पाथ	स्कोप	उद्देश्य
GET /v1/pages/{id}/links	read:links	पेज के लिंक
POST /v1/pages/{id}/links	write:links	लिंक बनाना; ज़रूरी: title (1–200) और target_url_template (8–2048)
GET /v1/pages/{id}/links/{linkId}	read:links	एक लिंक
PATCH /v1/pages/{id}/links/{linkId}	write:links	लिंक बदलना
DELETE /v1/pages/{id}/links/{linkId}	write:links	लिंक हटाना
POST /v1/pages/{id}/links/reorder	write:links	क्रम तय करना: {"order":[IDs]}

बनाते और बदलते समय वैकल्पिक फ़ील्ड: enabled, geo (allowlist या denylist mode और countries के साथ देश नियम), device (हर डिवाइस के लिए अलग लक्ष्य), starts_at और ends_at (शेड्यूलिंग), protection_tier (बॉट सुरक्षा) और age_restriction। शेड्यूलिंग, देश और डिवाइस नियम Creator Pro से उपलब्ध हैं। क्रम बदलते समय सिर्फ़ उन IDs को भेजना काफ़ी है जिन्हें आगे जाना है – बाकी सभी लिंक अपने पिछले क्रम में पीछे आते हैं। पेज से न जुड़ी IDs को API 422 validation_failed के साथ अस्वीकार करता है; details.missing_link_ids उनकी सूची देता है।

शॉर्ट लिंक

मेथड और पाथ	स्कोप	उद्देश्य
GET /v1/short-links	read:short_links	limit, offset, sort और खोज q के साथ शॉर्ट लिंक; जवाब में total होता है
POST /v1/short-links	write:short_links	बनाना; ज़रूरी: target_url (http या https, 8–2048); वैकल्पिक title (120 तक) और custom_slug (3–32, छोटे अक्षर, अंक, हाइफ़न)
GET /v1/short-links/{id}	read:short_links	एक शॉर्ट लिंक
PATCH /v1/short-links/{id}	write:short_links	target_url या title बदलना
DELETE /v1/short-links/{id}	write:short_links	शॉर्ट लिंक हटाना

प्लान की शॉर्ट लिंक सीमा पूरी होने पर API 402 plan_limit_reached के साथ जवाब देता है।

फ़ाइलें

मेथड और पाथ	स्कोप	उद्देश्य
GET /v1/assets	read:assets	वर्कस्पेस की फ़ाइलें
POST /v1/assets	write:assets	फ़ाइल अपलोड करना (multipart/form-data, फ़ील्ड file; वैकल्पिक page_id, kind, title, alt_text)
DELETE /v1/assets/{assetId}	write:assets	फ़ाइल हटाना

फ़ॉर्म

मेथड और पाथ	स्कोप	उद्देश्य
GET /v1/forms	read:forms	फ़ॉर्म
POST /v1/forms	write:forms	फ़ॉर्म बनाना; ज़रूरी: name और fields (1–100 फ़ील्ड)
GET /v1/forms/{id}	read:forms	एक फ़ॉर्म
PATCH /v1/forms/{id}	write:forms	फ़ॉर्म बदलना
DELETE /v1/forms/{id}	write:forms	फ़ॉर्म हटाना
GET /v1/forms/{id}/summary	read:forms	सारांश
GET /v1/forms/{id}/submissions	read:forms	सबमिशन, सबसे नए पहले (limit 1–500, डिफ़ॉल्ट 100; आगे के पेज cursor = next_cursor से)
GET /v1/forms/{id}/submissions/export	read:forms	सभी सबमिशन CSV फ़ाइल के रूप में, सबसे नए पहले, प्लान की एक्सपोर्ट सीमा तक (Creator Pro से); X-Export-Truncated हेडर दिखाता है कि उसे छोटा किया गया या नहीं

आँकड़े

मेथड और पाथ	स्कोप	उद्देश्य
GET /v1/stats/pages/{id}/summary	read:stats	किसी पेज के मुख्य आँकड़े
GET /v1/stats/pages/{id}/timeseries	read:stats	किसी पेज की टाइम सीरीज़
GET /v1/stats/pages/{id}/compare	read:stats	पिछली अवधि से तुलना
GET /v1/stats/pages/{id}/links	read:stats	हर लिंक के क्लिक
GET /v1/stats/pages/{id}/widgets	read:stats	विजेट पर क्लिक
GET /v1/stats/pages/{id}/conversions/breakdown	read:stats	किसी पेज के कन्वर्ज़न
GET /v1/stats/workspaces/me/summary	read:stats	सभी पेजों के मुख्य आँकड़े
GET /v1/stats/workspaces/me/timeseries	read:stats	सभी पेजों की टाइम सीरीज़
GET /v1/stats/workspaces/me/compare	read:stats	पिछली अवधि से तुलना
GET /v1/stats/workspaces/me/top-pages	read:stats	टॉप पेज
GET /v1/stats/workspaces/me/conversions/breakdown	read:stats	वर्कस्पेस के कन्वर्ज़न
GET /v1/stats/workspaces/me/donations	read:donations	समर्थकों के भुगतान का कुल

अवधि आप पेजिनेशन में बताए अनुसार period से या from और to से चुनते हैं। आप कितना पीछे देख सकते हैं, यह प्लान पर निर्भर करता है: Creator Pro और Agency में 365 दिन, Enterprise में 730 दिन। पुरानी अवधियाँ इस सीमा तक छोटी कर दी जाती हैं।

पुश (सिर्फ़ पढ़ना)

मेथड और पाथ	स्कोप	उद्देश्य
GET /v1/push/history	read:stats	पुश इतिहास (limit, offset)
GET /v1/push/usage	read:stats	हफ़्ते की सीमा का इस्तेमाल

पुश नोटिफ़िकेशन भेजना और पुश नियम मैनेज करना सिर्फ़ डैशबोर्ड में संभव है।

वर्कस्पेस, टेम्पलेट और डोमेन

मेथड और पाथ	स्कोप	उद्देश्य
GET /v1/workspaces/me/entitlements	read:workspaces	प्लान के फ़ीचर और सीमाएँ
GET /v1/workspaces/me/usage	read:workspaces	मौजूदा इस्तेमाल
GET /v1/workspaces/me/usage/metering	read:workspaces	इस्तेमाल का इतिहास
GET /v1/workspaces/me/members	read:workspaces	सदस्य सूची
GET /v1/workspaces/me/settings	read:workspaces	वर्कस्पेस सेटिंग
GET /v1/workspaces/me/callback-secrets	read:workspaces	Callback secrets (सादे टेक्स्ट वाले secret के बिना)
GET /v1/workspaces/me/callback-secrets/{id}	read:workspaces	एक callback secret (सादे टेक्स्ट वाले secret के बिना)
GET /v1/templates	read:workspaces	सभी टेम्पलेट
GET /v1/templates/available	read:workspaces	मान्य template_key वैल्यू वाले बिल्ट-इन और सक्रिय वर्कस्पेस टेम्पलेट; वर्कस्पेस टेम्पलेट की key ws:<key> और type workspace होता है
GET /v1/templates/{key}	read:workspaces	एक टेम्पलेट
GET /v1/workspaces/me/templates	read:workspaces	आपके अपने वर्कस्पेस टेम्पलेट
GET /v1/workspaces/me/templates/{id}	read:workspaces	एक वर्कस्पेस टेम्पलेट
POST, PATCH, DELETE /v1/workspaces/me/templates[/{id}]	write:templates	वर्कस्पेस टेम्पलेट बनाना, बदलना, हटाना; html ज़्यादा से ज़्यादा 60,000 बाइट (वरना details.reason maxBytes के साथ 422 validation_failed), 32 asset_slots तक
GET /v1/domains	read:workspaces	कस्टम डोमेन
GET /v1/domains/available	read:workspaces	पेजों के लिए उपलब्ध डोमेन

API keys से उपलब्ध नहीं

Webhooks, callback secrets बनाना और मैनेज करना, इंटीग्रेशन, पुश नोटिफ़िकेशन भेजना, डोमेन, सदस्य, बिलिंग मैनेज करना और पेज हटाना सिर्फ़ डैशबोर्ड में उपलब्ध हैं। callback secrets की सूची देखना और उन्हें पढ़ना (सादे टेक्स्ट वाले secret के बिना) read:workspaces से काम करता है। पूरी सूची स्कोप विस्तार से में है। आने वाला डेटा – बिक्री और आपका अपना लाइव डेटा – आप अलग secrets के साथ Callbacks में बताए एंडपॉइंट पर भेजते हैं।

कुछ नहीं मिला?

हमें बताएँ कि आपको क्या चाहिए, और हमारी सपोर्ट टीम ख़ुद आपकी मदद करेगी।

सपोर्ट से संपर्क करें

हिस्सों के हिसाब से API एंडपॉइंट

#ऑथेंटिकेशन और सार्वजनिक एंडपॉइंट

#पेज

#ड्राफ़्ट

#ब्लॉक

#लिंक

#शॉर्ट लिंक

#फ़ाइलें

#फ़ॉर्म

#आँकड़े

#पुश (सिर्फ़ पढ़ना)

#वर्कस्पेस, टेम्पलेट और डोमेन

#API keys से उपलब्ध नहीं

यह भी आपके काम आ सकता है