Найти и использовать API-ключ

Где взять ключ

Откройте раздел «Интеграции» в настройках аккаунта. Поле «API ключ» открыто только для чтения, рядом — кнопка «Скопировать ключ»: после клика появляется тост «API-ключ скопирован». Ключ пригодится, если нужно передать в Нотифлоу данные о пользователе через JavaScript SDK или обратиться к серверному API напрямую.

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

Зачем нужен ключ на практике

Чаще всего ключ задействован в методе identify — так посетитель сайта связывается с конкретным пользователем, а его данные попадают в карточку контакта. Подробный порядок описан в статье про передачу атрибутов пользователя. Если, наоборот, нужно получать события из Нотифлоу на свой сервер, для этого существуют вебхуки — они настраиваются в том же разделе «Интеграции».

Каждый виджет на сайте работает с одним и тем же ключом аккаунта: отдельного ключа на виджет не предусмотрено.

Как перегенерировать ключ

Кнопка «Перегенерировать ключ» находится там же, в «Интеграциях». Перед подтверждением кабинет предупреждает дословно: «Перегенерация ключа сделает текущий недействительным. Все интеграции, использующие его, перестанут работать». После перегенерации нужно обновить ключ везде, где он применялся, — в первую очередь в сниппете установки на сайте, иначе виджет перестанет получать данные о посетителях.

Серверный API

Помимо клиентского SDK у Нотифлоу есть серверный API: запросы к нему принимаются с заголовком X-Api-Key, куда передается тот же ключ из «Интеграций». Это платная возможность — она доступна на тарифе «Бизнес» и выше. Полное описание методов, форматов запросов и ответов — в документации по API.