API او ادغامونه
د مستند اټکل یا د ماډل روزنې API، ټاکلو باورلیکونو او د کارونې او API اوسنیو مراجعو په کارولو اپلېکېشن ونښلوئ.
- د API محصول وټاکئد اټکل غوښتنې د ماډل روزنې له کاري بهیر څخه جلا کړئ.
- د هغه تړون ولولئاړوند API مستندات او OpenAPI مرجع وکاروئ.
- ټاکلې کلۍ جوړه کړئد پېرودونکي API کلۍ جوړه او خوندي یې وساتئ.
- ادغام او تاییدمستنده غوښتنه ولېږئ او ځواب یې وګورئ.
- څارنه او بدلونکارونه وګورئ او د اړتیا پر مهال کلۍ لغوه یا بدله کړئ.
سم API کاري بهیر وټاکئ
د اټکل API د ماډل د اټکل غوښتنې ترسره کوي؛ د ماډل روزنې API د بیهلیک، دندو، ناستو او فایلونو جلا روزنیز بهیر مستندوي. دا مه انګېرئ چې د اټکل پایټکی روزنه پیلېږي یا د روزنې عملیات د اټکل په تړون کې شته. د خپل مطلوب محصول مستندات ولولئ او تایید کړئ چې ماډل یا روزنیزه وړتیا لړلیک شوې ده. د درېیمګړي له پېژندل شوي SDK څخه د طریقو نومونه مه اټکل کوئ؛ خپرې شوې د غوښتنې او ځواب بڼې وکاروئ.
- وټاکئ چې اپلېکېشن اټکل غواړي که د ماډل روزنه.
- د محصول اړوند مستندات او API مرجع پرانیزئ.
- تایید کړئ چې غوښتل شوې وړتیا او ماډل مستند دي.
API کلۍ جوړه او خوندي کړئ
د ننوتلي API کلۍ له پاڼې د پېرودونکي API کلۍ جوړه کړئ او که انترفېس د اجازو انتخابونه وړاندې کوي، یوازې د ادغام اړینې اجازې وټاکئ. راز یوازې یو ځل ښودل کېږي؛ نېغ یې منل شوي راز-مدیر ته ولېږئ او سرچینې کنټرول ته یې مه سپارئ، لاګونو کې یې مه لیکئ او د براوزر کوډ کې یې مه ښکاره کوئ. که شوني وي، باورلیکونه د اپلېکېشن او چاپېریال له مخې ونوموئ. د پراختیا او تولید لپاره جلا کلۍ وکاروئ څو د یوه لغوه کول نور ادغامونه ګډوډ نه کړي.
- له ننوتلي پېرودونکي کاريځای څخه API کلۍ پرانیزئ.
- د اړتیا وړ تر ټولو محدوده اجازه لرونکې کلۍ جوړه کړئ.
- راز خوندي وساتئ او له سرچینې کوډ او لاګونو یې لرې کړئ.
د مستند تړون له مخې پلي کړئ
د پېژندنې، پایټکي، غوښتنې برخو، ځواب سمبالښت او تېروتنو لپاره اړوند API لارښود تعقیب کړئ. د خدمت باورلیکونه پر باوري سرور وساتئ، نه په عامه مراجع کوډ کې. ورودي معلومات تر لېږلو مخکې تایید کړئ، ناکام ځوابونه په څرګنده اداره او د اجازې سرلیکونه یا حساس prompt معلومات په لاګ کې مه لیکئ. د خپاره شوي ماشيني لوست وړ تړون لپاره OpenAPI مرجع وکاروئ. د مستنداتو له څرګند یاد پرته streaming، رسنۍ یا د برابرونکي ځانګړي عملیات مه انګېرئ.
- د ټاکلي API لپاره یوازې مستند عملیات او برخې پلي کړئ.
- باورلیکونه د سرور خوا وساتئ او د تشخیص له معلوماتو یې پټ کړئ.
- مستندې تېروتنې سمبال او د ورکړل شوي غوښتنې پېژندونکی وساتئ.
کارونه وڅارئ او باورلیکونه اداره کړئ
تر ادغام وروسته د کارونې پاڼه وګورئ څو د حساب فعالیت وپېژنئ او د اپلېکېشن له خپلو ریکارډونو سره یې پرتله کړئ. تر ترافیک زیاتولو یا نوې کلۍ جوړولو مخکې ناڅاپي بدلونونه وڅېړئ. که کلۍ افشا شوې وي، بدله یې کړئ، د اپلېکېشن راز-زېرمه تازه او له پخوانۍ کلۍ لرې کولو مخکې ادغام تایید کړئ. نور نهاړینې کلۍ لغوه کړئ. د کارونې لید د عملیاتو بیاکتنې ملاتړ کوي، خو د راتلونکو فیسونو یا ظرفیت تضمین نه دی.
- د پلاتفورم کارونه د اپلېکېشن له غوښتنو سره پرتله کړئ.
- افشا شوې کلۍ بدله او نوی ارزښت تایید کړئ.
- ناکارېدونکې کلۍ لغوه او لاسرسی منظم وګورئ.
عامې پوښتنې
ایا اټکل او د ماډل روزنه هماغه API ده؟
نه. دا جلا محصولات او بېل مستند کاري بهیرونه لري. د خپلې اړتیا وړتیا لپاره اړونده مرجع تعقیب کړئ.
د ملاتړ شوي API تړون چېرته مومم؟
له دې لارښود سره تړلي د محصول مستندات او OpenAPI مرجع وکاروئ؛ اوسنی خپور شوی انترفېس بیانوي.
API راز چېرته وساتم؟
په خوندي د سرور اړخ راز-مدیر کې. هېڅکله یې زېرمتون ته مه سپارئ، د براوزر کوډ کې مه ښکاره کوئ او لاګ کې یې مه لیکئ.
که کلۍ افشا شي، څه وکړم؟
د API کلۍ له پاڼې یې بدله یا لغوه کړئ، د اپلېکېشن راز-زېرمه تازه او وروستۍ کارونه د نااشنا فعالیت لپاره وګورئ.