API-токены и webhooks

Доступность

API и webhooks входят в тарифы, которые их содержат (см. страницу цен). Если в вашем тарифе их нет, страница API и webhooks об этом скажет. Открыть её могут только владельцы и администраторы.

Создайте токен

1. Откройте API и webhooks и найдите Токены.
2. Введите Название токена, например «наша CRM». По умолчанию токен только читает. Отметьте Может добавлять сайты и запускать проверки, если инструменту нужна запись.
3. Нажмите Создать токен и сразу скопируйте его: он показывается только один раз. Если потеряли, удалите токен и создайте новый.

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

Обращайтесь к API

Базовый адрес и ссылка на описание OpenAPI есть в блоке Как начать. Передавайте токен в заголовке:

curl -H "Authorization: Bearer $TOKEN" -H "Accept: application/json" https://pandus.online/api/v1/sites

Через API можно просматривать сайты, добавлять и удалять их, запускать проверку, получать проверку, её отчёт и PDF. Токен может отправлять до 60 запросов в минуту.

Webhooks

Webhook сообщает вашей системе, когда что-то произошло, так что спрашивать не нужно. Нажмите Добавить webhook, введите https-адрес и выберите события: завершение проверки (scan.completed) и найденные новые проблемы (issues.new). У команды может быть до пяти адресов.

Каждое сообщение подписано. В заголовке Pandus-Signature есть время и подпись HMAC-SHA256, созданная вашим Секретом подписи. Проверяйте её, прежде чем доверять сообщению.

Кнопка Отправить тест проверяет адрес. Журнал доставки показывает каждую попытку. Неудачное сообщение отправляется повторно до шести раз примерно за сутки; можно повторить и вручную. Адрес, который постоянно даёт сбой, отключается после 20 неудач подряд. Адреса, ведущие в частную сеть, отклоняются.