API رسائی اور تصدیق

SPREEAI منظور شدہ پارٹنر ورک فلوز کے لیے ایک عوامی API حوالہ فراہم کرتا ہے: https://docs.spreeai.com/swagger/public/.

رسائی ماڈل

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

اسناد کے قواعد

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

براؤزر بمقابلہ سرور

ویب SDK پارٹنر کی جاری کردہ براؤزر کنفیگریشن کا استعمال کرتا ہے۔ کلائنٹ کا راز براؤزر میں شامل نہیں ہونا چاہیے۔

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

ویب ہکس

سرور پش ویب ہکس فی الحال شائع شدہ ویب SDK دستاویزات کا حصہ نہیں ہیں۔ اس پر انحصار ڈیزائن کرنے سے پہلے کسی بھی ویب ہک کی ضرورت کی تصدیق کریں۔

ماحولیاتی چیک لسٹ

ماحول کا نام دستاویزی ہے۔
بنیادی URL منظور شدہ حوالہ یا آن بورڈنگ ہینڈ آف سے آیا ہے۔
اس ماحول کے لیے اسناد جاری کی گئیں۔
راز سرور کے اطراف میں محفوظ ہیں۔
[ ] لاگز ٹوکنز اور کسٹمر کی تصویروں کو رد کرتے ہیں۔
تحریری کارروائیوں کے لیے ٹائم آؤٹ، دوبارہ کوششیں، اور آئیڈیمپوٹینسی رویے پر اتفاق کیا گیا ہے۔
پیداوار تک رسائی کے استعمال سے پہلے ایک غیر پیداواری ٹیسٹ کامیاب ہو جاتا ہے۔