ہر وہ اینڈپوائنٹ جو آپ API کلید کے ساتھ استعمال کر سکتے ہیں – حصوں کے لحاظ سے، میتھڈ، پاتھ، مطلوبہ اسکوپ اور کام کے ساتھ۔
یہ جائزہ ہر اس اینڈپوائنٹ کی فہرست دیتا ہے جو API کلید کے ٹوکن کے ساتھ کام کرتا ہے۔ تمام پاتھس https://dock.at-harbor.com سے شروع ہوتے ہیں۔ ہر اینڈپوائنٹ کی درست فیلڈز https://dock.at-harbor.com/openapi.yaml پر OpenAPI تفصیل میں ہیں۔
کم از کم ایک: config (JSON کے طور پر زیادہ سے زیادہ 64 KB، ہر متن 5,000 حروف تک)، theme_config، custom_css (50,000 حروف اور 65,535 بائٹس تک)، seo، template_key، template_asset_bindings
جو اقسام آپ بنا سکتے ہیں: 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 بائٹس ہو سکتے ہیں۔
لنک بنانا؛ ضروری: 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 (ملک کا قاعدہ، mode allowlist یا denylist اور countries کے ساتھ)، device (ہر ڈیوائس کے لیے الگ ہدف)، starts_at اور ends_at (شیڈولنگ)، protection_tier (بوٹ سے تحفظ) اور age_restriction۔ شیڈولنگ، ملک اور ڈیوائس کے قواعد Creator Pro سے دستیاب ہیں۔ ترتیب بدلتے وقت صرف وہ IDs بھیجنا کافی ہے جنہیں آگے آنا ہے – باقی تمام لنکس اپنی پچھلی ترتیب میں پیچھے آتے ہیں۔ API ایسی IDs کو جو صفحے سے تعلق نہیں رکھتیں 422 validation_failed کے ساتھ مسترد کرتا ہے؛ details.missing_link_ids میں ان کی فہرست ہوتی ہے۔
مدت آپ پیجینیشن میں بیان کردہ طریقے سے چنتے ہیں، period کے ساتھ یا from اور to کے ساتھ۔ آپ کتنا پیچھے دیکھ سکتے ہیں یہ پلان پر منحصر ہے: Creator Pro اور Agency میں 365 دن، Enterprise میں 730 دن۔ پرانی مدتیں اس حد تک کاٹ دی جاتی ہیں۔
درست template_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
ویب ہُکس، انٹیگریشنز، پش نوٹیفکیشنز بھیجنا، ڈومینز کا انتظام، ممبرز، بلنگ اور صفحات حذف کرنا صرف ڈیش بورڈ میں دستیاب ہیں۔ کال بیک سیکرٹس بھی صرف ڈیش بورڈ میں بنائے اور سنبھالے جا سکتے ہیں؛ ان کی فہرست اور انہیں پڑھنا (سادہ متن والے سیکرٹ کے بغیر) read:workspaces کے ساتھ ہوتا ہے۔ مکمل فہرست اسکوپس تفصیل سے میں ہے۔ آنے والا ڈیٹا – فروخت اور آپ کا اپنا لائیو ڈیٹا – آپ الگ سیکرٹس کے ساتھ ان اینڈپوائنٹس پر بھیجتے ہیں جو کال بیکس میں بیان کیے گئے ہیں۔
