Demo
Demo
База знаний PMTA›Блок <signals>›Директива§ 11.1.6.2.1

api-key

<signals>

Ключ доступа к службе аналитики
в конфигурации это строкаapi-keyвнутри блока <signals>
То же имя ещё 2:<inline-seeding><signals><transmissions-api>— часть из них другие настройки, часть та же самая
Строка, без которой узел не стартует

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

🔴 Строка обязательна в сильном смысле: руководство говорит, что узел не запустится, если блок <signals> есть, а ключа в нём нет. Это отличает её от большинства обязательных строк, где отказ мягче.

Права ключу нужны два: «Incoming Events: Write» и «Account: Read». Тот же ключ годится и для засеивания.

Ключ лежит в конфигурации открытым текстом и попадает в её резервные копии.

Главная ловушка — добавить блок и забыть ключ. Это не «функция не работает», а узел не поднимается. При правке конфигурации на живом парке цена такой забывчивости выше обычного.
Что делает Хаб. Не пишет: выгрузкой во внешнюю аналитику мы не пользуемся. События парка приходят к нам напрямую, вебхуком учёта, и отдавать их наружу незачем.
Рекомендуемые значения

Выбор здесь короткий:

Что Требование
длина ровно 40 знаков
набор шестнадцатеричные цифры
права Incoming Events: Write и Account: Read
Формат, оба требуемых права и то, что без строки узел не запускается, — из руководства (§ 11.1.6.2.1).
Пример в конфигурации
# без этой строки узел не поднимется вовсе
<signals>
    api-key 0123456789abcdef012345678901234567890123</signals>
Ключ в конфигурации открытым текстом: права на файл держат как на секрет.
жёлтым — — имена директив, голубым — блоки. Так же они подсвечены и в тексте карточки.
▲

Типичные ошибки и проблемы

что делают не так и чем это кончается1 ошибка▶

Добавляют блок выгрузки без ключа

наш опыт

Чем чреватоУзел не запустится. Это не отказ функции, а отказ MTA целиком.
Как заметитьПосле правки конфигурации MTA не поднимается.
Как правильноПроверять наличие ключа до применения; согласование конфигурации это ловит.
Совместимость
PowerMTA 6.0
описана в руководстве этой версии · платформа: любая
С какой версии директива доступна, вендор указывает не для всех — здесь пометки нет. Имя встречается и в издании руководства 5.0.
Справочные данные
Синтаксис
api-key <40 hexadecimal digits>
Значения
сорок шестнадцатеричных знаков
Применение
reload, перезапуск не нужен
Очередь
уже поставленное в очередь не затронет
Где писать
<signals>
Сколько раз
один раз в блоке
Всё здесь — из руководства, с разделом.
Наследование
Наследования нет: строка живёт внутри <signals>, а такой блок на узле один. Охват выгрузки по потокам задаётся не здесь, а строкой enable-signals с тремя уровнями.
⇄

Связанные директивы

1 связь

Без чего не работает

Аналитика вендора — и что уходит с узла ради неёМеханизм, работу которого эта строка и настраивает. § 11.1.6.2.1

Как проверить на узле
Работу ключа видно по журналу выгрузки:
grep -i "signals\|sparkpost" /var/log/pmta/log | tail -20
Отказы службы означают неверный ключ или нехватку прав. Сам факт запуска узла означает, что строка хотя бы есть.
◇

Что ещё почитать

3 статьи

◇Ключ активации — условие установки, а не шаг после неёБез ключа активации от поддержки SparkPost MTA не ставится и не работает, а уровень лицензии задаёт потолок исходящих соединений: на стандартной всё сверх 200 игнорируется.◇Ограничения облакаОблака ограничивают исходящую почту через порт 25, пока не попросишь снять лимит, а их диапазоны адресов почтовики встречают с подозрением.◇Как перевести план отправки в железоДве постоянные, по которым считается любой узел: около 2 КБ памяти на каждого получателя в очереди и место под спул, пропорциональное суммарному размеру писем.

В Хабе
Цена ошибки
обратимо: вредит, пока стоит
Сценарии
Подготовить узел к отправке
Соседние настройки блока <signals>:privacy-policyhtml-edit-error-modecustom-message-id-headerretain-x-sp-subaccount-idengagement-trackingВсе 16 директив блока →