به مستندات REST API شیزنامبر خوش آمدید. این مستندات برای توسعه‌دهندگانی ارائه شده است که می‌خواهند با سرویس شیزنامبر ارتباط برقرار کرده و از قابلیت‌های ارائه شده در آن بهره ببرند. شیزنامبر یک سرویس فراهم کننده شماره‌های مجازی و کد تائیدیه جهت ورود به سرویس های مختلفی از جمله تلگرام، واتس‌اپ، توییتر و... می باشد.

احزاز هویت

جهت استفاده از خدمات وبسرویس شیزنامبر در ابتدا باید کلید وبسرویس خود را از همین صفحه دریافت کنید سپس قبل از ارسال درخواست به اندپوینت مورد نظر کلید خود را در هدر X-API-KEY درج نمائید

دامنه ی API

دامنه ی تمامی اندپوینت های وبسرویس به شرح زیر می باشد:

api.shiznumber.com/api/

ارسال درخواست

جهت ارسال درخواست مراحل احزاز هویت را انجام دهید سپس اطمینان حاصل فرمائید که در هدر Accept گزینه ی application/json قرار گرفته شده باشد

مثال:

GET https://api.shiznumber.com/api/user HTTP/1.1
Content-Type: application/json
Accept: application/json
X-API-KEY: YOUR API KEY

ارور های احتمالی

دریافت اطلاعات کاربری

GETapi.shiznumber.com/api/user

{
  "user": {
    "id": 2,
    "mobile": "09000000000",
    "created_at": "2022-01-09 19:17:35",
    "balance": 27200
  }
}

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

GETapi.shiznumber.com/api/numbers

[
  {
    "id": 57172,
    "count": 3,
    "price": 64400,
    "operator": "shiz62",
    "icon": "thumbs-up|star",
    "badges": [
      { "key": "thumbs-up", "label": "پیشنهادی", "note": "...", "tone": "good" },
      { "key": "star", "label": "پرطرفدار", "note": "...", "tone": "good" }
    ],
    "country": {
      "name": "Turkey",
      "fa_name": "ترکیه",
      "slug": "turkey",
      "iso_code": "TR",
      "dialing_code": "+90",
      "flag": "..."
    },
    "service": {
      "name": "Facebook",
      "slug": "facebook",
      "fa_name": "فیسبوک",
      "img": "..."
    }
  },
  {
    "id": 57237,
    "count": 4606,
    "price": 42000,
    "operator": null,
    "icon": null,
    "badges": [],
    "country": {
      "name": "Afghanistan",
      "fa_name": "افغانستان",
      "slug": "afghanistan",
      "iso_code": "AF",
      "dialing_code": "+93",
      "flag": "..."
    },
    "service": {
      "name": "Telegram",
      "slug": "telegram",
      "fa_name": "تلگرام",
      "img": "..."
    }
  },
  ...
]

نشان‌های کیفیت شماره

هر شماره دو فیلد اضافه دارد: icon همان مقدار خام و با | جدا شده، و badges که آرایه‌ای از { key, label, note, tone } است. برای نمایش، label را بنویسید و رنگ را از tone بگیرید — این‌طور نشان تازه‌ای که بعداً اضافه شود هم بدون تغییر کد شما درست نمایش داده می‌شود.

دریافت اطلاعات یک شماره

دریافت اطلاعات یک شماره با استفاده از id شماره

GETapi.shiznumber.com/api/numbers/{id}

مثال:

api.shiznumber.com/api/numbers/57172

{
  "id": 57172,
  "count": 3,
  "price": 64400,
  "operator": "shiz62",
  "icon": "thumbs-up|star",
  "badges": [
    { "key": "thumbs-up", "label": "پیشنهادی", "note": "...", "tone": "good" },
    { "key": "star", "label": "پرطرفدار", "note": "...", "tone": "good" }
  ],
  "country": {
    "name": "Turkey",
    "fa_name": "ترکیه",
    "slug": "turkey",
    "iso_code": "TR",
    "dialing_code": "+90",
    "flag": "..."
  },
  "service": {
    "name": "Facebook",
    "slug": "facebook",
    "fa_name": "فیسبوک",
    "img": "..."
  }
}

سفارش شماره مجازی

دریافت شماره و ثبت سفارش با استفاده از id

POSTapi.shiznumber.com/api/numbers/{id}

مثال:

api.shiznumber.com/api/numbers/57172

{
  "message": "شماره مورد نظر با موفقیت سفارش داده شد",
  "order": {
    "id": 34,
    "ordered_number": "923255262",
    "amount": 19500,
    "sms_code": 21341,
    "sms_code_str": "Your account verification code is 21341",
    "code": "SO-XDHJZSO",
    "number": {
      "id": 56107,
      "count": 0,
      "price": 100800,
      "operator": "shiz44",
      "country": {
        "name": "Vietnam",
        "fa_name": "ویتنام",
        "slug": "vietnam",
        "iso_code": "VN",
        "dialing_code": "+84",
        "flag": "..."
      },
      "service": {
        "name": "Telegram",
        "slug": "telegram",
        "fa_name": "تلگرام",
        "img": "..."
      }
    },
    "status": {
      "name": "waiting",
      "fa_name": "در حال انجام",
    },
    "created_at": "1402/06/28 00:27:21",
    "updated_at": "1402/06/28 00:27:52"
  }
}

ریسپانس سفارش

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

ارور های احتمالی

دریافت کد وریفیکیشن سفارش

دریافت کد وریفیکیشن سفارش با استفاده از id سفارش

GETapi.shiznumber.com/api/orders/{id}

مثال:

api.shiznumber.com/api/orders/50

{
  "id": 34,
  "ordered_number": "923255262",
  "amount": 19500,
  "sms_code": 21341,
  "sms_code_str": "Your account verification code is 21341",
  "code": "SO-XDHJZSO",
  "number": {
    "id": 56107,
    "count": 0,
    "price": 100800,
    "operator": "shiz44",
    "country": {
      "name": "Vietnam",
      "fa_name": "ویتنام",
      "slug": "vietnam",
      "iso_code": "VN",
      "dialing_code": "+84",
      "flag": "..."
    },
    "service": {
      "name": "Telegram",
      "slug": "telegram",
      "fa_name": "تلگرام",
      "img": "..."
    }
  },
  "status": {
    "name": "waiting",
    "fa_name": "در حال انجام",
  },
  "created_at": "1402/06/28 00:27:21",
  "updated_at": "1402/06/28 00:27:52"
}

ارور های احتمالی

کنسل کردن سفارش

کنسل کردن سفارش با استفاده از id سفارش

PUTapi.shiznumber.com/api/orders/{id}/cancel

api.shiznumber.com/api/orders/50/cancel

{
  "message": "سفارش با موفقیت لغو و مبلغ آن به کیف پول پس داده شد"
}

گزارش دادن سفارش

گزارش دادن سفارش با استفاده از id سفارش در صورتی که کد دریافت شده غلط باشد

PUTapi.shiznumber.com/api/orders/{id}/report

api.shiznumber.com/api/orders/50/report

{
  "message": "سفارش با موفقیت گزارش و مبلغ آن به کیف پول پس داده شد"
}

دریافت کد مجدد برای سفارش تکمیل‌شده (شماره‌های shiz1)

PUTapi.shiznumber.com/api/orders/{id}/recode

api.shiznumber.com/api/orders/50/recode

{
  "message": "کد جدید دریافت شد",
  "fresh": true,
  "code": "23647",
  "order": { "id": 50, "number": "18457802932", "sms_code": "11741", "sms_code_str": "11741
23647", "can_recode": true, "...": "..." }
}

fresh یعنی کد با کدهای قبلی فرق دارد؛ اگر false باشد، همان کد قبلی برگشته و هنوز کد تازه‌ای صادر نشده است.

لیست سفارشات

GETapi.shiznumber.com/api/orders

[
  {
    "message": "شماره مورد نظر با موفقیت سفارش داده شد",
    "order": {
      "id": 34,
      "ordered_number": "923255262",
      "amount": 19500,
      "sms_code": 21341,
      "sms_code_str": "Your account verification code is 21341",
      "code": "SO-XDHJZSO",
      "number": {
        "id": 56107,
        "count": 0,
        "price": 100800,
        "operator": "shiz44",
        "country": {
          "name": "Vietnam",
          "fa_name": "ویتنام",
          "slug": "vietnam",
          "iso_code": "VN",
          "dialing_code": "+84",
          "flag": "..."
        },
        "service": {
          "name": "Telegram",
          "slug": "telegram",
          "fa_name": "تلگرام",
          "img": "..."
        }
      },
      "status": {
        "name": "waiting",
        "fa_name": "در حال انجام",
      },
      "created_at": "1402/06/28 00:27:21",
      "updated_at": "1402/06/28 00:27:52"
    }
  },
  ...
]

دریافت یک سفارش

دریافت یک سفارش با استفاده از id سفارش

GETapi.shiznumber.com/api/orders/{id}

api.shiznumber.com/api/orders/34

{
  "id": 34,
  "ordered_number": "923255262",
  "amount": 19500,
  "sms_code": 21341,
  "sms_code_str": "Your account verification code is 21341",
  "code": "SO-XDHJZSO",
  "number": {
    "id": 56107,
    "count": 0,
    "price": 100800,
    "operator": "shiz44",
    "country": {
      "name": "Vietnam",
      "fa_name": "ویتنام",
      "slug": "vietnam",
      "iso_code": "VN",
      "dialing_code": "+84",
      "flag": "..."
    },
    "service": {
      "name": "Telegram",
      "slug": "telegram",
      "fa_name": "تلگرام",
      "img": "..."
    }
  },
  "status": {
    "name": "waiting",
    "fa_name": "در حال انجام",
  },
  "created_at": "1402/06/28 00:27:21",
  "updated_at": "1402/06/28 00:27:52"
}

لیست سرویس ها

دریافت لیست سرویس های فعال

GETapi.shiznumber.com/api/services

[
  {
    "name": "Facebook",
    "slug": "facebook",
    "fa_name": "فیسبوک",
    "img": "..."
  },
  {
    "name": "Telegram",
    "slug": "telegram",
    "fa_name": "تلگرام",
    "img": "..."
  },
  {
    "name": "Microsoft",
    "slug": "microsoft",
    "fa_name": "مایکروسافت",
    "img": "..."
  },
  ...
]

دریافت اطلاعات یک سرویس

دریافت اطلاعات یک سرویس با استفاده از slug سرویس

GETapi.shiznumber.com/api/services/{slug}

مثال:

api.shiznumber.com/api/services/telegram

{
  "name": "Telegram",
  "slug": "telegram",
  "fa_name": "تلگرام",
  "img": "..."
}

دریافت شماره های یک سرویس

دریافت شماره های یک سرویس با استفاده از slug سرویس

GETapi.shiznumber.com/api/services/{slug}/numbers

لیست کشور ها

دریافت لیست کشور های فعال

GETapi.shiznumber.com/api/countries

[
  {
    "name": "Afghanistan",
    "fa_name": "افغانستان",
    "slug": "afghanistan",
    "iso_code": "AF",
    "dialing_code": "+93",
    "flag": "..."
  },
  {
    "name": "Angola",
    "fa_name": "آنگولا",
    "slug": "angola",
    "iso_code": "AO",
    "dialing_code": "+244",
    "flag": "..."
  },
  {
    "name": "Argentina",
    "fa_name": "آرژانتین",
    "slug": "argentina",
    "iso_code": "AR",
    "dialing_code": "+54",
    "flag": "..."
  },
  ...
]

دریافت اطلاعات یک کشور

دریافت اطلاعات یک کشور با استفاده از slug کشور

GETapi.shiznumber.com/api/countries/{slug}

مثال:

api.shiznumber.com/api/countries/telegram

  {
    "name": "Afghanistan",
    "fa_name": "افغانستان",
    "slug": "afghanistan",
    "iso_code": "AF",
    "dialing_code": "+93",
    "flag": "..."
},

دریافت شماره های یک کشور

دریافت شماره های یک کشور با استفاده از slug کشور

GETapi.shiznumber.com/api/countries/{slug}/numbers