v1

Получить список доступных сервисов и стран

POST{yourserver}/getServices

Этот запрос отправляется с сервера OnlineSIM на Ваш каждую минуту, чтобы получить количество доступных номеров. Ваш сервер должен вернуть актуальные количества в формате, описанном ниже.

Все запросы v1 - это JSON-запросы POST (Content-Type: application/json) на единый URL Вашей интеграции; метод передается в поле action, Ваш партнерский API ключ - в поле key. Заголовок Authorization не отправляется. Читается только JSON-тело Вашего ответа; его HTTP-код статуса не проверяется.

Тело запроса

Тело запроса от сервера OnlineSIM

Content-Typeapplication/json
Схема
schemaobject
actionstringОбязательный
Имя метода, в данном случае GET_SERVICESПеречисление:GET_SERVICESПример:GET_SERVICES
keystringОбязательный
API ключ Вашего профиля партнера OnlineSIMПример:apikey

Примеры

request

Запрос GET_SERVICES от сервера OnlineSIM

{
  "action": "GET_SERVICES",
  "key": "apikey"
}

Ответы

200Ответ Вашего сервера на GET_SERVICES
Content-Typeapplication/json
Схема
schemaobject
countryListobject[]Список стран с количеством доступных номеров по операторам и сервисам. Неизвестные OnlineSIM страны и сервисы игнорируются; отрицательные количества читаются как 0.Пример:[ { "country": "russia", "operatorMap": { "any": { "vk": 10, "ok": 25, "wa": 52 } } } ]
statusstringОбязательный
SUCCESS с непустым countryList; NO_PROVIDER - сейчас нечего предложить (не считается ошибкой); любое другое значение - ошибкаПеречисление:SUCCESSNO_PROVIDERERRORПример:SUCCESS

Примеры

withAnyСтрок: 25

Количества с оператором any

{
  "countryList": [
    {
      "country": "russia",
      "operatorMap": {
        "any": {
          "vk": 10,
          "ok": 25,
          "wa": 52
        }
      }
    },
    {
      "country": "ukraine",
      "operatorMap": {
        "any": {
          "vk": 10,
          "ok": 50,
          "wa": 132
        }
      }
    }
  ],
  "status": "SUCCESS"
}
perOperatorСтрок: 25

Количества по операторам, без any

{
  "countryList": [
    {
      "country": "ukraine",
      "operatorMap": {
        "life": {
          "vk": 0,
          "ok": 10,
          "wa": 32
        },
        "vodafone": {
          "vk": 10,
          "ok": 10,
          "wa": 0
        },
        "kyivstar": {
          "vk": 0,
          "ok": 30,
          "wa": 100
        }
      }
    }
  ],
  "status": "SUCCESS"
}

Примеры кода

Генерация примеров...