Fedex Logo

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:
    1. -> Обзор -> Документация -> на панели изолированной среды выберите команду Попробовать этот экземпляр Advanced Integrated Visibility..
    2. -> Документы -> на панели изолированной среды выберите команду Попробовать этот экземпляр Advanced Integrated Visibility.

Инструкции

Далее приведены инструкции по использованию Тестового URL-адреса webhook.

  1. Нажмите кнопку Тестовый URL-адрес webhook.
  2. Заполните указанные ниже тестовые параметры.
    Имя поля Описание

    Целевой URL-адрес

    Это URL-адрес, по которому будут отправляться сведения/полезная нагрузка событий отслеживания.

    • Необходимо, чтобы клиент предоставил корректный целевой URL-адрес.
    • Целевой URL-адрес должен соответствовать стандартным правилам синтаксиса (безопасный протокол HTTPS).

    Маркер безопасности

    Служит в качестве совместно используемого секретного ключа для аутентификации и проверки ответа webhook Advanced Integrated Visibility.

    • Маркер должен содержать не менее 26 и не более 100 символов.
    • В нем должны быть прописные и строчные буквы, а также цифры.
    • Маркер безопасности используется для создания подписи кода проверки подлинности сообщений с помощью хеш-функций (HMAC).

    Язык полезных данных

    Выберите в раскрывающемся списке язык перевода данных отслеживания. Ниже приведены 6 доступных языков.

    • Английский (США)(по умолчанию)

    Тип отслеживания

    Выберите тип ответа, в котором должны отправляться данные отслеживания.

    • Тип отклика «Подробное отслеживание» включает защищенные данные отслеживания с полной историей событий.(По умолчанию)
    • Тип отклика «Отслеживание по событиям» содержит защищенные данные отслеживания с информацией только о последних событиях.(Скоро)

    Отслеживание событий

    Выберите категорию, чтобы получать информацию о соответствующих событиях в рамках жизненного цикла отправления. Основные категории приведены ниже.

    • Отправить
    • В пути
    • Доставка
    • Исключения
    • Ожидаемая доставка

    Событие статуса

    Событие отслеживания в жизненном цикле посылки. Выберите события, о которых требуется сообщать. Ниже приведены 10 доступных событий статуса.

    1. Отправление забрано курьером
    2. В пути
    3. Доставлено
    4. Исключение при доставке

     

    Примечание. Значения в поле Событие статуса указываются в соответствии с выбранной Категорией событий в рамках цикла отслеживания. Дополнительные сведения о категориях событий отслеживания и соответствующих событиях статуса см. в таблице ниже.

     

    Категория события статуса Событие статуса

    Отправить

    • Отправление забрано курьером

    В пути

    • В пути

    Доставка

    • Доставлено

    Исключения

    • Исключение при доставке

    Ожидаемая доставка(Скоро)

    • Дата ожидаемой доставки (EDD)
    • Временной промежуток ожидаемой доставки (EDTW)

     

  3. Чтобы подтвердить принятие условий лицензионного соглашения, установите флажок в поле Лицензионное соглашение с разработчиком FedEx Developer Portal.
  4. Нажмите кнопку PUSH для просмотра результатов проверки.


Ответ

Ниже приведены параметры ответа в изолированной среде.

  • Тело — содержит параметры ответа, указанные на вкладке Тестовый URL-адрес Webhook на панели изолированной среды.
  • Статус — этот раздел на вкладке Результаты проверки содержит статус обрабатываемого запроса.
  • Пример сообщения об успешном выполнении теста
    Выполнено
    Тестовые сведения о событии отслеживания Advanced Integrated Visibility переданы успешно.

 

Sandbox Console

Test Parameters

Add in test parameters and push to check if the URL receives test event data from Webhooks API calls.

The destination URL is where we will send you authentication codes and messages as well as Advanced Integrated Visibility payload notifications. Only HTTPS connections using TLS (SSL) 1.2 or higher protocol version that is configured with a certificate from a valid certificate authority is supported. (Character limit: 200)

The following are not valid destination URLs:
• All RFC1918 IP space<br>
• All fedex.com and its sub domain<br>
• IP addresses in the URL (including localhost, 127.0.0.1)

Security Token should be a minimum length of 25 characters and a maximum length of 100 characters, 1 upper case, 1 lower case, 1 numeric character.

Example: Y1F6OiVUQW2JPSElmRE9U0IY5

Payload languageThe language in which you will receive the tracking data. Currently payload language is only available in English
View a full list of languages

Currently detailed tracking is the only available tracking type.

Detailed Tracking
Detailed Tracking Response consists of secured data with the entire history of events.

Event-specific Tracking (coming soon)
Event-specific Tracking Response consists of secure tracking data with only the most recent event information.

Tracking event
These are different categories of tracking events in the shipment life cycle. select one or more of these categories. Then when an event in that category happens, we will trigger webhook notifications and send you a tracking payload response.

Select a tracking event in the package lifecycle to include

Copy copied

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).
  •  Пользователю достаточно ввести количество отправлений и нажать РАСЧИТАТЬ, чтобы получить результаты. Остальные значения определяются по умолчанию или рассчитываются автоматически.

Отказ от обязательств: все значения, рассчитанные калькулятором, являются приблизительными и предназначены только для планирования.

Number of Shipments
Events per Shipment (default 5)
Daily Payload Volume (events per day)



Note: Displayed values are approximations and may not reflect exact usage metrics.
CLOSE

Response

Copy