Create a payment
Starts a payment for an authorized customer and returns its trackable identifier.
دانش سرویسها / برای تیمهای پلتفرم و مالکان سرویس
RahDoc
یک مرجع خوانا برای APIهایی که تیم شما میسازد و مصرف میکند.
RahDoc دانش سرویسهای داخلی و خارجی را به مستنداتی تبدیل میکند که بتوان آن را سریع خواند، فهمید و استفاده کرد؛ بدون کنار هم چیدن خروجیهای پراکندهٔ Swagger و یادداشتها.
01مرجع برای هر سرویس
02داخلی و عمومی
APIتمرکز بر مستندسازی
دموی هدایتشده محصول / ۰۰:۳۶
محیط واقعی کار را ببینید؛
نه یک ویدیوی تبلیغاتی.
بازسازی تعاملی رابط فعلی محصول؛ با خطزمان حرکت کنید یا نمایش همهٔ قابلیتهای معرفیشده را بهصورت خودکار ببینید.
00:00
صحنه فعلی: فهرست سرویسها
آنچه محصول پوشش میدهد
قابلیتها؛
همراه با کاربرد.
فهرست سرویسها
برای هر سرویس یک صفحهٔ مشخص با هدف، مالک، نشانی پایه، وضعیت چرخهٔ عمر و endpointهای آن داشته باشید.
خواندن endpoint
متد، مسیر، پارامترها، احراز هویت، نمونهها، پاسخها و حالتهای خطا را کنار هم نگه دارید.
داخلی یا عمومی
دانش درونتیمی را از مستنداتی که برای مصرفکنندگان بیرونی است جدا کنید.
مثال در متن
نمونهٔ درخواست و پاسخ را کنار توضیح نمایش دهید تا خواننده از فهمیدن به پیادهسازی برسد.
ناوبری پایدار
سرویسها، گروهها و endpointها را در یک سلسلهمراتب ثابت پیدا کنید؛ نه میان فایلهای نامرتبط.
مرجع مشترک
از یک سطح مستندات برای تحویل فنی، یکپارچهسازی و آمادهسازی شرکای بیرونی استفاده کنید.
چرخه اصلی کار
از تصمیم
تا خروجی مفید.
سرویس را باز کنید
از Payments API شروع کنید و مالک، مخاطب، نشانی پایه و گروههای endpoint آن را ببینید.
یک endpoint را بخوانید
مسیر POST /payments را با فیلدهای لازم، احراز هویت، درخواست نمونه و پاسخ موفق بررسی کنید.
مخاطب را تغییر دهید
یادداشت عملیاتی داخلی را با مرجع تمیز و عمومی مخصوص شرکا مقایسه کنید.
RAHLAB / مجموعه محصولات متنباز