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

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

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

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

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

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

برای دریافت لیست سفارش‌ها یا همان اردربوک بازارهای مختلف، از این درخواست استفاده نمایید:

آدرس URL

(GET)  https://abrfa.net/webservice/v1/crypto/price.json?srcCurrency=btc&dstCurrency=rls

خروجی

{
    "status": "ok",
    "lastUpdate": 1644991756704,
    "bids": [
        ["1476091000", "1.016"],
        ["1479700000", "0.2561"]
    ],
    "asks": [
        ["1470001120", "0.126571"],
        ["1470000000", "0.818994"]
    ]
}

برای دریافت آمار بازارهای جهانی از این نوع درخواست استفاده نمایید:

آدرس URL

(GET)   https://abrfa.net/webservice/v1/crypto/globalStats.json

خروجی

{
    "ltc": {
        "kraken": {
            "price": "41.69"
        }
    },
    "btc": {
        "kraken": {
            "price": "5517.2"
        }
    },
    ...

    "status": "ok"
}