Skip to content
Для опытных⏱ 5 мин

Работать через API ​

Задача ​

Управлять кампаниями и получать статистику из своих скриптов, CRM или BI. Для этого нужен API-токен: он заменяет логин и пароль в запросах.

Что нужно заранее ​

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

Шаги ​

  1. В левом меню внизу откройте Настройки и перейдите на вкладку Интеграции.

  2. В блоке API-токены нажмите Создать токен.

  3. В поле Комментарий напишите, для чего токен, например «Интеграция с CRM». Так вы узнаете его в списке. Комментарий необязателен, до 150 символов.

  4. В поле Срок действия выберите дату и время, до которых токен будет работать. Если оставить Бессрочно, токен будет работать, пока вы его не отзовёте.

  5. Нажмите Создать.

    Окно «Новый API-токен»

  6. Нажмите Скопировать и закрыть и сохраните токен. Кабинет показывает его один раз: после закрытия окна посмотреть токен снова нельзя.

    Окно «Токен создан»

Результат ​

Токен появился в таблице API-токены: в колонке Создан — дата создания, в колонке Истекает — срок действия или «Бессрочно», в колонке Комментарий — ваш комментарий. Сам токен в таблице не показывается.

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

Передавайте токен в заголовке Authorization каждого запроса, со словом token и пробелом перед ним:

http
Authorization: token d0c5demo0000000000000000000000000000demo

Запросы с токеном выполняются от имени вашего аккаунта и с его правами. Клиент агентства тоже может выпустить свой токен: через API ему доступны те же кампании, разделы и действия, что и в кабинете. Адрес API и список методов — в документации: её открывает пункт API в левом меню.

Когда токен перестаёт работать ​

  • Наступила дата из поля Срок действия. Истёкший токен исчезает из таблицы в течение суток, а до этого занимает место в лимите из 20 токенов.
  • Вы отозвали токен.
  • Вы сменили пароль аккаунта. Смена пароля отключает все API-токены, даже если они остались в таблице. Создайте новые и замените их в своих сервисах.

Как заменить или отозвать токен ​

Перевыпустить токен с тем же значением нельзя. Чтобы заменить токен:

  1. Создайте новый токен по шагам выше.
  2. Пропишите его в своих скриптах и сервисах.
  3. В строке старого токена нажмите Отозвать и подтвердите. Отзыв необратим: запросы со старым токеном сразу перестанут проходить.

Отзывайте токен сразу, если он мог попасть к посторонним, например в репозиторий или переписку.

Ниже на той же вкладке есть блок OAuth-приложения — сервисы, которым вы дали доступ к аккаунту. Кнопка Удалить в строке приложения отзывает все токены, которые оно получило.

Что может пойти не так ​

СимптомПричинаРешение
«Дата истечения должна быть в будущем»В Сроке действия выбрано прошедшее времяВыберите дату и время позже текущих или оставьте Бессрочно
«Достигнут лимит активных токенов (20). Удалите неиспользуемые токены.»У аккаунта уже 20 токенов. В лимит входят и истёкшие токены, которые ещё видны в таблицеОтзовите токены, которые больше не нужны, в том числе истёкшие
«Не удалось скопировать токен в буфер. Скопируйте вручную перед закрытием.»Браузер не дал доступ к буферу обменаВыделите токен в окне и скопируйте вручную. При ошибке копирования окно остаётся открытым
Токен потерянТокен показывается только при созданииСоздайте новый токен и отзовите старый
Запросы перестали проходить, токен есть в таблицеСменился пароль аккаунта или истёк срок действияСоздайте новый токен

Что дальше ​

© Youtarget