وب سرویس‌های پی‌پینگ بر پایه استاندارد محبوب REST پیاده‌سازی شده است. برای راحتی برنامه‌نویسان با استفاده از استاندارد OpenAPI3.0 تمام متدها پیاده‌سازی شده است و ابزارهایی را جهت مستند و تست آنها برای شما آماده کرده‌ایم.

مستندات وب‌سرویس‌های پی‌پینگ
Swagger : آموزش استفاده از swagger را Swagger ببینید
Postman : آموزش استفاده از postman را Postman ببینید

Authentication

bearerAuth

در پی‌پینگ برای احراز هویت می بایست authorization هدر را بصورت زیر بر روی درخواست‌هایتان ست کنید :

Authorization : Bearer TOKEN

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

openId

استاندارد openId oAuth2 می‌تواند برای کسب‌وکارهایی که نیاز به دریافت دسترسی از کاربران ‌پی‌پینگ دارند کاربرد مهمی داشته باشد. با اتصال سرویس‌تان به پی‌پینگ می‌توانید کل فرآیند ثبت‌نام کاربرانتان را بر روی پی‌پینگ پیاده‌سازی کنید و احراز هویت کاربرانتان را به ما بسپارید، برای آنها پرداخت بسازید و از گزارش‌های پرداخت آنها در سرویس هایتان استفاده کنید.

نمونه‌هایی که از سرویس هایی که با این استاندارد به پی‌پینگ متصل شده‌اند را در بخش همکاران ما می‌توانید ببینید.

برای آشنایی با این روش می توانید از نحوه دریافت توکن اپلیکیشن (oAuth2) استفاده کنید.

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

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

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