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 }
  }
}

getCountries

Возвращает список поддерживаемых стран с идентификаторами и названиями (русское, английское, китайское).

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

Параметры

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

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

Ответ (JSON)

Объект: ID страны → { id, rus, eng, chn, visible, retry, rent, multiService }.

{
  "43": { "id": 43, "rus": "Германия", "eng": "Germany", "chn": "德国", "visible": 1, "retry": 1, "rent": 0, "multiService": 0 },
  "15": { "id": 15, "rus": "Польша", "eng": "Poland", "chn": "波兰", "visible": 1, "retry": 1, "rent": 0, "multiService": 0 }
}

getServicesList

Возвращает список сервисов с кодом и отображаемым названием.

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

Параметры

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

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

Ответ (JSON)

{
  "status": "success",
  "services": [
    { "id": "1", "code": "wa", "name": "WhatsApp" },
    { "id": "2", "code": "tg", "name": "Telegram" }
  ]
}

getBalance

Возвращает текущий баланс аккаунта.

Параметры

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

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

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

ACCESS_BALANCE:12.50

Формат: ACCESS_BALANCE: сумма баланса (число).

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

getNumber

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

Параметры

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

https://api.sim-aggregator.com/stubs/handler_api.php?action=getNumber&key=YOUR_API_KEY&country=43&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, getCountries, getServicesList .

Коды стран

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

Коды сервисов

Используйте код сервиса чтобы заказать необходимый сервис