API документация

API — это протокол, обеспечивающий связь между вашим ПО и нашим сервером активаций.

API необходимо для автоматизации получения смс-сообщений с помощью сервиса SMSBOWER.

Наше API полностью совместимо с сайтами конкурентов.
Все запросы должны идти на https://smsbower.online/stubs/handler_api.php
POST или GET запросом.

Во всех запросах должен присутствовать API ключ в виде параметра 'api_key'

Запрос баланса

https://smsbower.online/stubs/handler_api.php?api_key=$api_key&action=getBalance

Параметры $api_key - Ваш API Ключ

Ответ
ACCESS_BALANCE:остаток на счете

Возможные ошибки
BAD_KEY - неверный API-ключ

Ответ
ACCESS_BALANCE:$yourBalance

Запрос номера

https://smsbower.online/stubs/handler_api.php?api_key=$api_key&action=getN
umber&service=$service&country=$country&maxPrice=$maxPrice
&providerIds=$providerIds&exceptProviderIds$exceptProviderIds
&phoneException$phoneException&ref$ref

Параметры $api_key - Ваш API Ключ $service - сервис для заказа смотрите таблицу $country - страна номера смотрите таблицу $maxPrice - максимальная цена, за которую вы готовы купить номер $providerIds - Список провайдеров, у которых будет осуществляться закупка, через запятую (1,2,3) $exceptProviderIds - Список провайдеров, у которых не будет осуществляться закупка, через запятую (1,2,3) $phoneException - исключающие префиксы для номеров. Указывать через запятую. Формат записи: код страны и от 3 до 6 цифр маски ( например 7918,7900111) $ref - передать реферальный идентификатор Получая номер через API, вы соглашаетесь с правилами проекта

Ответ ACCESS_NUMBER:$activationId:$phoneNumber

Возможные ошибки BAD_KEY - неверный API-ключ BAD_ACTION - некорректное действие BAD_SERVICE - некорректное наименование сервиса

Запрос на получение SMS

https://smsbower.online/stubs/handler_api.php?api_key=$api_key&action=getStatus&id=$id

Параметры $api_key - Ваш API Ключ $id - id активации

Ответ
STATUS_WAIT_CODE - Ожидает СМС STATUS_WAIT_RESEND - Ожидание следующих смс STATUS_CANCEL - Активация отменена STATUS_OK: 'activation code' - смс код получен

Возможные ошибки
BAD_KEY - неверный API-ключ BAD_ACTION - некорректное действие NO_ACTIVATION - id активации не существует

Изменение статуса активации

https://smsbower.online/stubs/handler_api.php?api_key=$api_key&action=setSt
atus&status=$status&id=$id

Параметры $api_key - Ваш API Ключ $id - id активации $status - статус активации

1 - сообщить о готовности номера (смс на номер отправлено) 3 - запросить еще один код (бесплатно) 6 - завершить активацию * 8 - сообщить о том, что номер использован и отменить активацию

Простая логика хронологии работы с API:

Получить номер используя метод getNumber после этого доступны следующие действия: 8 - Отменить активацию (если номер Вам не подошел) 1 - Сообщить, что SMS отправлена (необязательно)

Для активации со статусом 1: 8 - Отменить активацию

Сразу после получения кода: 3 - Запросить еще одну смс 6 - Подтвердить SMS-код и завершить активацию

Для активации со статусом 3: 6 - Подтвердить SMS-код и завершить активацию

Ответ ACCESS_READY - готовность номера подтверждена ACCESS_RETRY_GET - ожидание нового смс ACCESS_ACTIVATION - сервис успешно активирован ACCESS_CANCEL - активация отменена

Возможные ошибки
NO_ACTIVATION - id активации не существует BAD_SERVICE - некорректное наименование сервиса BAD_STATUS - некорректный статус BAD_KEY - неверный API-ключ BAD_ACTION - некорректное действие EARLY_CANCEL_DENIED - Отменить номер возможно спустя 2 минуты после покупки

Получить актуальные цены

https://smsbower.online/stubs/handler_api.php?api_key=$api_key&action=getP
rices&service=$service&country=$country

Параметры $api_key - Ваш API Ключ $service - краткое наименование сервиса (необязательно, по умолчанию все сервисы) смотрите таблицу смотрите таблицу $country - кодовое наименование страны (необязательно, по умолчанию все страны) смотрите таблицу

Ответ
JSON - объект в формате

{''Страна'':
        {''Сервис'':
            {
                ''cost'':Стоимость,'
                'count'':Количество
            }
        }
}

Список сервисов

Список стран

Запрос номераV2

Метод работает аналогично методу getNumber, принимает те же параметры, но возвращает дополнительную информацию об активации.

https://smsbower.online/stubs/handler_api.php?api_key=$api_key&action=getN
umberV2&service=$service&country=$country&maxPrice=$maxPrice
&providerIds=$providerIds&exceptProviderIds=$exceptProviderIds

Параметры api_key - Ваш API Ключ $service - сервис для заказа смотрите таблицу $country - страна номера смотрите таблицу $maxPrice - максимальная цена, за которую вы готовы купить номер $providerIds - Список провайдеров, у которых будет осуществляться закупка, через запятую (1,2,3) $exceptProviderIds - Список провайдеров, у которых не будет осуществляться закупка, через запятую (1,2,3) Получая номер через API, вы соглашаетесь с правилами проекта

Ответ

При успешном запросе ответ будет в формате.


            {
               "activationId": "id",
               "phoneNumber": number,
               "activationCost": activationCost,
               "countryCode": countryCode,
               "canGetAnotherSms": canGetAnotherSms,
               "activationTime": activationTime,
               "activationOperator": activationOperator,
}

Получить полный список цен v2

https://smsbower.online/stubs/handler_api.php?api_key=$api_key&action=getP
ricesV2&service=$service&country=$country

Параметры api_key - Ваш API Ключ $service - сервис смотрите таблицу $country - страна номера смотрите таблицу

Пример ответа


            "страна": {
    "сервис": {
            "цены1": количество,
            "цены2": количество,
            "цены3": количество,
          }
     },

Получить полный список цен v3

https://smsbower.online/stubs/handler_api.php?api_key=$api_key&action=getP
ricesV3&service=$service&country=$country

Параметры api_key - Ваш API Ключ $service - сервис смотрите таблицу $country - страна номера смотрите таблицу

Пример ответа


            "страна": {
    "сервис": {
            "provider 1 id": {
                count: количество,
                price: цены,
                provider_id: provider id,
          },
            "provider 2 id": {
                count: количество,
                price: цены,
                provider_id: provider id,
          },
          "provider 3 id": {
                count: количество,
                price: цены,
                provider_id: provider id,
          },
          }
     },

Возможные ошибки BAD_KEY - неверный API-ключ BAD_ACTION - некорректное действие BAD_SERVICE - некорректное наименование сервиса BAD_COUNTRY - некорректное наименование страны