API и ключи доступа

API нужен, когда к вашим данным должен ходить не человек, а программа: ИИ-ассистент, скрипт выгрузки, свой дашборд или таблица, которая сама подтягивает цифры. Ключ выдаётся в боте: «🧰 Инструменты» → «🔌 API и ИИ-доступ». Раздел есть и в Telegram, и в MAX.

По ключу видно ровно то же, что вам в боте: ваши источники и источники вашей связки аккаунтов. Чужие данные ключ не открывает, тариф не повышает, деньги не тратит.

Два вида ключей

КлючЧто можно
Только чтениестатистика, источники, метки, отсев фильтров, симулятор трафика
Чтение и записьто же плюс создание меток-ссылок

Разница не в вежливой просьбе: изменяющий вызов по ключу на чтение не проходит, а ИИ-ассистенту такой инструмент даже не показывается в списке. Для ассистента берите чтение, если не собираетесь поручать ему заводить метки.

Ключ показывается один раз — в момент выдачи. Мы храним не сам ключ, а его отпечаток, показать повторно физически неоткуда. Потеряли — отзовите этот и выдайте новый, это две кнопки.

Ключ работает, пока активен тариф

Тариф проверяется на каждом запросе, а не в момент выдачи. Подписка кончилась — API отвечает отказом с кодом 402, ассистент получает то же самое. Отзывать ключ при этом не нужно: оплатите тариф, и он заработает снова тем же ключом.

На тестовом тарифе программный доступ закрыт — как и весь раздел «Инструменты».

Что умеет

ОперацияЧто делает
pingпроверить ключ и связь
list_projectsсписок проектов
list_sourcesсписок источников трафика
list_labelsметки источника
stats_summaryпереходы, подписки, отписки, продажи за период
stats_labelsразбивка по меткам: какая реклама привела людей
filter_hitsсколько трафика и за что срезали фильтры
simulateпрогон посетителя через фильтры
create_labelсоздать метку-ссылку (нужен ключ с записью)

Актуальный список всегда отдаёт сам сервис по адресу https://nexus-tag.ru/api/v1 — он открыт без ключа, это документация, а не данные.

Как обращаться

GET https://nexus-tag.ru/api/v1/stats_summary?source_id=12&days=7
Authorization: Bearer nxt_ваш_ключ

Ключ передаётся заголовком Authorization: Bearer … (или X-Api-Key, если так удобнее клиенту) — но не в адресе: адреса попадают в логи и в историю браузера. Ответ всегда JSON.

POST https://nexus-tag.ru/api/v1/create_label
Authorization: Bearer nxt_ваш_ключ
Content-Type: application/json

{"source_id": 12, "title": "Реклама ВК", "utm_source": "vk"}

Созданная так метка ничем не отличается от заведённой кнопкой: она сразу видна в боте, а для закрытого канала ей так же выпускается своя invite-ссылка — иначе подписки по ней не привязались бы к метке.

Коды ответов

КодЧто случилось
200всё хорошо
400плохой аргумент — в ответе написано какой
401ключа нет, он неверен или отозван
402подписка неактивна
403операция меняет данные, а ключ только на чтение
404нет такой операции
429слишком часто

Ограничения частоты

120 запросов в минуту на ключ. У двух операций свой, более низкий потолок, и он не про экономию:

  • simulate — 10 в минуту: прогон определяет адрес через внешний сервис с общей на всех клиентов квотой;
  • create_label — 20 в минуту: каждая метка закрытого канала — обращение к Telegram, а бот один на всех.

Как обращаться с ключом

  • Не публикуйте и не вставляйте в переписку — ключ равен доступу к вашим данным.
  • Давайте отдельный ключ каждой программе и называйте понятно: через полгода будет ясно, что отзывать.
  • Подрядчику — только ключ на чтение.
  • Сомневаетесь, что ключ не утёк, — отзовите. Отзыв действует сразу, выдать новый ничего не стоит.

Ключ не протухает сам по времени — он действует, пока активна подписка и пока вы его не отозвали. Поэтому забытые ключи лучше чистить: в разделе видно, когда каждым пользовались в последний раз и сколько было вызовов.