مقدمه API درگاه پرداخت پی پینگ

shape
shape
shape
shape
shape
shape
shape
shape

مقدمه راهنما وب سرویس درگاه پرداخت پی پینگ

در این مقاله قصد داریم در مورد مقدمه API درگاه پرداخت پی پینگ صحبت خواهیم کرد.

مقدمه

تمامی وب‌ سرویس‌های توضیح داده شده در این مستندات به صورت RESTful هستند و طبق همین چهارچوب باید با آنها ارتباط برقرار کرد.
جهت رفع هرگونه مشکل و یا پرسش با پشتیبانی در تماس باشید.

POSTMAN

برای راحتی کار شما فایل postman سرویس ها برای شما آماده شده است که می توانید از لینک زیر آن را دانلود کنید و با استفاده از اپلیکیشن دسکتاپ postman از آن استفاده کنید

دانلود قالب postman

توضیحات تکمیلی برای تمام سرویس‌ها

برای فراخوانی سرویس‌های صفحه‌بندی (pagination) اگر پارامتر ورودی ارسال نشود، حداکثر ۱۰ آیتم نمایش داده می‌شود و همچنین حداکثر تعداد دریافت آیتم به ازای هر درخواست ۵۰ عدد می‌باشد و بیشتر از آن را سرویس پشتیبانی نمی‌کند و در صورت نیاز به بارگزاری تمام آیتم‌های یک سرویس به صورت یکجا با ایمیل به بخش پشتیبانی در تماس باشید. همینطور توجه داشته باشین واحد پول در تمام سرویس‌ها تومان می‌باشد و منطقه زمانی تمامی‌ تاریخ و ساعت‌ها برابر با ساعت جهانی یا UTC می‌باشد.

نکاتی برای آپلود فایل‌ها

برای آپلود هرگونه فایل اعم از عکس پروفایل کاربران و یا گزارشات پرداخت‌ها و … می‌بایست که از سرویس بارگذاری فایل استفاده کنید.

پس از انجام عملیات آپلود توسط سرویس بارگذاری فایل، تنها کافیست نام فایل آپلود شده که در خروجی سرویس به شما برگردانده می‌شود را ذخیره نمایید

جدول کدهای دریافتی از هر سرویس

بعد از ارسال هر درخواست به سمت سرور، از سمت ما طبق قواعد وب‌سرویس‌های RESTful یک کدی به شما بازگرداننده می‌شود. هر کد معنایی دارد که در جدول زیر توضیحات مربوطه را می‌بینید

شماره کد توضیحات
200 عملیات با موفقیت انجام شد
400 مشکلی در ارسال درخواست وجود دارد
500 مشکلی در سرور رخ داده است
503 سرور در حال حاضر قادر به پاسخگویی نمی‌باشد
401 عدم دسترسی
403 دسترسی غیر مجاز
404 آیتم درخواستی مورد نظر موجود نمی‌باشد

Authentication

Bearer
برای احراز هویت در سرویس‌های مختلف باید از توکن Bearer در header درخواست‌ها به صورت زیر استفاده کنید

ساختار ارسال توکن: (Bearer TOKEN)

اگر شما یک اپلیکیشن و یا وب‌سایت شخصی دارید و قصد استفاده از سرویس‌های مالی ما را برای خود دارید می‌بایست از access token استفاده کنید، جهت مطالعه روند دریافت آن از کنسول توسعه‌دهنده، لطفا اینجا کلیک نمایید.

Security scheme type: API Key
header parameter name: Authorization

oauth2
اما اگر وب‌سایت و اپلیکیشن شما قصد دسترسی به اطلاعات سایر کاربران پی‌پینگ را دارد، شما می‌بایست از سرویس OAuth ما استفاده کنید که به شما اجازه یک احراز هویت امن با استفاده از یک متد استاندارد و ساده به اپلیکیشن‌های وب، موبایل و دسکتاپ میدهد. جهت مطالعه روند اعطای دسترسی و روند کار لطفا اینجا کلیک نمایید.

Security scheme type: OAuth2
authorizationCode OAuth Flow Authorization URL: https://oauth.payping.ir/connect/authorize

Token URL: https://oauth.payping.ir/connect/token

Scopes:

  • profile – دسترسی مرتبط با تمام اطلاعات یک کاربر
  • email – دسترسی به مشاهده ایمیل
  • nationalcode – دسترسی به مشاهده کدملی کاربر
  • birthday – دسترسی به مشاهده تاریخ تولد کاربر
  • shaba – دسترسی به مشاهده شبای بانکی کاربر
  • phone – دسترسی به مشاهده شماره تماس کاربر
  • pay:read – دسترسی فقط خواندنی در سرویس پرداخت
  • pay:write – دسترسی نوشتن و تغییرات در سرویس پرداخت
  • product:read – دسترسی فقط خواندنی در سرویس آیتم‌های مالی
  • product:write – دسترسی نوشتن و تغییرات در سرویس آیتم‌های مالی
  • customer:read – دسترسی فقط خواندنی به سرویس مشتریان
  • customer:write – دسترسی نوشتن و تغییرات در سرویس مشتریان
  • invoice:read – دسترسی فقط خواندنی به سرویس فاکتور ها
  • invoice:write – دسترسی نوشتن و تغییرات در سرویس فاکتور ها
  • upload:write – دسترسی مرتبط با سرویس بارگذاری فایل‌ها

در مقاله های بعد در مورد راهنمای استفاده وب سرویس پرداخت پی پینگ و  وب سرویس پرداخت درگاه اینترنتی پی پینگ صحبت خواهیم کرد

منبع

پاسخی بگذارید

نشانی ایمیل شما منتشر نخواهد شد. بخش‌های موردنیاز علامت‌گذاری شده‌اند *