همان طور که شاید تا به حال شنیده باشید API مخفف عبارت Application Programming Interface می‌باشد که به برنامه نویسان امکان رد و بدل کردن اطلاعات مابین پلتفرم های مختلف را از طریق ارسال یک درخواست HTTP(S) ساده و فراخوانی متد های مورد نظر می‌دهد

در واقع REST یک روش ساده و انعطاف پذیری برای استفاده از API است و البته محبوب ترین و پر کاربرد ترین که می‌توان توسط این ساختار از هر کلاینت و پلتفرمی ‌درخواست ساده HTTP(S) را ارسال و پاسخ آن را دریافت نمود. حال فرض کنید در خواست مورد نظر اطلاعات مربوط به ارسال یک پیامک باشد و جواب آن نتیجه و وضعیت پیامک ارسالی باشد.

وب سرویس ارسال پیامک کاوه نگار شماره گیرنده ، متن پیامک و شماره فرستنده را از طریق پارامتر های ورودی در متد GET یا POST دریافت می‌کند و خروجی را در قالب فرمت های XML و JSON برگشت می‌دهد. نکته : اگر با JSON آشنائی ندارید می‌توانید با مراجعه به سایت json.org هم از ساختار فرمت آن مطلع شوید و هم درایور مربوط به زبان برنامه نویسی مورد نظر خود را دریافت نمائید.

پرداخت قبض تنها براي اپراتور ایرانسل کاربرد دارد و در دو مرحله انجام می شود:

• .1 مرحله چک کردن امکان پرداخت قبض و اطلاعات ارسالی، مثل چک کردن موجودي یا اعتبارسنجی درخواست از نظر بیزنسی (بهعنوان مثال، امکان پرداخت قبض همراه اول وجود ندارد).
• .2 مرحله تأیید پرداخت که پرداخت در همین مرحله انجام می شود.

توجه داشته باشید برای احراز هویت در تمامی وب سرویس ها میبایست پارامتر "token" را به صورت های GET,POST,HEADER ارسال نمایید در صورتی که توکن خود را دریافت نکردید از داخل پنل کاربری قسمت پروفایل اقدام به گرفتن توکن نمایید (جهت گرفتن توکن کیلیک کنید)

از این متد برای چک کردن وضعیت ایجاد دستور پرداخت استفاده میشود

آدرس URL

(POST)  https://abrfa.net/webservice/v1/mtn/check

مقادیر ارسالی

پارامتر	موجودیت	نوع	توضیح
tel_num	اجباری	String	شماره ی ایرانسل
amount	اجباری	String	مبلغ درخواستی براي پرداخت قبض به ریال میباشد هر مبلغی که وارد می شود، عیناً از قبض کاربر کسر میگردد و نیازي به دریافت وجه ارزش افزوده از کاربر نمی باشد و می بایست عینا مبلغ وارد شده از کاربر دریافت گردد.
store_name	اختیاری	String	نام فروشگاهی که میخواهید کاربر آن را مشاهده کند

خروجی

خروجی ”id_provider ”بهعنوان ورودي باید در API بعدي که تأیید پرداخت قبض است، وارد گردد.

همان طور که پیش تر گفته شد، این مرحله پس از دریافت ”id_provider ”از API قبلی باید انجام شود.

آدرس URL

(POST)   https://abrfa.net/webservice/v1/mtn/verify

مقادیر ارسالی

پارامتر	موجودیت	نوع	توضیح
provider_id	اجباری	String	کدپیگیری که در ریکوست قبل گرفتید

خروجی

درصورتی که تأیید با موفقیت انجام شود، فیلد ”done ”مقدار 1 خواهد داشت.

براي دریافت گزارش خرید شارژ باید API زیر فراخوانی گردد:

آدرس URL

(POST)   https://abrfa.net/webservice/v1/mtn/getReport

مقادیر ارسالی

پارامتر	موجودیت	نوع	توضیح
page	اختیاری	Integer	شماره صفحه - درصورت خالی بودن مقدار پیشفرض عدد ۱ میباشد
per_page	اختیاری	Integer	مقدار رکورد در هر صفحه - درصورت خالی بودن مقدار پیشفرض عدد 10 میباشد
order_by	اختیاری	String	ترتیب پیشفرض رکوردها که میتواند از مقادیر زیر باشد: Status tel_num ordered_at Amount
sort	اختیاری	String	مرتب سازی پیشفرض رکوردها که میتواند از مقادیر زیر باشد: asc desc

با فراخوانی API زیر می توان وضعیت یک تراکنش مشخص شده با ”id_provider ”را بدست آورد.

آدرس URL

(POST)   https://abrfa.net/webservice/v1/mtn/getStatus

مقادیر ارسالی

پارامتر	موجودیت	نوع	توضیح
provider_id	اجباری	String	توکنی که هنگام تایید تراکنش دریافت کردید