Обзор API NN Agent
Базовый адрес: https://api.nexifyneo.com
Что доступно через API#
| Группа | Что делает | Страница |
|---|---|---|
| Клиент и лицензии | Данные учётной записи, активация и продление лицензий | Ниже на этой странице |
| Аккаунты и сессии авторизации | Подключение и отключение аккаунтов мессенджеров | Аккаунты |
| Кампании, контакты, пул сообщений | Сборка исходящей кампании | Кампании и контакты |
| Диалоги | Чтение переписки и отправка сообщений | Диалоги |
| Парсер | Сбор участников и проверка сущностей | Парсер |
Всего опубликованная спецификация объявляет 96 операций: 35 в версии v2, 60 в версии v1 и служебная проверка состояния.
Версии v1 и v2#
v2 — текущая версия. Она построена по ресурсной схеме: сущность в пути, действие в HTTP-методе. v1 осталась от предыдущего поколения, где действие вынесено в путь.
| Задача | v1 | v2 |
|---|---|---|
| Список кампаний | GET /v1/campaign_list/{client_id} |
GET /v2/campaigns |
| Создать кампанию | POST /v1/create_campaign |
POST /v2/campaigns |
| Обновить кампанию | POST /v1/update_campaign |
POST /v2/campaigns/{campaign_id}/update |
| Удалить кампанию | DELETE /v1/campaign |
DELETE /v2/campaigns/{campaign_id} |
| Отправить сообщение | POST /v1/accounts/{account_id}/dialogs/send |
POST /v2/accounts/{account_id}/dialogs/{peer_user_id}/messages |
| Загрузить контакты | POST /v1/contacts/upload/csv и /excel |
POST /v2/campaigns/{campaign_id}/contacts/upload?format=csv|xlsx |
Главное отличие на практике: в v2 идентификатор клиента не передаётся в пути — его определяет токен. В v1 многие операции требуют client_id явным параметром.
Начинайте с v2. К v1 обращайтесь, если у вас уже есть работающая интеграция или нужен парсер: он опубликован только в v1. Полный перечень — Справочник v1.
Проверка доступности#
/healthПроверка состояния сервиса. Авторизация не требуется.
Sent as the Authorization header. Your key is used only by your browser for this request — it is never sent to Docsbook or stored.
{ "status": "ok" }Клиент и лицензии#
/v2/clientДанные учётной записи, к которой привязан токен.
Sent as the Authorization header. Your key is used only by your browser for this request — it is never sent to Docsbook or stored.
/v2/client/licensesСписок лицензий клиента: активные слоты и сроки.
Sent as the Authorization header. Your key is used only by your browser for this request — it is never sent to Docsbook or stored.
/v2/client/licenses/activateАктивировать лицензию по коду. Тело запроса — JSON.
Sent as the Authorization header. Your key is used only by your browser for this request — it is never sent to Docsbook or stored.
/v2/client/licenses/renewПродлить действующую лицензию. Тело запроса — JSON.
Sent as the Authorization header. Your key is used only by your browser for this request — it is never sent to Docsbook or stored.
/v2/client/telegram-profilesПривязать Telegram-профиль к учётной записи. Тело запроса — JSON.
Sent as the Authorization header. Your key is used only by your browser for this request — it is never sent to Docsbook or stored.
/v2/client/telegram-profiles/{tg_id}Отвязать Telegram-профиль.
Sent as the Authorization header. Your key is used only by your browser for this request — it is never sent to Docsbook or stored.
Идентификатор Telegram-профиля
Известные ограничения#
TLS-сертификат хоста api.nexifyneo.com самоподписанный. Браузер и большинство HTTP-клиентов по умолчанию отклоняют соединение с ошибкой проверки сертификата. Пока сертификат не заменён на выданный публичным центром сертификации, интерактивные запросы со страницы и обращения из строгих клиентов не пройдут. Уточните текущий статус у менеджеров в боте @nn_official_bot.
Тела запросов не типизированы в спецификации. Опубликованный документ OpenAPI описывает тела POST-запросов как свободный JSON-объект, без перечня полей. На страницах справочника указано то, что спецификация действительно объявляет: метод, путь, параметры пути и запроса. Точный состав тела уточняйте у менеджеров в боте.
Дальше#
- Авторизация — как передавать токен.
- Ошибки — форма ответа при отказе и как ссылаться на конкретный запрос.
- Запустить первую кампанию по API — сквозной сценарий.