Вернуться к документации

Adal CLI

Подключите локальное или приватное приложение к Adal и получайте входящие вебхуки без публикации сервиса в интернете.

Открыть как Markdown
На этой странице

Обзор

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

CLI подходит для локальной разработки и тестирования обработчиков. Для публичного HTTPS-адреса обычно удобнее Direct HTTP.

Как работает Adal CLI

CLI устанавливает исходящее защищённое соединение с Adal. Принятый вебхук передаётся подключённому CLI, а тот отправляет его на URL получателя.

Отправитель → Сервер Adal → Adal CLI → локальное приложение

Метод, путь, параметры, заголовки и тело передаются приложению, а ответ сохраняется в истории доставки.

Важно: Пока CLI отключён, запрос ожидает подключения с учётом срока хранения.

Установка

Скачайте архив для своей ОС на странице релизов Adal CLI, распакуйте его и добавьте исполняемый файл в PATH. CLI также можно собрать из исходного кода.

adalcli --version

Получение токена

  1. Откройте сервер в панели Adal.

  2. Создайте получателя типа Adal CLI.

  3. Укажите URL, например http://127.0.0.1:3000.

  4. Скопируйте токен и сохраните его в надёжном месте.

Исходный токен показывается только при создании. Потерянный или раскрытый токен замените.

Запуск

Запустите локальное приложение, затем подключите CLI:

adalcli --token <ваш-токен-cli>

Для вывода сведений о доставке:

adalcli --token <ваш-токен-cli> --verbose 1

Параметры командной строки

  • --token <token> — токен подключения.

  • --verbose <level> — подробность журнала от 0 до 3.

  • --version — версия CLI.

Уровни: 0 — минимум сообщений, 1 — доставка, 2 — расширенный журнал, 3 — отладочная информация.

Безопасность

  • Не добавляйте токен в репозиторий, журналы и снимки экрана.

  • Запускайте CLI только в доверенной среде.

  • Используйте отдельные токены для разных окружений.

  • Немедленно замените раскрытый токен.

  • Проверяйте подпись отправителя в обработчике вебхуков.

Устранение неполадок

CLI не подключается

Проверьте токен, интернет, прокси и межсетевой экран. Для диагностики используйте --verbose 2 или --verbose 3.

Приложение не получает запросы

Проверьте, что оно запущено, а URL, порт, путь и протокол указаны верно.

Запросы ожидают доставки

Убедитесь, что CLI подключён токеном нужного получателя, и проверьте историю доставки.

Доставка завершается ошибкой

Изучите ответ приложения и журнал CLI. Ответы 4xx и 5xx означают, что приложение вернуло ошибку.

  • Быстрый старт — создание сервера, получателя и первая тестовая доставка.

  • Получатели — настройка доставки через Adal CLI, повторные попытки и история.

  • Серверы — приём вебхуков, параметры сервера и доставка ожидающих запросов.

  • Безопасность — защита соединений, токенов и данных.

Связанная документация