مستندات API پرداخت کرایه تاکسی
در این مقاله ها قصد داریم در مورد مقدمه وب سرویس پرداخت کرایه تاکسی صحبت کنیم.
مقدمه
در این مستند نحوه‌ی کار با API رسید برای دریافت پول توضیح داده شده است.
در بخش آغازین این مستند نحوه‌ی مدیریت درخواست پرداخت (مثل ساختن درخواست پرداخت، جمع‌آوری پول‌های پرداخت شده و ..) و مدیریت پذیرنده‌ها توسط API سمت سروری که در اختیار شما قرار گرفته شده است توضیح داده شده است.
در بخش بعدی نحوه‌ی تعامل با کلاینت رسید برای فرستادن کاربر به درگاه در یک برنامه‌ی اندرویدی توضیح داده شده است.
فرآیند پرداخت
برای دریافت پول از کاربر لازم است مراحل زیر را انجام دهید:
- از سمت سرور خود درخواست پرداختی با مشخصات مورد نظر (قیمت و …) ساخته و شناسه‌ی پرداخت(token) را دریافت کنید.
- شناسه‌ی پرداخت گرفته شده را برای فراخوانی صفحه‌ی به کلاینت خود بفرستید.
- در کلاینت خود صفحه‌ی پرداخت را با شناسه‌ی پرداخت گرفته شده فراخوانی کنید.
- پس از اتمام پرداخت نتیجه را که همان شناسه‌ی پرداخت است، به سرور خود بفرستید.
- شناسه‌ی پرداخت گرفته شده از کلاینت خود را برای نهایی‌سازی پرداخت، به سرور رسید بفرستید و از انجام شدن یا انجام نشدن تراکنش باخبر شوید.
نحوه‌ی استفاده از سرویس
فرمت این API به صورت REST است و پیدا کردن سرویس موردنظر خود با استفاده از استانداردهای REST قابل پیش‌بینی است.
پاسخ همه‌ی سرویس‌ها به صورت یک JSON است که ساختار آن در منوی کناری قابل مشاهده است. در این پاسخ در بخش info تمامی اطلاعات مورد نیاز شما بازگردانده می‌شود. در بخش message پیغامی که توسط انسان قابل خواندن است داده می‌شود که در صورت بروز مشکل توضیحاتی در آن قرار دارد. در بخش errors هم لیستی از خطاهایی که رخ داده است قرار دارد.
همچنین status_code پاسخ درخواست HTTPS شما مطابق با استاندارد HTTP است و از طریق آن می‌توانید از موفق یا ناموفق بودن درخواست خود اطلاع پیدا کنید.
فرمت پاسخ سرور به تمامی درخواست‌ها به صورت یک JSON با ساختار زیر می‌باشد:
{
“message”: “”,
“info”: {},
“errors”: []
}
احراز هویت
برای استفاده از سرویس‌های API شما نیاز به یک (AUTHORIZATION_CODE) دارید که در اختیار شما قرار گرفته است. انتظار می‌رود در تمامی درخواست‌های شما در قسمت Header درخواست این کد را به همراه درخواست خود به شکل زیر بفرستید:
Authorization: $AUTHORIZATION_CODE
شما باید (AUTHORIZATION_CODE$)را با کد احراز هویت خود جایگزین کنید.
curl “https://resid.ir/api/v1/…”
-H “Authorization: $AUTHORIZATION_CODE”
توجه کنید که به جای (AUTHORIZATION_CODE$) کد احراز هویت خود را جایگزین کنید.
در این مقاله در مورد مقدمه وب سرویس پرداخت کرایه تاکسی صحبت کردیم در مقاله بعدی در مورد وب سرویس پرداخت کرایه تاکسی (پذیرنده) صحبت خواهیم کرد.