Описание API

API - это протокол взаимодействия между вашим ПО и нашим сервером активаций.

API нужен для того, чтобы автоматизировать процесс получение смс сообщений на вашей стороне.

Для работы с API необходимо использовать ваш API ключ, получить его можно зайдя на страницу профиля

Наше ПО полностью совместимо с сайтами конкурентов.

Разрешается не более 20 подключения в секунду с одного IP-адреса.

Описание протокола

Все запросы должны идти на URL http://sms-get.co/stubs/handler_api.php

POST или GET методом.

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


Общие ошибки:
BAD_KEY - Неверный API-ключ
ERROR_SQL - Ошибка SQL-сервера(или просто ошибка сервера)

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

http://sms-get.co/stubs/handler_api.php?api_key=$api_key&action=getNumbersStatus

Параметры:
$api_key - ключ АПИ

Ответ сервиса будет в json формате, пример:
{"vk_0":"20", "ok_0":"24", "wa_0":"22", "vi_0":"19", "tg_0":"32", "wb_0":"11", "go_0":"17", "av_0":"3", "av_1":"30", "fb_0":"31"}

Где до черточки - название сервиса, после обозначение нужно ли включать переадресацию. 0 - не включать. 1 - включать.

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

http://sms-get.co/stubs/handler_api.php?api_key=$api_key&action=getBalance

$api_key - ключ АПИ

Ответ сервиса:

ACCESS_BALANCE:$balance (где $balance - баланс на счету)

Заказ номера

http://sms-get.co/stubs/handler_api.php?api_key=$api_key&action=getNumber&service=$service&ref=$ref

$api_key - ключ АПИ

$service - сервис для заказа

$ref - реферальный идентификатор. Подробнее.

Список доступных сервисов:

vk(ВКонтакте)
ok(Одноклассники)
ya(Яндекс)
wb(WeChat)
oi(Nimses)
fb(Facebook)
mm(Microsoft)
tg(Telegram)
ig(Instagram)
tw(Twitter)
ma(Mail.ru)
mb(Yahoo)
av(Avito)
ym(Юла)
fi(Fifa)
go(Google,Youtube,Gmail)
kp(Tencent QQ)
ub(Uber)
vi(Viber)
sp(Spaces)
ot(Другой сервис)

Получая номер через API вы подтверждаете согласие с правилами проекта

Ответы сервиса:
NO_NUMBERS - нет номеров
NO_BALANCE - закончился баланс
ACCESS_NUMBER:$id:$number - номер выдан ($id - id операции,$number - номер телефона)

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


Примечания:
Ошибка NO_NUMBERS будет так же возвращена в случае, если нету свободной GSM лини.
Так что если getNumbers вернул список, а при запросе выпала ошибка NO_NUMBERS, то просто попробуйте повторить запрос позже.

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

http://sms-get.co/stubs/handler_api.php?api_key=$api_key&action=setStatus&status=$status&id=$id

$api_key - ключ АПИ

$id - id активации

$status - статус активации:

-1 - отменить активацию

1 - сообщить о готовности номера (смс на номер отправлено)

3 - запросить еще один код (бесплатно)

6 - завершить активацию(если был статус "код получен" - помечает успешно и завершает, если был "подготовка" - удаляет и помечает ошибка, если был статус "ожидает повтора" - переводит активацию в ожидание смс)

8 - сообщить о том, что номер использован и отменить активацию

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

Возможные ошибки:
NO_ACTIVATION - id активации не существует или не задан
BAD_SERVICE - некорректное наименование сервиса
BAD_STATUS - некорректный статус
BAD_ACTION - некорректное действие

Получить состояние активации

http://sms-get.co/stubs/handler_api.php?api_key=$api_key&action=getStatus&id=$id

$api_key - ключ АПИ

$id - id активации

Ответы сервиса:
STATUS_WAIT_CODE - ожидание смс
STATUS_WAIT_RETRY:$lastcode - ожидание уточнения кода (где $lastcode - прошлый, неподошедший код)
STATUS_WAIT_RESEND - ожидание повторной отправки смс (софт должен нажать повторно выслать смс и выполнить изменение статуса на 6)
STATUS_CANCEL - активация отменена
STATUS_OK:$code - код получен (где $code - код активации)

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