Skip to content
ভাষা: বাংলা

ডেভেলপারদের জন্য API

ক্ষেত্র অনুযায়ী API এন্ডপয়েন্ট

হালনাগাদ ১ নভেম্বর, ২০২৬ 7 মিনিটে পড়া

API কী দিয়ে ব্যবহার করা যায় এমন প্রতিটি এন্ডপয়েন্ট – ক্ষেত্র অনুযায়ী সাজানো, মেথড, পাথ, দরকারি স্কোপ আর কাজের বিবরণসহ।

এই তালিকায় সেই সব এন্ডপয়েন্ট আছে যা API কী থেকে পাওয়া টোকেন দিয়ে কাজ করে। সব পাথ শুরু হয় https://dock.at-harbor.com দিয়ে। প্রতিটি এন্ডপয়েন্টের সঠিক ফিল্ডগুলো আছে https://dock.at-harbor.com/openapi.yaml-এর OpenAPI বিবরণে।

অথেনটিকেশন আর পাবলিক এন্ডপয়েন্ট

মেথড ও পাথঅথেনটিকেশনউদ্দেশ্য
POST /v1/tokenনেই (কী আইডি আর সিক্রেট বডিতে)API কী-এর বদলে অ্যাক্সেস টোকেন নেওয়া
GET /v1/plansনেইপ্ল্যান আর দাম
GET /v1/pages/available?handle=…নেইকোনো হ্যান্ডেল খালি আছে কি না যাচাই করা

পেজ

মেথড ও পাথস্কোপউদ্দেশ্য
GET /v1/pagesread:pagesওয়ার্কস্পেসের সব পেজ, আইডি, হ্যান্ডেল, শিরোনাম, স্ট্যাটাস, লাইভ ভার্সন, দৃশ্যমানতা আর URL সহ
POST /v1/pageswrite:pagesপেজ তৈরি; আবশ্যক: handle (২–৬৪ অক্ষর, অক্ষর, অঙ্ক, হাইফেন) আর template_key; ঐচ্ছিক title, domain_id, theme_config
GET /v1/pages/{id}read:pagesএকটি পেজ; সাথে has_unpublished_changes (খসড়া পাবলিশড ভার্সন থেকে আলাদা হলে true)
PATCH /v1/pages/{id}write:pagestitle, handle বা discoverable (ডিরেক্টরিতে তালিকাভুক্তি) পরিবর্তন
PATCH /v1/pages/{id}/visibilitywrite:pagespublic, private বা password (password সহ, ৪–৭২ অক্ষর); সাথে সাথে কার্যকর হয়
POST /v1/pages/{id}/publishwrite:pagesখসড়া পাবলিশ করা; রেসপন্সে নতুন ভার্সন থাকে
GET /v1/pages/{id}/versionsread:pagesপাবলিশড ভার্সনগুলো
GET /v1/pages/{id}/versions/{version}read:pagesএকটি ভার্সন
POST /v1/pages/{id}/versions/{version}/restorewrite:pagesএকটি ভার্সন খসড়ায় ফিরিয়ে আনা; current খসড়ার সব পরিবর্তন বাতিল করে
GET /v1/pages/{id}/seoread:pagesSEO আর শেয়ারিংয়ের টেক্সট
PATCH /v1/pages/{id}/seowrite:pagesseo_title, seo_description, og_title, og_description, og_image_asset_id, canonical_url, noindex
POST /v1/pages/{id}/invite-linkwrite:pagesপ্রাইভেট, পাবলিশড পেজের আমন্ত্রণ লিংক; days ১–৩০, ডিফল্ট ৭। নইলে 409 page_not_private বা page_not_published
POST /v1/pages/{id}/invite-link/revokewrite:pagesআমন্ত্রণ লিংক বাতিল করা
POST /v1/pages/{id}/uploadswrite:assetsকোনো পেজের জন্য ফাইল আপলোড

খসড়া

মেথড ও পাথস্কোপউদ্দেশ্য
GET /v1/pages/{id}/draftread:pagesবর্তমান খসড়া: template_key, config, theme_config, custom_css, seo, ছবির অ্যাসাইনমেন্ট আর লিংক
PATCH /v1/pages/{id}/draftwrite:pagesঅন্তত একটি: config (JSON হিসেবে সর্বোচ্চ ৬৪ KB, প্রতিটি টেক্সট সর্বোচ্চ ৫,০০০ অক্ষর), theme_config, custom_css (সর্বোচ্চ ৫০,০০০ অক্ষর আর ৬৫,৫৩৫ বাইট), seo, template_key, template_asset_bindings
GET /v1/pages/{id}/draft/validateread:pagesখসড়া পাবলিশ করা যাবে কি না যাচাই করা

ব্লক

মেথড ও পাথস্কোপউদ্দেশ্য
GET /v1/pages/{id}/blocksread:pagesপেজের ব্লকগুলো
POST /v1/pages/{id}/blockswrite:pagesব্লক তৈরি; আবশ্যক: type আর config
PATCH /v1/pages/{id}/blocks/{blockId}write:pagesব্লক সম্পাদনা
DELETE /v1/pages/{id}/blocks/{blockId}write:pagesব্লক মোছা
POST /v1/pages/{id}/blocks/reorderwrite:pagesক্রম ঠিক করা
GET /v1/blocks/schemasread: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 হিসেবে সর্বোচ্চ ১২৮ KB হতে পারে, আর এর প্রতিটি টেক্সট সর্বোচ্চ ১০,০০০ অক্ষর; তথ্য মোডালে modal_body_html সর্বোচ্চ ৫০,০০০ অক্ষর এবং সর্বোচ্চ ৬৫,৫৩৫ বাইট হতে পারে।

লিংক

মেথড ও পাথস্কোপউদ্দেশ্য
GET /v1/pages/{id}/linksread:linksপেজের লিংকগুলো
POST /v1/pages/{id}/linkswrite:linksলিংক তৈরি; আবশ্যক: title (১–২০০) আর target_url_template (৮–২০৪৮)
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/reorderwrite:linksক্রম ঠিক করা: {"order":[IDs]}

তৈরি আর সম্পাদনার সময় ঐচ্ছিক ফিল্ড: enabled, geo (allowlist বা denylist মোড আর countries সহ দেশের নিয়ম), device (ডিভাইস অনুযায়ী আলাদা টার্গেট), starts_at আর ends_at (সময়সূচি), protection_tier (বট সুরক্ষা) আর age_restriction। সময়সূচি, দেশ আর ডিভাইসের নিয়ম Creator Pro থেকে পাওয়া যায়। ক্রম বদলানোর সময় শুধু সেই আইডিগুলো পাঠানোই যথেষ্ট যেগুলো সামনে আসবে – বাকি সব লিংক আগের ক্রমে তাদের পরে থাকে। পেজের নয় এমন আইডি API 422 validation_failed দিয়ে প্রত্যাখ্যান করে; details.missing_link_ids-এ সেগুলোর তালিকা থাকে।

শর্ট লিংক

মেথড ও পাথস্কোপউদ্দেশ্য
GET /v1/short-linksread:short_linkslimit, offset, sort আর অনুসন্ধান q সহ শর্ট লিংক; রেসপন্সে total থাকে
POST /v1/short-linkswrite:short_linksতৈরি; আবশ্যক: target_url (http বা https, ৮–২০৪৮); ঐচ্ছিক title (সর্বোচ্চ ১২০) আর custom_slug (৩–৩২, ছোট হাতের অক্ষর, অঙ্ক, হাইফেন)
GET /v1/short-links/{id}read:short_linksএকটি শর্ট লিংক
PATCH /v1/short-links/{id}write:short_linkstarget_url বা title পরিবর্তন
DELETE /v1/short-links/{id}write:short_linksশর্ট লিংক মোছা

প্ল্যানের শর্ট লিংক সীমায় পৌঁছালে API 402 plan_limit_reached দিয়ে উত্তর দেয়।

অ্যাসেট

মেথড ও পাথস্কোপউদ্দেশ্য
GET /v1/assetsread:assetsওয়ার্কস্পেসের অ্যাসেট
POST /v1/assetswrite:assetsফাইল আপলোড (multipart/form-data, ফিল্ড file; ঐচ্ছিক page_id, kind, title, alt_text)
DELETE /v1/assets/{assetId}write:assetsঅ্যাসেট মোছা

ফর্ম

মেথড ও পাথস্কোপউদ্দেশ্য
GET /v1/formsread:formsফর্মগুলো
POST /v1/formswrite:formsফর্ম তৈরি; আবশ্যক: name আর fields (১–১০০টি ফিল্ড)
GET /v1/forms/{id}read:formsএকটি ফর্ম
PATCH /v1/forms/{id}write:formsফর্ম সম্পাদনা
DELETE /v1/forms/{id}write:formsফর্ম মোছা
GET /v1/forms/{id}/summaryread:formsসারসংক্ষেপ
GET /v1/forms/{id}/submissionsread:formsসাবমিশন, নতুনগুলো আগে (limit ১–৫০০, ডিফল্ট ১০০; পরের পেজ cursor = next_cursor দিয়ে)
GET /v1/forms/{id}/submissions/exportread:formsসব সাবমিশন একটি CSV ফাইল হিসেবে, নতুনগুলো আগে, প্ল্যানের এক্সপোর্ট সীমা পর্যন্ত (Creator Pro থেকে); X-Export-Truncated হেডার দেখায় তা কেটে ছোট করা হয়েছে কি না

পরিসংখ্যান

মেথড ও পাথস্কোপউদ্দেশ্য
GET /v1/stats/pages/{id}/summaryread:statsএকটি পেজের মূল সংখ্যা
GET /v1/stats/pages/{id}/timeseriesread:statsএকটি পেজের টাইম সিরিজ
GET /v1/stats/pages/{id}/compareread:statsআগের সময়কালের সাথে তুলনা
GET /v1/stats/pages/{id}/linksread:statsপ্রতি লিংকে ক্লিক
GET /v1/stats/pages/{id}/widgetsread:statsউইজেটে ক্লিক
GET /v1/stats/pages/{id}/conversions/breakdownread:statsএকটি পেজের কনভার্সন
GET /v1/stats/workspaces/me/summaryread:statsসব পেজের মূল সংখ্যা
GET /v1/stats/workspaces/me/timeseriesread:statsসব পেজের টাইম সিরিজ
GET /v1/stats/workspaces/me/compareread:statsআগের সময়কালের সাথে তুলনা
GET /v1/stats/workspaces/me/top-pagesread:statsশীর্ষ পেজ
GET /v1/stats/workspaces/me/conversions/breakdownread:statsওয়ার্কস্পেসের কনভার্সন
GET /v1/stats/workspaces/me/donationsread:donationsসমর্থকদের পেমেন্টের মোট পরিমাণ

সময়কাল বেছে নেন পেজিনেশন-এ যেমন বলা আছে, period দিয়ে অথবা from আর to দিয়ে। কতদিন পেছনে দেখা যাবে তা প্ল্যানের ওপর নির্ভর করে: Creator Pro আর Agency-তে ৩৬৫ দিন, Enterprise-এ ৭৩০ দিন। এর চেয়ে পুরোনো সময়কাল এই সীমা পর্যন্ত কেটে ছোট করা হয়।

পুশ (শুধু পড়া)

মেথড ও পাথস্কোপউদ্দেশ্য
GET /v1/push/historyread:statsপুশ ইতিহাস (limit, offset)
GET /v1/push/usageread:statsসাপ্তাহিক সীমার কতটা ব্যবহার হয়েছে

পুশ নোটিফিকেশন পাঠানো আর পুশ রুল পরিচালনা শুধু ড্যাশবোর্ডেই সম্ভব।

ওয়ার্কস্পেস, টেমপ্লেট আর ডোমেইন

মেথড ও পাথস্কোপউদ্দেশ্য
GET /v1/workspaces/me/entitlementsread:workspacesপ্ল্যানের ফিচার আর সীমা
GET /v1/workspaces/me/usageread:workspacesবর্তমান ব্যবহার
GET /v1/workspaces/me/usage/meteringread:workspacesব্যবহারের ইতিহাস
GET /v1/workspaces/me/membersread:workspacesসদস্য তালিকা
GET /v1/workspaces/me/settingsread:workspacesওয়ার্কস্পেস সেটিংস
GET /v1/workspaces/me/callback-secretsread:workspacesকলব্যাক সিক্রেট (প্লেইন-টেক্সট সিক্রেট ছাড়া)
GET /v1/workspaces/me/callback-secrets/{id}read:workspacesএকটি কলব্যাক সিক্রেট (প্লেইন-টেক্সট সিক্রেট ছাড়া)
GET /v1/templatesread:workspacesসব টেমপ্লেট
GET /v1/templates/availableread:workspacesবৈধ template_key মানসহ বিল্ট-ইন আর সক্রিয় ওয়ার্কস্পেস টেমপ্লেট; ওয়ার্কস্পেস টেমপ্লেটের কী ws:<key> আর type workspace
GET /v1/templates/{key}read:workspacesএকটি টেমপ্লেট
GET /v1/workspaces/me/templatesread:workspacesআপনার নিজের ওয়ার্কস্পেস টেমপ্লেট
GET /v1/workspaces/me/templates/{id}read:workspacesএকটি ওয়ার্কস্পেস টেমপ্লেট
POST, PATCH, DELETE /v1/workspaces/me/templates[/{id}]write:templatesওয়ার্কস্পেস টেমপ্লেট তৈরি, সম্পাদনা, মোছা; html সর্বোচ্চ ৬০,০০০ বাইট (নইলে details.reason maxBytes সহ 422 validation_failed), সর্বোচ্চ ৩২টি asset_slots
GET /v1/domainsread:workspacesকাস্টম ডোমেইন
GET /v1/domains/availableread:workspacesপেজের জন্য উপলব্ধ ডোমেইন

API কী দিয়ে যা পাওয়া যায় না

ওয়েবহুক, কলব্যাক সিক্রেট তৈরি ও পরিচালনা, ইন্টিগ্রেশন, পুশ নোটিফিকেশন পাঠানো, ডোমেইন পরিচালনা, সদস্য, বিলিং আর পেজ মোছা শুধু ড্যাশবোর্ডেই পাওয়া যায়; কলব্যাক সিক্রেটের তালিকা দেখা ও পড়া (প্লেইন-টেক্সট সিক্রেট ছাড়া) read:workspaces দিয়ে কাজ করে। সম্পূর্ণ তালিকা আছে স্কোপের বিস্তারিত-এ। বাইরে থেকে আসা ডেটা – বিক্রি আর আপনার নিজের লাইভ ডেটা – আপনি আলাদা সিক্রেট দিয়ে কলব্যাক-এ বর্ণিত এন্ডপয়েন্টে পাঠান।

কিছু খুঁজে পাননি?

আপনার কী দরকার তা আমাদের জানান, আমাদের সাপোর্ট টিম ব্যক্তিগতভাবে আপনাকে সাহায্য করবে।

সাপোর্টে যোগাযোগ করুন