API для партнеров

v1.0

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

Данные API предназначены для текущих и потенциальных партнеров Onlinesim. Они позволяют монетизировать Ваши номера, предоставляя их нашим клиентам для приема SMS от различных сервисов и приложений.

На данный момент реализовано две версии API:

  • v1 подходит партнёрам, у которых уже есть собственная логика работы с номерами. В этой схеме наш сервер обращается к Вашему за информацией о доступных номерах и, если подходящий номер найден, запрашивает его для получения SMS.
  • v2 имеет обратную схему: основная логика операций находится на нашей стороне. Вы периодически передаёте нам список Ваших номеров и пересылаете входящие на них SMS, сами номера при этом сразу же доступны для заказа клиентами.

v1 API

Все взаимодействие происходит через HTTP POST и/или GET запросы между указанным Вами и нашей поддержкой endpoint'ами.

API v1

Требования для v1:

  1. Формат запроса / ответа: JSON4
  2. Кодировка: UTF-8
  3. Убедитесь, что user-agent включен в заголовки запроса
  4. Все запросы / ответы используют метод компрессии gzip
  5. Используемые названия стран и сервисов в ответе GET_SERVICES должны совпадать с соответсвующими списками стран и сервисов
  6. Один номер должен использоваться только для одной операции одновременно: Ваш сервер может выдать этот же номер для другого сервиса только после того, как предыдущая операция будет завершена
  7. Необходимо реализовать функционал для исключения выдачи номеров с определенными масками: если в запросе указана маска исключения, номера с такой последовательностью цифр не должны выдаваться (для запроса GET_NUMBER)
  8. Webhook PUSH_SMS: Ваш сервер должен автоматически пересылать SMS, полученные номерами с активными операциями, на сервер Onlinesim
  9. Фильтрация может производиться как на нашей, так и на Вашей стороне. Перед интреграцией сообщите, какой из вариантов является предпочтительным для Вас
  10. Выдача номера должна производиться в течение 10 секунд с момента получения запроса GET_NUMBER (и GET_NUMBER (RENT)), в противном случае заказ номера отменяется

Чек-лист для интеграции:

  1. Необходимо реализовать 3 метода и webhook:

    GET_SERVICES - запрашивает у Вашего сервера количество номеров по странам и сервисам

    GET_NUMBER - резервирует номер на короткий срок (по умолчанию 15 минут) с указанными параметрами для приема SMS от определенного сервиса за указанную сумму

    PUSH_SMS (webhook) - при получении SMS зарезервированным номером, Ваш сервер отправляет их к нам на сервер

    FINISH_ACTIVATION - закрывает операцию с определенными параметрами (в зависимости от результата)

  2. Написать нам на e-mail или в Telegram для создания профиля партнера, предоставления URL для запросов с нашей стороны, получения ссылки для webhook'a и тестирования номеров.
  3. После успешно проведенных тестов Ваши номера будут доступны нашим клиентам в течение нескольких часов

v2 API

Reseller API v2 дает возможность интегрировать Ваше оборудование и номера для их последующего использования клиентами под прием SMS через наш сайт. Мы постарались сделать его настолько простым для интеграции, насколько это возможно. Для начала работы вам необходимо:

  1. Реализовать 2 метода:

  • sendNumbersOnline - передает список Ваших номеров к нам на сервер, данный запрос должен отправляться каждые 5 минут для обновления списка номеров и как подтверждение аптайма Вашего сервера;

  • пересылка входящих SMS на наш сервер — addMessage (по одному сообщению) или addMessages (пакетно).

  1. Связаться с поддержкой, чтобы получить _SERVER_URL_
  2. Остальные запросы опциональны, реализовывать их необязательно, но их описание доступно в документации.
  3. У запросов есть необязательный параметр test, который может быть использован для тестирования. Он может принимать значения test1 и test2, будучи равным первому, он позволит запросу дойти до сервера, однако не вызовет исполнения функции. Если ему задать значение test2, то он вернет тело Вашего запроса в ответе. Параметр можно передавать как в строке запроса (например, для методов GET), так и в качестве поля в его теле (например, для методов POST) - оба варианта валидны.

После того как Вы получите ответ об успешно выполненном запросе sendNumbersOnline, свяжитесь с партнерской поддержкой, чтобы сотрудники проверили, получает ли наш сервер сообщения с помощью запросов addMessage или addMessages. В случае успеха Ваши номера будут доступны нашим клиентам уже через несколько часов.

Приложения

Схема процесса workflow

Terms of Service: https://onlinesim.io/documentation/offer

Контакты

Лицензия

GNU General Public License, version 3.0

Серверы

{yourserver}

URL Вашего сервера

Переменные:

Название По умолчанию Перечисление Описание
yourserver https://{yourserver.com} --- ---