Alternative API
v1.0Общее описание
Alternative API совместим с протоколом sms-activate: программы, написанные для него, работают с Onlinesim после
замены адреса на https://onlinesim.io/stubs/handler_api.php. Каждый метод — один GET-запрос на этот адрес;
метод выбирается параметром action:
https://onlinesim.io/stubs/handler_api.php?action=getBalance&api_key={api_key}API дает доступ к двум сервисам Onlinesim: приему SMS от одного сервиса (одноразовые активации) и аренде номеров для приема SMS от любых отправителей.
Список запросов API
Профиль
- getBalance - возвращает баланс Вашего профиля;
- getCountries - возвращает список стран и их ID.
Одноразовые активации
Номер принимает SMS от одного сервиса в течение короткого времени (для большинства сервисов 15 минут). Сервис нельзя сменить во время операции: для другого сервиса закажите новый номер.
- getNumbersStatus - количество доступных номеров по сервисам в стране;
- getNumber - заказывает номер выбранной страны для выбранного сервиса;
- getStatus - возвращает код из полученного SMS;
- getFullSms - возвращает полный текст полученного SMS;
- setStatus - запрашивает следующее SMS или закрывает операцию.
Аренда
Арендованный номер принимает SMS от любых отправителей (включая другие мобильные номера), кроме запрещенных.
- getRentServicesAndCountries - страны, доступные для аренды, количество свободных номеров и цена;
- getRentNumber - арендует номер выбранной страны;
- getRentList - возвращает Ваши активные аренды;
- getRentStatus - возвращает SMS, полученные арендованным номером;
- setRentStatus - закрывает аренду.
getQiwiRequisites принимается для совместимости и всегда отвечает {"status":false}.
Коллекция Postman доступна здесь:
Ответы
- HTTP-статус всегда
200, ошибки передаются в теле ответа. - Текстовые ответы (
text/plain) имеют видKEY:value(ACCESS_BALANCE:12.34) или состоят из одного кода (BAD_KEY). - Ошибки в JSON имеют вид
{"status":"error","message":"<CODE>"}. Ошибки, которые может вернуть любой метод (BAD_KEY,BANNED,BAD_ACTION, лимит), приходят текстом даже в JSON-методах. - Списки в JSON-ответах приходят объектами с ключами
"0","1", …; пустой список —{}. country— ID страны в нумерации sms-activate (idв getCountries, Россия —0), а не телефонный код. Безcountryиспользуется Россия.
Авторизация
API ключ передается в параметре запроса api_key (имя sms-activate), либо в apikey или key, либо в заголовке
Authorization: Bearer — API ключ или OAuth access token. Если передано несколько, используется первый в этом
порядке. Неверный или отсутствующий ключ в api_key дает BAD_KEY. Неверный ключ в apikey, key или
Authorization отклоняется до выполнения метода: HTTP 456 с {"response":"ERROR_WRONG_KEY"}.
Лимиты и кеширование
- getNumber, getRentNumber, setStatus и setRentStatus ограничены 3 запросами в секунду и 150 запросами за
30 секунд на один ключ (на один IP без ключа). При превышении ответ — текст
Too many requests. Please wait a moment before trying again.(HTTP 200). У читающих методов (опрос статуса, списки) своего лимита нет. - Сам сайт допускает 400 запросов в минуту: при превышении ответ — HTTP
429. - Ответы читающих методов (getBalance, getCountries, getNumbersStatus, getRentServicesAndCountries, getRentList, getRentStatus) кешируются на 5 секунд: тот же запрос (те же параметры и ключ), повторенный раньше, получает тот же ответ, включая ошибки. getStatus и getFullSms здесь не кешируются, но состояние операции за ними API Onlinesim кеширует до 5 секунд (новое SMS может появиться с такой задержкой; setStatus=3 показывает следующее SMS сразу). Методы, которые что-то меняют (getNumber, setStatus, getRentNumber, setRentStatus), никогда не кешируются.
Общие ошибки
| Текстовый ответ | Описание |
|---|---|
BAD_KEY |
API ключ неверный или отсутствует |
BANNED |
Аккаунт заблокирован |
BAD_ACTION |
Неизвестный метод или ошибка без собственного кода (например, временная ошибка или слишком много одновременных запросов) |
Too many requests. Please wait a moment before trying again. |
Лимит запросов конвертера |
Коды каждого метода перечислены на его странице.
Условия использования:https://onlinesim.io/documentation/offer
Контакты
- Название: Artem
- Email:support@onlinesim.io
- URL:https://onlinesim.io
Лицензия
Серверы
https://onlinesim.io
Сервер Onlinesim