شماره آنلاین

مستندات API

در کسری از ثانیه از هر کشوری برای هر اپلیکیشنی ، شماره مجازیتو بگیر !

برای اتصال به API لازم هست از بخش کاربری خود و از منوی آن وارد بخش تنظیمات API شوید و کد Token خودرا دریافت نمایید و با هر زبانی که امکان آن را دارید به سیستم متصل شوید !

شما می توانید نمونه های مربوط به POSTMAN را دریافت کنید و طبق آن برنامه نویسی خودرا تکمیل کنید :

نکته : تمام پاسخ های وب سرویس به صورت json می باشد.

دانلود فایل PostMan دریافت توکن
آدرس وب سرویس
https://shomare.online/api/[ENDPOINT]
لیست اندپوینت ها (EndPoint)
اندپوینت توضیحات آدرس
profile دریافت اطلاعات کاربری ، مثل : باقی مانده شارژ کیف پول و ... https://shomare.online/api/profile
allcountries دریافت لیست کل کشور ها با اطلاعات کامل https://shomare.online/api/allcountries
alloperators دریافت لیست کل اپراتور ها https://shomare.online/api/alloperators
allapplications دریافت لیست کل برنامه ها و سرویس ها https://shomare.online/api/allapplications
pricebycountry دریافت قیمت سرویس ها طبق کد کشور و کد اپراتور https://shomare.online/api/pricebycountry
pricebyproduct دریافت قیمت یک سرویس مشخص با کد کشور،اپراتور و کد سرویس https://shomare.online/api/pricebyproduct
buy خرید شماره جدید https://shomare.online/api/buy
check ارسال درخواست چک کردن جهت دریافت پیامک و مشاهده پیامک https://shomare.online/api/check
cancel ارسال درخواست کنسل کردن شماره و بازگشت وجه https://shomare.online/api/cancel
Header در هر درخواست

در زمان ارسال درخواست به هر اندپوینت ، لازم هست تا احراز درخواست انجام شود.به عبارت ساده تر ، توکن شما باید در Header هر درخواست قرار بگیرد.

نمونه درخواست با استفاده از curl :

curl --location 'https://shomare.online/api/profile' \ --header 'token: test'
پارامتر توضیح
token در header درخواست ارسالی باید قرار بگیرد
دریافت اطلاعات کاربری

آدرس وب سرویس :

نوع درخواست پارامتر ها
GET بدون پارامتر
دریافت لیست کشور ها

آدرس وب سرویس :

نوع درخواست پارامتر ها
GET بدون پارامتر
دریافت لیست اپراتور ها

آدرس وب سرویس :

نوع درخواست پارامتر ها
GET بدون پارامتر
دریافت لیست برنامه ها

آدرس وب سرویس :

نوع درخواست پارامتر ها
GET بدون پارامتر
دریافت قیمت طبق کشور و اپراتور

آدرس وب سرویس :

نوع درخواست پارامتر ها
GET پارامتر کشور و اپراتور

بجای CountryID و Operator ID ، باید کد هایی که از طریق لیست کشور و اپراتور دریافت می کنید ، جایگزین کنید و می توانید قیمت و تعداد سرویس هارا مشاهده کنید.

دریافت قیمت طبق محصول کامل

آدرس وب سرویس :

نوع درخواست پارامتر ها
GET پارامتر کشور ، اپراتور و برنامه

بجای CountryID , OperatorID و AppID ، باید کد هایی که از طریق لیست کشور ، اپراتور و برنامه ها دریافت می کنید ، جایگزین کنید و می توانید قیمت و تعداد سرویس هارا مشاهده کنید.

دریافت شماره جدید

آدرس وب سرویس :

نوع درخواست پارامتر ها
POST پارامتر کشور ، اپراتور و برنامه
بررسی پیام دریافتی

آدرس وب سرویس :

نوع درخواست پارامتر ها
GET ID خرید
کنسل کردن خرید

آدرس وب سرویس :

نوع درخواست پارامتر ها
GET ID خرید
لیست خطاهای قابل دریافت :

در هر درخواست شما یک پارامتر به عنوان status دریافت می کنید ، درصورتی که مقدار آن مخالف true باشد ، به معنای وجود یک خطا در درخواست می باشد و همچنین درصورت false بودن آن مقدار ، یک کد خطا در پارامتر دیگری به اسم code ارسال می شود که با وضعیت http باید برابر باشد و درصورتی که برابر نباشد ، از توضیحات زیر علت آن را می توانید متوجه شوید !

وضعیت HTTP توضیحات
200 درخواست با موفقیت ارسال و انجام شده است !
500 درصورتی که این خطارا در زمان خرید شماره دریافت کردید ، بدان معناست که سرویس دهنده شماره خالی جهت ارائه ندارد و باید کشور یا اپراتور را عوض کنید !
405 نوع ارسال درخواست صحیح نیست ، برای مثال ممکن هست از get استفاده کرده باشید ولی درخواست مجاز post باشد
404 درصورت دریافت خروجی json ، پارامتر های ارسالی در سیستم وجود ندارند یا کامل ارسال نشده اند ولی درصورتی که خروجی json نبود ، endpoint ارسالی صحیح نیست !
403 در هر درخواست ممکن هست Token در Header توسط شما ارسال نشده است
402 موجودی کیف پول شما جهت خرید شماره کافی نیست !
401 توکن ارسال شده در هدر صحیح نیست یا ممکن هست حساب کاربری شما مسدود شده باشد،درصورتی که حساب شما مسدود شده باشد ، در پاسخ مقدار code برابر با -1 خواهد بود، در غیراینصورت مقدار code برابر با وضعیت http می باشد !