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

Интеграция проверки номеров за несколько минут

Базовый URL

https://api.zelnum.com/api/v1

Домен API намеренно отделён от домена консоли, чтобы API можно было независимо масштабировать и защищать. Поэтому в примерах используется api.zelnum.com, а панель управления находится на app.zelnum.com.

Аутентификация

Для всех запросов нужен API-ключ в заголовке.

Формат ответа

Все эндпоинты возвращают JSON.

Типичный сценарий

Баланс — GET /v1/balance
Проверка (массив) — POST /v1/detect · POST /v1/detect/file
Статус задачи — GET /v1/tasks/{token}
Ссылка на результат — GET /v1/tasks/{token}/result · GET /v1/tasks/{token}/download

Проверка одного номера в реальном времени

Официальный SDK

Клиент на Python оборачивает эндпоинты этой страницы: типизированные ответы, ключи идемпотентности и скачивание результатов пакетной проверки. Сейчас это единственный официально поддерживаемый SDK — для остальных языков используйте REST API напрямую.

Python — https://github.com/Zelnum/zelnum-python · https://pypi.org/project/zelnum/