Sandbox Console
Webhook тестирования
Вы можете воспользоваться тестовым URL-адресом Webhook для проверки типа данных отслеживания, присылаемых на целевой URL-адрес (сервер получателя/прослушивателя). Это позволит проверить корректность URL-адреса и возвращаемых данных перед созданием экземпляра webhook Advanced Integrated Visibility.
Навигация
Далее приведены методы перехода к панели изолированной среды Тестового URL-адреса webhook.
- Мои проекты (на панели навигации слева) -> вкладка Advanced Integrated Visibility -> кнопка Тестовый URL-адрес webhook -> на панели изолированной среды выберите команду Попробовать этот экземпляр Advanced Integrated Visibility
- API Catalog (на панели навигации слева) -> поиск Advanced Integrated Visibility или выберите Advanced Integrated Visibility в разделе ФИЛЬТРЫ -> карточка Advanced Integrated Visibility:
- -> Обзор -> Документация -> на панели изолированной среды выберите команду Попробовать этот экземпляр Advanced Integrated Visibility..
- -> Документы -> на панели изолированной среды выберите команду Попробовать этот экземпляр Advanced Integrated Visibility.
Инструкции
Далее приведены инструкции по использованию Тестового URL-адреса webhook.
- Нажмите кнопку Тестовый URL-адрес webhook.
- Заполните указанные ниже тестовые параметры.
Имя поля Описание Целевой URL-адрес
Это URL-адрес, по которому будут отправляться сведения/полезная нагрузка событий отслеживания.
- Необходимо, чтобы клиент предоставил корректный целевой URL-адрес.
- Целевой URL-адрес должен соответствовать стандартным правилам синтаксиса (безопасный протокол HTTPS).
Маркер безопасности
Служит в качестве совместно используемого секретного ключа для аутентификации и проверки ответа webhook Advanced Integrated Visibility.
- Маркер должен содержать не менее 26 и не более 100 символов.
- В нем должны быть прописные и строчные буквы, а также цифры.
- Маркер безопасности используется для создания подписи кода проверки подлинности сообщений с помощью хеш-функций (HMAC).
Язык полезных данных
Выберите в раскрывающемся списке язык перевода данных отслеживания. Ниже приведены 6 доступных языков.
- Английский (США)(по умолчанию)
Тип отслеживания
Выберите тип ответа, в котором должны отправляться данные отслеживания.
- Тип отклика «Подробное отслеживание» включает защищенные данные отслеживания с полной историей событий.(По умолчанию)
- Тип отклика «Отслеживание по событиям» содержит защищенные данные отслеживания с информацией только о последних событиях.(Скоро)
Отслеживание событий
Выберите категорию, чтобы получать информацию о соответствующих событиях в рамках жизненного цикла отправления. Основные категории приведены ниже.
- Отправить
- В пути
- Доставка
- Исключения
- Ожидаемая доставка
Событие статуса
Событие отслеживания в жизненном цикле посылки. Выберите события, о которых требуется сообщать. Ниже приведены 10 доступных событий статуса.
- Отправление забрано курьером
- В пути
- Доставлено
- Исключение при доставке
Примечание. Значения в поле Событие статуса указываются в соответствии с выбранной Категорией событий в рамках цикла отслеживания. Дополнительные сведения о категориях событий отслеживания и соответствующих событиях статуса см. в таблице ниже.
Категория события статуса Событие статуса Отправить
- Отправление забрано курьером
В пути
- В пути
Доставка
- Доставлено
Исключения
- Исключение при доставке
Ожидаемая доставка(Скоро)
- Дата ожидаемой доставки (EDD)
- Временной промежуток ожидаемой доставки (EDTW)
- Чтобы подтвердить принятие условий лицензионного соглашения, установите флажок в поле Лицензионное соглашение с разработчиком FedEx Developer Portal.
- Нажмите кнопку PUSH для просмотра результатов проверки.
Ответ
Ниже приведены параметры ответа в изолированной среде.
- Тело — содержит параметры ответа, указанные на вкладке Тестовый URL-адрес Webhook на панели изолированной среды.
- Статус — этот раздел на вкладке Результаты проверки содержит статус обрабатываемого запроса.
Пример сообщения об успешном выполнении теста
Выполнено
Тестовые сведения о событии отслеживания Advanced Integrated Visibility переданы успешно.
Status
Success
Test webhook tracking event details delivered successfully
Error
Test webhook tracking event details delivery failed
Если тестовая доставка сведений о событии завершается сбоем, на вкладке Результаты проверки поле СТАТУС будет иметь значение Ошибка с указанием кода и сообщения об ошибке.
Пример сообщения об ошибке
Код ошибки:<<error code>>
Не удалось доставить тестовые сведения о событии отслеживания Advanced Integrated Visibility.
Правила проверки
- URL-адрес Advanced Integrated Visibility должен соответствовать стандартным правилам синтаксиса.
- Для проверки URL-адреса Advanced Integrated Visibility необходимо заполнить все обязательные поля.
- Успешная проверка:
- FedEx отправит запрос с примером события JSON; Примечание. Целевой URL-адрес Advanced Integrated Visibility должен возвращать FedEx код состояния HTTP 200 (ОК).
- Ошибка проверки:
- Если FedEx получает в ответе код состояния HTTP, отличный от 200 (ОК), считается, что целевой URL-адрес Advanced Integrated Visibility не прошел проверку.
- на вкладке Результаты проверки будет отображаться код ошибки и сообщение об ошибке.
Калькулятор полезных данных
Калькулятор полезных данных помогает подписчикам оценить объем данных, которые генерируют их webhook. Он помогает отслеживать ежедневные объемы полезных данных, количество отправлений и событий отслеживания, помогая пользователям принимать обоснованные решения об использовании данных и планировании интеграции.
Использование калькулятора
Пользователи могут ввести следующие параметры:
- количество отправлений;
- количество событий на отправление (по умолчанию: 5);
- суточный объем полезных данных (рассчитывается автоматически).
На основе этих входных данных калькулятор динамически отображает следующие результаты:
- общее количество событий отслеживания;
- суточный объем полезных данных;
- расчетный общий размер данных.
Примечания.
- Для количества событий на отправление по умолчанию установлено значение 5. Оно основано на среднем значении 17–18 событий на отправление и типичных сроках доставки 1–7 дней в зависимости от типа услуги, перевозчика и пункта назначения. Предполагается, что средний срок доставки составляет 3 дня. Примечание: пользователь может изменить это значение.
- Суточный объем полезных данных рассчитывается по следующей формуле: Количество отправлений × Количество событий на отправление (по умолчанию: 5).
- Пользователю достаточно ввести количество отправлений и нажать РАСЧИТАТЬ, чтобы получить результаты. Остальные значения определяются по умолчанию или рассчитываются автоматически.
Отказ от обязательств: все значения, рассчитанные калькулятором, являются приблизительными и предназначены только для планирования.
Response