برای استفاده از وب سرویس استعلام و پرداخت قبوض، لازم است که شما ابتدا در سایت ره پی، عضو شوید. برای این منظور از اینجا در ره پی ثبت نام کنید. سپس لازم است از منوی خدمات و زیر منوی "پکیج ها و سرویس های خریدنی"، بسته ی سرویس استعلام و پرداخت قبوض را انتخاب کرده و نسبت به پرداخت هزینه ی آن اقدام نمایید. بعد از انجام پرداخت و تایید ادمین ره پی، به کاربر شما، یک client_id و client_secret اختصاص داده خواهد شد. این مقادیر در پنل شما برای شما قابل مشاهده خواهد بود.

وب متدهای توسعه داده شده در ره پی، معمولا از یک روش یکسان برای احراز هویت در سطح وب متد استفاده می کند. این احراز هویت، همان استاندارد OAuth2 است و پیاده سازی آن برای مشتریان طرف سوم آسان و ساده است. تنها کافی است که فایل حاوی وب متدها را که در قالب کالکشن Postman است، دانلود کنید تا تمام متدها و پارامترهای لازم برای این موارد را مشاهده نمایید.

فایل کالکشن پستمن

استعلام قبض

فایل مورد نیاز برای بررسی وب متدهای لازم برای استفاده از استعلام قبوض را از اینجا دانلود کنید. برای استفاده از این فایل لازم است که نرم افزار پستمن نصب باشد و فایل در آن import شود.

برای استعلام یک قبض، ابتدا با استفاده از متد https://rahpay.net/oauth/token و دو پارامتری که در بالا توضیح داده شد، ابتدا یک توکن دریافت کرده و با استفاده از این توکن، متد استعلام را در نشانی https://rahpay.net/api/third_party/billing_inquiry صدا بزنید. لازم است توکن دریافتی را در تب Auth و با Type=OAuth 2.0 و در آرگومان Access Token قرار داده و بعد از آن متد دوم، را صدا بزنید. این متد، آرگومان های متعددی برای انواع قبض دارد که عبارتند از:

        
            // پارامترهای لازم برای صدا زدن متد احراز هویت
            {
                "grant_type": "client_credentials",
                "client_id": "بعد از ثبت نام در سایت، این پارامتر به شما داده می شود.",
                "client_secret": "بعد از ثبت نام در سایت، این پارامتر به شما داده می شود.",
                "scope": "third-party-billing-inquiry",
            },

            // پارامترهای لازم برای صدا زدن متد استعلام قبض
            {
                "type": "MobileNow|Water|Electricity|انواع گوناگون دارد و بر اساس نوع قبض متفاوت است. برای مشاهده مقادیر قابل قبول به توضیحات موجود در پستمن توجه کنید.",
                "parameter": "انواع گوناگون دارد و بر اساس نوع قبض متفاوت است. برای مشاهده مقادیر قابل قبول به توضیحات موجود در پستمن توجه کنید.",
            },
        
    

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

پرداخت قبض

فایل مورد نیاز برای بررسی وب متدهای لازم برای استفاده از پرداخت قبوض را از اینجا دانلود کنید. برای استفاده از این فایل لازم است که نرم افزار پستمن نصب باشد و فایل در آن import شود.

برای پرداخت یک قبض، ابتدا با استفاده از متد https://rahpay.net/oauth/token و دو پارامتری که در بالا توضیح داده شد، ابتدا یک توکن دریافت کرده و با استفاده از این توکن، متد استعلام را در نشانی https://rahpay.net/api/third_party/webservice/bill_payment صدا بزنید. لازم است توکن دریافتی را در تب Auth و با Type=OAuth 2.0 و در آرگومان Access Token قرار داده و بعد از آن متد دوم، را صدا بزنید. این متد، آرگومان های متعددی برای انواع قبض دارد که عبارتند از:

            
                // پارامترهای لازم برای صدا زدن متد احراز هویت
                {
                    "grant_type": "client_credentials",
                    "client_id": "بعد از ثبت نام در سایت، این پارامتر به شما داده می شود.",
                    "client_secret": "بعد از ثبت نام در سایت، این پارامتر به شما داده می شود.",
                    "scope": "payment-billing-inquiry",
                },
    
                // پارامترهای لازم برای صدا زدن متد پرداخت قبض
                
                {
                    "Bills":[
       
                        {
                            "BillID":"شناسه قبض",
                            "PaymentID":"شناسه پرداخت بدون صفر"
                        }
                    ]
       
                 }
            
        

توجه داشته باشید که متد بالا از نوع post هستند.

برای پرداخت قبض باید مقدار پارامتر ارسالی را در body به عنوان row و با فرمت JSONقرار بدهید. خروجی متد بالا یک لینک پرداخت قبض می باشد که کلیلک بر روی لینک قادر به پرداخت قبض خود می باشید.

توجه:در وب متد پرداخت قبض امکان پرداخت چندین قبض امکان پذیر است.تنها کافی است شناسه قبض و شناسه پرداخت قبض ها را مانند زیر به صورت آرایه در body وارد نمایید.

            
              
                {
                    "Bills":[
       
                        {
                            "BillID":"1شناسه قبض",
                            "PaymentID":"شناسه پرداخت1 بدون صفر"
                        },
                        {
                            "BillID":"2شناسه قبض",
                            "PaymentID":"شناسه پرداخت2 بدون صفر"
                        },
                        ......

                    ]
       
                 }