API Ключ

Как выпустить личный токен для API BotHunter на странице «Доступы и токены», передать его в запросе и проверить. Чем токен отличается от прежнего ключа.

Обновлено

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

Личный токен (рекомендуем)

  1. Откройте страницу «Доступы и токены».

  2. Выпустите новый токен и выберите для него продукт BotHunter.

  3. Выберите срок действия: 30 дней, 1 год или без срока. Для постоянной интеграции подойдёт «без срока».

  4. Сразу скопируйте токен и сохраните его в надёжном месте: целиком он показывается только один раз.

С токеном доступны ваши сообщества и те, где вам выдали роль сотрудника. Если у токена не выбран продукт BotHunter, API ответит ошибкой 4.

Для каждой интеграции удобно выпускать отдельный токен: его можно отозвать, не трогая остальные.

Прежний ключ API

Прежний ключ работает только с адресом без версии (v1): на нём продолжают работать старые интеграции. С v2 он не принимается — придёт ошибка 4. Ключ находится на странице настроек TargetHunter в блоке «Токен доступа»: нажмите «Показать токен» и скопируйте его. Для новых интеграций используйте личный токен.

Как передать токен

  • В заголовке запроса — основной способ: Authorization: Bearer <токен>.

  • В параметре api_key в теле запроса (JSON или форма) — если задать заголовок нельзя. Прежний ключ передаётся так же, но работает только на v1.

  • В адресе запроса (?api_key=…) — только если иначе нельзя: адрес вместе с токеном сохраняется в журналах серверов.

Если переданы и заголовок, и api_key, используется заголовок.

Как проверить токен

Вызовите метод users/me. Если в ответе "status": "ok", токен работает. Ошибка 4 значит, что токен не подошёл: проверьте, что скопировали его целиком и выбрали продукт BotHunter.

curl -X POST https://bot-api.targethunter.ru/external-api/v2/users/me \
  -H "Authorization: Bearer <ваш_токен>"

Не передавайте токен третьим лицам. Если токен попал к чужим людям, отзовите его на странице «Доступы и токены» и выпустите новый. Отозванный токен может работать ещё до минуты. Прежний ключ можно сгенерировать заново — старый перестанет работать.