clickSomo
ClickSomo کھولیں

API

کوئی نجی اینڈ پوائنٹ نہیں ہے۔ نہ ہی انٹرفیس کے لیے۔

اکثر مصنوعات کے دو APIs ہوتے ہیں: ایک دستاویزی جو آپ کو پیش کیا جاتا ہے، اور دوسرا دلچسپ جو ان کی اپنی اسکرینیں استعمال کرتی ہیں۔ دوسرا ہمیشہ بہتر ہوتا ہے، اور آپ کو اس کے قریب بھی نہیں پھٹکنے دیا جاتا۔ یہاں صرف ایک ہے، اور انٹرفیس بھی اسی کا کلائنٹ ہے جیسے باقی سب کچھ — جو ہمارے لیے ایک پابندی ہے، اور اسی کی وجہ سے آپ جو کچھ بنانا چاہتے ہیں وہ ممکن ہے۔

اس اصول کی اصل لاگت کیا ہے

اس کا مطلب یہ ہے کہ کوئی اسکرین کبھی کبھی API کے درست ہونے کا انتظار کرتی ہے، بجائے اس کے کہ کسی سہولت بخش فیلڈ کے لیے اس کے گرد سے راستہ بنائے۔ جس دن کسی اسکرین کو کوئی چیز چاہیے ہو جو عوامی API نہیں دے سکتا، اسی دن API غلط ہے، اور اصلاح API میں ہی ہوتی ہے۔

اس کا فائدہ یہ ہے کہ تین بالکل مختلف کلائنٹس کی کوئی اضافی قیمت تقریباً نہیں۔ MCP سرور ایک کلائنٹ ہے۔ dash-b کی ٹائل ایک کلائنٹ ہے۔ آپ کی اپنی اسکرپٹ ایک کلائنٹ ہے۔ ان میں سے کوئی دوسرے درجے کا شہری نہیں جو کسی اور کے لیے بنائی گئی سطح کے گرد کام کر رہا ہو، کیونکہ کوئی دوسری سطح ہے ہی نہیں جس کے پیچھے رہنا پڑے۔

دستاویزی، اور آزمائی ہوئی

OpenAPI /docs پر تیار ہوتا ہے اور ہر روٹ کا ایک ٹیسٹ ہوتا ہے جو دستاویزات کی مثال ہی ہوتا ہے۔ دستاویزات جو کوڈ سے الگ لکھی جائیں ایک ماہ میں پرانی پڑ جاتی ہیں؛ دستاویزات جو غلط ہونے پر بلڈ ناکام کر دیتی ہیں، وہ نہیں پرانی پڑتیں۔

سائن اِن

آپ کا castomo اکاؤنٹ، authorization code flow with PKCE کے ذریعے — وہی اکاؤنٹ جو آپ dash-b اور خاندان کے باقی حصوں کے لیے استعمال کرتے ہیں۔ ایسا صفحہ جس کا اپنا سرور نہ ہو یہ فلو بہت اچھی طرح چلا سکتا ہے؛ یہی اس فلو کا مقصد تھا۔ مشین سے مشین کے کام کے لیے، منصوبے کے دائرے کی API کلید۔

سطحapi.clicksomo.com
  • 1لوگ/v1/contacts · /lists · /segments · /tags · /imports
  • 2مواد/v1/creatives، ہر ہدف کے لیے توثیق، پیش نظارہ اور رینڈر کے ساتھ
  • 3آٹومیشن/v1/funnels · /funnels/:id/versions · /runs · /simulate
  • 4براڈ کاسٹ/v1/campaigns، سامعین، مادی بنانا، شیڈول اور بھیجنا الگ الگ مراحل کے طور پر
  • 5واقعات اندر/v1/events — آپ کی اپنی ایپلیکیشن کے واقعات، محرکات کے طور پر
  • 6ڈیلیوری/sender-identities · /domains · /apps · /webhooks
  • 7اعداد و شمار/v1/reports/*، اور ٹریکنگ ہوسٹ پر /track/*

/docs پر OpenAPIایک ہی عمل پر /mcp

روایات

ہر دوسری castomo سروس جیسی ہی ساخت

جو آواز سے زیادہ اہم ہے۔ اگر آپ ان میں سے کسی ایک کو کال کرتے ہیں، تو آپ پہلے ہی جانتے ہیں کہ یہ کیسے جواب دیتا ہے، کیسے ناکام ہوتا ہے اور کیسے صفحات میں بانٹتا ہے۔

ایک ہی خرابی کا خول

ہر ناکامی کی ایک جیسی شکل ہوتی ہے، ایک مستقل کوڈ اور ایک ایسا پیغام جو انسان کے لیے ہو۔ کوئی روٹ اپنی ناخوشی کا اپنا الگ طریقہ نہیں گھڑتا۔

کرسر صفحہ بندی

آفسیٹس نہیں۔ ایسی فہرست جو آپ کے چلتے وقت بدل رہی ہو خاموشی سے کوئی قطار نہیں چھوڑتی یا دہراتی، جو آفسیٹ صفحہ بندی خاموشی سے اور مسلسل کرتی ہے۔

اڈیپوٹینسی کلیدیں

ہر تبدیلی کرنے والے روٹ پر۔ کوئی درخواست دوبارہ بھیجیں جس کے پہنچنے کا آپ کو یقین نہ ہو، اور وہی جواب ملے گا بجائے دوسرے رابطے، دوسری مہم یا دوسری بھیجی گئی چیز کے۔

منصوبے کے دائرے میں

ایک ٹوکن ایک ٹیننٹ اور ایک منصوبہ، دونوں سے خطاب کرتا ہے۔ قطار کی سطح کی سیکورٹی ڈیٹا بیس میں ہی نافذ ہوتی ہے، کسی شق شامل کرنے کی یادداشت پر نہیں۔

ویب ہکس باہر

دستخط شدہ، بیک آف کے ساتھ دوبارہ بھیجی گئی، اور کم از کم ایک بار پہنچائی گئی — اس لیے آپ کا اینڈ پوائنٹ بھی اڈیپوٹینٹ ہونا چاہیے۔ واقعات وہی ذخیرۂ الفاظ ہیں جو رپورٹس استعمال کرتی ہیں۔

مٹانا اور برآمد کرنا

ایک رابطہ API کے ذریعے برآمد یا مٹایا جا سکتا ہے، اور مٹانے کا اثر خاندان کے اپنے اندرونی راستے سے ہر ہم خیال سروس تک پہنچتا ہے جس کے پاس نقل موجود تھی۔

جو کچھ انٹرفیس کر سکتا ہے، ایک POST وہ سب کر سکتا ہے۔

ایونٹس دلچسپ حصہ ہیں

اس صفحے پر باقی سب کچھ وہ بنیادی ڈھانچہ ہے جس کی آپ توقع کرتے ہیں۔ POST /v1/events وہ راستہ ہے جو اس پروڈکٹ کے مقصد کو بدل دیتا ہے۔

آپ کی ایپلیکیشن پہلے سے وہ چیزیں جانتی ہے جو کوئی مارکیٹنگ ٹول نہیں دیکھ سکتا: کس نے آن بورڈنگ مکمل کی، کس نے ساتھی کو مدعو کیا، کس نے کسی حد کو چھیڑا، کس نے اتوار کی دوپہر کو اپنا ڈیٹا برآمد کیا۔ انہیں اپنے ٹوکن کے ساتھ ایونٹس کے طور پر پوسٹ کریں، اور ہر ایک ایک ٹرگر، ایک شرط اور ایک سیگمنٹ بن جاتا ہے۔

باقی سب کچھ رابطہ ماڈل سے نکلتا ہے۔ ایونٹس شامل کیے جاتے ہیں، کبھی ترمیم نہیں ہوتے؛ یہی وہ لاگ ہے جس پر پوری پروڈکٹ ٹکی ہوئی ہے۔ آپ کے متعین کردہ ایونٹ پر چلنے والا فنل انٹیگریشن نہیں — یہی میکانزم ہے جو message_opened استعمال کرتا ہے، بس اس میں نام مختلف ہے۔

آپ کا ایونٹ فنل بن جاتا ہےapi_event
  • 1آپ اسے پوسٹ کرتے ہیںPOST /v1/events — ایک نام، ایک رابطہ، ایک پے لوڈ، ایک idempotency key۔
  • 2یہ پہنچ جاتا ہےرابطے کے لاگ میں شامل ہو جاتا ہے۔ کسی اور چیز کو یہ جاننے کی ضرورت نہیں کہ یہ موجود ہے۔
  • 3ایک فنل شروع ہوتا ہےہر وہ فنل جس کے داخلے میں اسی ایونٹ کا نام ہے، اپنی انٹری اسپیک کے تحت اہل ہر رابطے کے لیے۔
  • 4دوسرے فنل اس پر منقسم ہوتے ہیں"کیا یہ ایونٹ پچھلے 14 دنوں میں پیش آیا ہے" ایک عام سیگمنٹ شرط ہے۔
  • iاور یہ رنز ختم کرتا ہےاسی ایونٹ کا نام رکھنے والا گول نوڈ اس لمحے سیکوینس روک دیتا ہے جس لمحے شخص وہ کام کرتا ہے۔

آپ کی اصطلاحاتآپ کا ٹوکن

تعمیر شروع کرنے سے پہلے جاننے قابل حدود

ClickSomo آپ کے بارے میں تین شناختیں محفوظ کرتا ہے — ایک ٹیننٹ، ایک پروجیکٹ اور ایک صارف، غیر واضح ids کی صورت میں — اور اس کے سوا کچھ نہیں۔ نہ پاس ورڈ، نہ پروفائل، نہ کارڈ، نہ انوائس۔ پلان کی حدود نمبروں کی صورت میں آتی ہیں: کتنے رابطے، کتنی بھیجی گئی پیغامات، کتنی جنریشنز۔ ادائیگی کی اصطلاحات اس خط کے کسی بھی سمت عبور نہیں کرتیں۔

آپ کے رابطے آپ کے ہیں۔ آپ ڈیٹا کنٹرولر ہیں؛ ہم پروسیسر ہیں۔ کوئی راستہ نہیں جس سے خاندان کی دوسری پروڈکٹ آپ کی رابطہ فہرست پڑھ یا لکھ سکے، اور نہ کوئی انجیسٹ لین ہے جو کوئی استعمال کر سکے۔

اگر آپ اسے سنجیدگی سے جانچ رہے ہیں: اس ویب سائٹ کا مزید کوئی حصہ پڑھنے سے پہلے /docs پڑھیں۔ API پروڈکٹ کے کام کی ایماندارانہ تفصیل ہے، اور ان صفحات کا ہر دعویٰ کسی راستے یا نوڈ کی قسم سے ملتا ہے جو آپ کو وہاں ملے گا۔ جب اسکیمہ بدلتا ہے، یہ صفحات بھی بدلتے ہیں۔