API ریفرنس

یہ حوالہ صرف حقیقی، عوامی طور پر قابلِ استعمال JSON اینڈ پوائنٹس کی وضاحت کرتا ہے -- ہر اینڈ پوائنٹ کے لیے طریقہ، راستہ، تصدیقِ شناخت کی قسم، لازمی پیرامیٹرز، مثالی Request اور Response نیز دستاویزی خرابی کے کوڈز۔ Zentor میں کوئی عمومی ڈیولپر API کلیدی نظام موجود نہیں ہے؛ رسائی راستے کے لحاظ سے یا تو تصدیقِ شناخت کے بغیر ہوتی ہے یا Origin کی جانچ کے ساتھ ویجیٹ ایمبیڈ ٹوکن کے ذریعے۔ اندرونی ڈیش بورڈ راستے اور Master Admin اینڈ پوائنٹس جان بوجھ کر اس عوامی حوالے کا حصہ نہیں ہیں، کیونکہ وہ صرف باقاعدہ لاگ ان سیشن کے ذریعے قابلِ رسائی ہیں۔

ہر اینڈ پوائنٹ اندراج پر لائیو ٹیسٹ کا ایک نوٹ ہوتا ہے، جو ظاہر کرتا ہے کہ معلومات Registry اسکیما، کسی خودکار ٹیسٹ یا حقیقی لائیو مشاہدے سے حاصل ہوئی ہیں -- کسی کام کرنے والے کوڈ پاتھ سے محض مماثلت کو مکمل ثبوت نہیں مانا جاتا۔ مزید یہ کہ تکنیکی طور پر کامیاب کال ہمیشہ صرف متعلقہ Request کی پراسیسنگ کی تصدیق کرتی ہے، بعد میں ہونے والے عمل جیسے ای میل کی ترسیل، ادائیگی کی تکمیل یا مکمل SSO لاگ ان کی خودکار طور پر نہیں۔

تحفظ متعلقہ گروپ پر منحصر ہے۔ عوامی قانونی، مارکیٹنگ اور فارم اینڈ پوائنٹس کے لیے ڈیش بورڈ سیشن ضروری نہیں۔ اس کے برعکس چیٹ ویجیٹ ہیڈر `X-Widget-Token` اور Origin Allowlist استعمال کرتا ہے۔ ڈیش بورڈ لاگ انز بارہ گھنٹے کی مدت والا سیشن JWT اور سات دن تک درست ریفریش ٹوکن فراہم کرتے ہیں۔ SSO اینڈ پوائنٹس اپنے یک بارہ کوڈز اور کال بیک کے عمل کے ساتھ کام کرتے ہیں۔

ہر اینڈ پوائنٹ صفحے کو ایک خود مختار معاہدے کے طور پر پڑھیں۔ HTTP طریقہ، راستہ، لازمی پیرامیٹرز، ڈیٹا ٹائپس، Request Body، Response کی ساخت، خرابی کے کوڈز اور Idempotency فیصلہ کن ہیں۔ ایک مثال ممکنہ فارمیٹ دکھاتی ہے، لیکن حقیقی جواب کی جانچ کا متبادل نہیں ہے۔ کنفیگریشن کی حالت، توثیقات، اجازتیں اور بیرونی فراہم کنندگان نتیجہ بدل سکتے ہیں۔

پلیٹ فارم کی سطح پر تصدیق شدہ ریٹ لمٹ 15 منٹ میں 2,000 Requests ہے۔ ہر اینڈ پوائنٹ کے لیے الگ حدود ہر جگہ دستاویزی نہیں ہیں۔ اس لیے کلائنٹس کو غیر ضروری طور پر تنگ Polling لوپس استعمال نہیں کرنے چاہئیں۔ غیر idempotent کارروائیوں میں خودکار تکرار دہرے ڈیٹا ریکارڈز یا پیغامات پیدا کر سکتی ہے۔

حساس قدریں لاگز میں شامل نہیں ہونی چاہئیں۔ ان میں پاس ورڈز، ری سیٹ ٹوکنز، تصدیقی کوڈز، ویجیٹ ٹوکنز، سیشن IDs اور حقیقی ذاتی مثالی ڈیٹا شامل ہیں۔ دستاویزات اور ٹیسٹس میں گمنام بنائی گئی قدریں استعمال کریں۔ لائیو ٹیسٹ کے نوٹس کو حقیقی ثبوت درست طور پر بیان کرنا چاہیے۔