api-key

<inline-seeding>

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

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

Формат жёсткий — ровно сорок шестнадцатеричных знаков. Ключ заводится в личном кабинете вендора и требует двух прав: «Inline Seeds: On Prem» и «Account: Read».

Тот же ключ годится и для выгрузки событий — <signals> пользуется таким же. Если заведены субсчета, брать надо ключ основного счёта.

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

Главная ловушка — завести ключ без нужных прав. Формат проверяется, права — нет: сорок знаков пройдут проверку, а служба откажет. Выглядеть это будет как неработающее засеивание без объяснений.
Что делает Хаб. Не пишет: засеиванием вендора мы не пользуемся — оно требует платной подписки на его инструмент и учётной записи с включённой функцией.

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

Рекомендуемые значения

Требования к ключу:

Что Требование
длина ровно 40 знаков
набор шестнадцатеричные цифры
права Inline Seeds: On Prem и Account: Read
при субсчетах ключ основного счёта
Формат, оба требуемых права, общность ключа с выгрузкой событий и правило про основной счёт — из руководства (§ 11.2.2.2.1).
Пример в конфигурации
<inline-seeding>
    api-key 0123456789abcdef012345678901234567890123</inline-seeding>
Ключ в конфигурации открытым текстом: права на файл держат как на секрет.
жёлтым — — имена директив, голубым — блоки. Так же они подсвечены и в тексте карточки.
▲

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

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

Заводят ключ без права «Inline Seeds: On Prem»

наш опыт

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

Ждут засеивания без подписки на инструмент вендора

§ 11.2

Чем чреватоМеханизм требует учётной записи с включённой функцией и платного доступа к инструменту доставляемости. Без этого ключ не завести, а значит и засеивание не включить.
Как заметитьБлок настроен, семена в рассылках не появляются.
Как правильноПроверить подписку и права ключа в кабинете вендора.
Совместимость
PowerMTA 6.0
описана в руководстве этой версии · платформа: любая
С какой версии директива доступна, вендор указывает не для всех — здесь пометки нет. Имя встречается и в издании руководства 5.0.
Справочные данные
Синтаксис
api-key <key>
Значения
сорок шестнадцатеричных знаков
Применение
reload, перезапуск не нужен
Очередь
уже поставленное в очередь не затронет
Где писать
<inline-seeding>
Сколько раз
один раз в блоке
Всё здесь — из руководства, с разделом.
Наследование
Наследования нет: строка живёт внутри <inline-seeding>, а такой блок на узле только один. Включение засеивания по потокам настраивается не здесь, а строкой enable-inline-seeding с тремя уровнями.
Как проверить на узле
Работает ли ключ, видно по журналу MTA — служба отвечает на обращения:
grep -i "seed\|inline" /var/log/pmta/log | tail -20
Отказы службы означают либо неверный ключ, либо нехватку прав у него.
В Хабе
Цена ошибки
обратимо: вредит, пока стоит
Сценарии
Засеивание и контрольные ящики