Назначение
Adal CLI — клиент для доставки Inbound-запросов приложению на вашем компьютере. Оставляйте его запущенным для получения доставок своего CLI-Канала.
Поток доставки
Внешний отправитель обращается к URL вашего Сервера. Маршрутизатор связывает Сервер с CLI-Каналом, Ендпоинты которого задают локальных получателей. Для локальной доставки Adal CLI должен быть запущен.
Перед началом
Подготовьте исполняемый файл CLI на своём компьютере и откройте терминал в его каталоге. В командах ниже используется имя cli (cli.exe в Windows); если ваш файл называется иначе, используйте его имя. Подготовьте локальное приложение для приёма запросов.
Подготовьте Канал и токен
Создайте Канал типа CLI и добавьте Ендпоинт своего локального приложения.
Проверьте Enabled и Deliver backlog, затем нажмите Save endpoints.
Свяжите Канал с Сервером через включённый Маршрутизатор.
Когда будете готовы подключить клиент, выпустите секрет с нужным сроком действия в панели CLI-токена Канала. Храните его в тайне; API-токен аккаунта его не заменяет.
Секрет показывается при выпуске и не может быть получен повторно. Замена или отзыв токена прекращает его доступ.
CLI-Ендпоинт в демонстрационном кабинете. Укажите адрес своего приложения и сохраните настройки. Интерфейс на английском. Открыть полный размер.
Проверьте доставку
Запустите клиент с CLI-токеном своего Канала:
./cli --token '<CLI_TOKEN>'
В Windows, в PowerShell:
.\cli.exe --token '<CLI_TOKEN>'
Замените <CLI_TOKEN> секретом этого Канала. По умолчанию подключение выполняется к wss://api.adal.cloud. Оставьте клиент запущенным и отправьте демонстрационный запрос на URL Сервера. Проверьте получение в приложении и попытку Ендпоинта в Inbound → Requests → Deliveries. Ответ Сервера подтверждает приём, а не доставку вашему приложению.
Публичное подключение
По умолчанию клиент подключается к wss://api.adal.cloud. Для вызовов публичного API используется https://api.adal.cloud.
| Параметр | Назначение |
|---|---|
--token |
Обязательный секрет CLI-Канала |
--host |
Адрес подключения; для публичного сервиса используйте wss://api.adal.cloud |
--help |
Справка без подключения |
Чтобы явно указать публичный адрес:
./cli --host wss://api.adal.cloud --token '<CLI_TOKEN>'
Переменная ADAL_API_HOST также задаёт адрес подключения. Параметр --host имеет приоритет над ней; если оба не заданы, используется публичный адрес по умолчанию. Для имени хоста без схемы используется WSS. Указывайте только адрес, без пути, учётных данных, query и fragment.
Остановка и сохранённая работа
Нажмите Ctrl+C, чтобы остановить клиент. Для продолжения сохранённой работы запустите его с прежним подключением и токеном. При перезапуске сохраняйте его данные: они могут содержать сведения запросов. Ограничьте доступ и не включайте токены и приватные данные в снимки экрана и логи. После прерывания доставка может повториться, поэтому получатель должен безопасно обрабатывать повторные события.
Если доставка не работает
Проверьте, что Канал связан через включённый Маршрутизатор, Ендпоинт включён, а приложение доступно с вашего компьютера. Проверьте срок действия и отзыв CLI-токена. Перед повторной отправкой события изучите историю доставки запроса.
Deliver backlog управляет доставкой запросов, полученных в отсутствие клиента. Выключение настройки не отменяет уже принятую клиентом работу.