Adal Бета
Вернуться к документации
Быстрый старт за шесть шагов

Быстрый старт с Adal

Настройте первый приёмник вебхуков и проверьте весь процесс доставки за несколько простых шагов.

Шаги быстрого старта

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

Прежде чем получать и просматривать вебхуки, необходимо создать аккаунт Adal.

Сейчас Adal поддерживает только регистрацию по электронной почте.
После регистрации подтвердите адрес электронной почты, прежде чем использовать панель управления и подключать CLI.

Откройте страницу регистрации: Регистрация в панели управления Adal

После регистрации:

  • Проверьте входящие сообщения.
  • Откройте письмо от Adal.
  • Перейдите по ссылке подтверждения, чтобы активировать аккаунт.

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

Ожидаемый результат:

  • Аккаунт активирован.
  • Вы можете войти в панель управления.
  • Панель управления готова к работе.

02 Создайте сервер

Серверы — это публичные URL вебхуков, которыми управляет Adal.

Откройте страницу серверов: Серверы в панели управления

Затем нажмите Создать сервер в правом верхнем углу. Вы будете перенаправлены на страницу создания сервера

Настройте сервер:

  • Выберите регион.
  • Введите название.
  • Пока оставьте остальные настройки без изменений.

Затем нажмите Сохранить сервер

После создания Adal покажет:

  • публичный URL приёма запросов;
  • токен CLI.

Важно

Токен CLI показывается только один раз сразу после создания сервера.

Сохраните его в безопасном месте, прежде чем покинуть страницу.

Ожидаемый результат:

  • Сервер создан.
  • Вы получили публичный URL вебхука.
  • Вы получили токен CLI.

03 Добавьте получателя

Получатели — это URL, на которые Adal пересылает входящие запросы вебхуков.

Откройте страницу получателей: Получатели в панели управления

Затем нажмите Добавить получателя в правом верхнем углу. Вы будете перенаправлены на страницу создания получателя

Настройте получателя:

  • Выберите регион.
  • Выберите сервер.
  • Введите название получателя.
  • Укажите целевой URL.

URL получателя может вести на:

  • локальный сервер разработки;
  • закрытый внутренний сервис;
  • публичный внешний API.

После настройки нажмите Сохранить получателя

Ожидаемый результат:

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

04 Запустите CLI

Adal CLI поддерживает защищённое соединение с сервером и получает входящие вебхуки в реальном времени.

Скачайте исполняемый файл CLI или соберите его из исходного кода на GitHub

Затем запустите CLI с токеном, полученным при создании сервера:
adalcli --token <ваш-токен-cli>

После подключения CLI автоматически начнёт получать и пересылать вебхуки.

Необязательные параметры:

adalcli --version

Показывает версию CLI.

adalcli --verbose <level>

Управляет подробностью журналов.

Доступные уровни:

  • 0 — минимальный вывод.
  • 1 — основные сведения о доставке.
  • 2 — расширенные журналы.
  • 3 — подробные отладочные сведения.

Пример:

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

Ожидаемый результат:

  • CLI успешно подключён.
  • Статус сервера изменился на «Подключён».
  • Входящие вебхуки появляются в терминале.

05 Отправьте тестовый вебхук

Теперь можно проверить весь процесс доставки.

Отправьте HTTP-запрос на сервер Adal с помощью cURL:

Пример:
curl -X POST https://ghhck1ceiaw51fg4.se1.adal.cloud \
  -H "Content-Type: application/json" \
  -H "X-Test-Source: quickstart" \
  -d '{"message":"Hello from Adal"}'

Что произойдёт дальше:

  • Adal получит запрос.
  • Запрос будет доставлен подключённому CLI.
  • CLI перешлёт запрос настроенному получателю.

В пересылаемом запросе сохраняются:

  • исходный метод HTTP;
  • заголовки;
  • тело;
  • метаданные запроса.

Запрос будет переслан на URL, указанный в настройках получателя.

Ожидаемый результат:

  • Запрос появился в журналах CLI.
  • Запрос переслан получателю.
  • Доставка отмечена как успешная в панели управления.

06 Просмотрите запрос

Все полученные запросы доступны в панели управления Adal.

Откройте раздел запросов

Вы увидите запрос вебхука, отправленный на предыдущем шаге.

Нажмите Подробнее чтобы открыть страницу с полной информацией о запросе.

На странице запроса представлены:

  • заголовки запроса;
  • метаданные запроса;
  • статус доставки;
  • сведения о доставке получателю.

Кроме того, можно:

  • скачать исходное тело запроса;
  • просмотреть тело прямо в браузере для некоторых типов содержимого.

Ожидаемый результат:

  • Запрос отображается в панели управления.
  • Сведения о доставке доступны для просмотра.
  • Исходное тело запроса можно просмотреть или скачать.

Маршрут вебхуков готов

Теперь вы можете получать запросы, пересылать их через CLI и просматривать сведения о доставке в панели управления.

Изучить серверы