SIM Aggregator API - Документация

Регистрация и API-ключ

Для использования API необходимо:

1. Зарегистрировать аккаунт на sim-aggregator.com.
2. Получить API-ключ в настройках профиля (раздел настроек аккаунта).

API-ключ дает доступ к платным операциям (заказ номеров, проверка статусов и т.д.). Храните ключ в секрете и не передавайте третьим лицам.

Базовый URL

Все API-запросы отправляются на endpoint:

https://api.sim-aggregator.com/stubs/handler_api.php

Поддерживается метод GET . Название метода передается в параметре action .

getPrices

Получить актуальные цены и количество доступных номеров по странам и сервисам.

Запрос: API-ключ не требуется.

Параметры

Пример запроса

https://api.sim-aggregator.com/stubs/handler_api.php?action=getPrices

Ответ (JSON)

Структура: { "Country_Code": { "Service_Code": { "cost": "Price", "count": Quantity } } }

{
  "1": {
    "wa": { "cost": "0.50", "count": 100 },
    "tg": { "cost": "0.71", "count": 250 }
  },
  "0": {
    "wa": { "cost": "0.45", "count": 50 }
  }
}

getNumber

Заказать номер для приема SMS.

Параметры

Пример запроса

https://api.sim-aggregator.com/stubs/handler_api.php?action=getNumber&key=YOUR_API_KEY&country=1&service=wa

Успешный ответ (текст)

ACCESS_NUMBER:12345:380991234567

Формат: ACCESS_NUMBER: ID активации : номер телефона с кодом страны.

Возможные ошибки

setStatus

Изменение статуса заказа (запросить еще SMS, завершить или отменить активацию).

Параметры

Значения статуса

Пример запроса

https://api.sim-aggregator.com/stubs/handler_api.php?action=setStatus&key=YOUR_API_KEY&activationId=12345&status=6

Ответы

getStatus

Проверить текущий статус заказа (получено ли SMS и код).

Параметры

Пример запроса

https://api.sim-aggregator.com/stubs/handler_api.php?action=getStatus&key=YOUR_API_KEY&activationId=12345

Ответы

Пример успешного ответа с кодом

STATUS_OK:123456

Типовые ошибки

Сводка методов

Коды стран и список сервисов доступны на сайте или из ответа getPrices .

Коды стран

Используйте параметр country в API-запросах с указанными ниже числовыми ID. Этот список соответствует CountryMap в API.