Alternative API

Общее описание

Альтернативное API для интеграции с Onlinesim.

Это API позволяет Вам получить доступ ко двум основным услугам Onlinesim: аренде номеров для принятия SMS от множенства различных отправителей (в том числе с других номеров мобильных телефонов), а также прием SMS от одного выбранного сервиса.

Это API доступно только для зарегистрированных пользователей Onlinesim!

Вам необходимо зарегистрировать профиль Onlinesim, чтобы получить доступ к этому API. В этой документации мы будем использовать авторизацию по API ключу для простоты, однако помимо этого доступны и другие методы (более подробно о доступных способах авторизации узнать в разделе "Авторизация").

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

Список запросов

Запросы различаются в зависимости от вида услуги и разбиты по соответствующим подразделам:

Раздел "Профиль"

Данные запросы относятся либо к профилю клиента, либо к обоим предоставляемым Onlinesim услугам одновременно

• getBalance - возвращает текущий доступный баланс Вашего профиля;
• getCountries - возвращает список стран и общую информацию о доступных сервисах.

Раздел "Прием SMS"

Услуга озволяет получить номер для приёма неограниченного количества SMS от одного выбранного сервиса в течение короткого промежутка времени (для большинства сервисов — 15 минут). Пожалуйста, обратите внимание, что Вы не можете менять сервис во время операции. Для приема SMS от разных сервисов, Вам необходимо будет заказать новые номера с соответствующими параметрами.

• getNumbersStatus - запрашивает количество доступных номеров, сгруппированных по странам и сервисам;
• getNumber - заказывает номер выбранной страны для приема SMS от указанного сервиса;
• getStatus - запрашивает список кодов из полученных SMS;
• getFullSms - запрашивает список полученных SMS с полным текстом с указанного номера;
• setStatus - меняет статус операции (отменяет заказ, закрывает операцию и т.д.)

Раздел "Аренда"

Эта услуга предполагает, что номер будет использоваться для приема SMS от множества различных отправителей (включая SMS с других мобильных номеров), за исключением запрещенных.

• getRentServicesAndCountries - запрашивает список стран с доступными для аренды номерами;
• getRentNumber - арендует номер выбранной страны на указанный срок;
• getRentList - возвращает список номеров Вашего профиля с активной арендой;
• getRentStatus - возвращает информацию о текущем статусе арендного номера, а также список полученных сообщений;
• setRentStatus - закрывает операцию аренды.

Коллекция запросов для Postman доступна здесь:

Документация в Postman

Каждый запрос содержит свое описание, тип, URL эндпойнта, параметры, примеры тела запроса и ответа. В описании отдельных запросов также может быть указан список специфичных ошибок, получаемых в виде ответа, которые могут появиться при вызове этих методов. Ответы представлены в JSON или TXT формате в зависимости от вызванного метода и результатов.

Обработка исключений

Общие исключения для методов возвращаются в формате TXT.

TEXT_ERROR

TEXT_ERROR	Описание
BAD_KEY	API ключ неверный или отсутствует
BAD_ACTION	Необрабатываемое исключение