Fedex Logo

СОЗДАНИЕ
WEBHOOK УПРАВЛЕНИЕ WEBHOOK

Как работает Advanced Integrated Visibility

Общие сведения о webhook Advanced Integrated Visibility

Webhook Advanced Integrated Visibility позволяет FedEx безопасно передавать данные о событиях отслеживания практически в режиме реального времени на указанный целевой URL-адрес для отправлений, связанных с назначенными клиентскими номерами FedEx.

Для использования этой функции администратор FedEx или администратор DI должен создать проект webhook Advanced Integrated Visibility.

 

Варианты навигации

Получить доступ к странице webhook Advanced Integrated Visibility можно одним из двух способов, описанных ниже.

Вариант 1. Через страницу «Мои проекты»

  •  Перейдите в раздел «Мои проекты» с помощью панели навигации слева.
  •  Перейдите на вкладку Webhook.

Вариант 2. Через каталог API

  •  Перейдите в Каталог API с помощью панели навигации слева.
  •  Воспользуйтесь панелью поиска, чтобы найти Advanced Integrated Visibility, или выберите этот вариант в разделе ФИЛЬТРЫ.
  •  На карточке Webhook выберите один из следующих пунктов.
  •  Нажмите Документы → затем нажмите + Управление webhook

Просмотр проекта подписки Advanced Integrated Visibility по номеру отслеживания

1. Личный доступ и настройка FedEx

  •  Администратор FedEx или сотрудник FedEx начнет процесс настройки.
  •  Профиль организации создается назначенным администратором от имени клиентов CSP.
  •  Действующая учетная запись плательщика из США добавляется на уровне организации администратором от имени клиента.
  •  Администратор, выполняющий эту настройку, должен обладать соответствующими правами доступа для управления конфигурациями на уровне организации.

2. Просмотр подписки по номеру отслеживания.

2.1 Просмотр подписки

  •  После того как администратор или сотрудник FedEx создаст проект, пользователи могут просмотреть связанный проект подписки Advanced Integrated Visibility по номеру отслеживания на своей панели мониторинга.

2. Просмотр функций

  •  Вы можете ознакомиться с доступными функциями, связанными с проектом подписки, для лучшего понимания и использования.

Описание функций

Имя поля Описание
подтверждение доставки Подтверждает, что отправление успешно доставлено. Включает следующие варианты.
  • Подтверждение доставки с помощью фото (PPODA): фотография, подтверждающая точное место доставки.
  • Подтверждение доставки подписью получателя (SPOD): предоставляет изображение подписи получателя, а также имя получателя, дату, время и место доставки.
Ожидаемая доставка Предоставляет получателям следующие возможности.
  • Дата ожидаемой доставки (EDD)
  • Временной промежуток ожидаемой доставки (EDTW)
События отслеживания Позволяет выбрать одну или несколько категорий событий для получения уведомлений.
  • Отправить
  • В пути
  • Доставка
  • Исключения

 

На странице подробностей будет отображаться следующая информация.

Имя поля Описание
Название проекта Webhook Уникальное название для проекта webhook, не являющееся пустым. Поле заполняется автоматически, но предложенное значение можно изменить. Это название не должно повторяться ни в одном другом webhook.
Целевой URL-адрес Защищенная конечная точка HTTPS, на которую FedEx будет отправлять данные о событиях отслеживания.
Требования:
  • должен быть действительным и исправным;
  • должен следовать стандартизированному синтаксису;
  • не может включать fedex.com или его поддомены;
  • может использоваться повторно в нескольких webhook.
Дополнительные сведения см. в разделе «Правила работы и рекомендации».
Маркер безопасности Общий секретный ключ, используемый для аутентификации и проверки ответов webhook через HMAC.
Требования:
  • 26–100 символов;
  • должен содержать по меньшей мере 1 заглавную букву, 1 строчную букву и 1 цифру;
  • может использоваться повторно в нескольких webhook.
Язык полезной нагрузки (страна) Выберите в раскрывающемся списке язык перевода данных отслеживания.
Тип отслеживания Выберите способ доставки данных отслеживания.
  • Подробное отслеживание — полная история событий
  • Отслеживание по событиям — только последнее событие
Адрес электронной почты Укажите действующий адрес электронной почты, чтобы получать уведомления.
Язык (страна) сообщений электронной почты Выберите язык уведомлений по электронной почте.
Примечание: поддерживаются только языки США (например, en-US, es-US).

 

Пошаговые инструкции

4. Создание проекта подписки

  •  Воспользуйтесь инструкциями из предыдущего раздела или обратитесь к Руководству по началу работы.

5. Создайте маркер OAuth

  •  Для выполнения запросов API необходим маркер OAuth.
  •  Для создания маркера используйте API авторизации.
  •  Подробные инструкции см. в документации по API авторизации в каталоге API.

6. Документация по API доступа

  •  В меню навигации слева выберите пункт Сведения о проекте.
  •  На вкладке «Рабочие ключи» найдите документацию по API подписки на Advanced Integrated Visibility по номеру отслеживания.

 

Обзор конечных точек API

Конечная точка Цель
Привязка номеров отслеживания Добавление номеров отслеживания в подписку webhook и их удаления из нее. Это асинхронная задача. В ответе возвращается идентификатор задачи.
Сведения о задаче для номеров отслеживания Предоставляет подробную информацию о конкретной задаче, например, сколько номеров отслеживания было успешно добавлено или находятся в процессе обработки.
Статус задачи для номеров отслеживания Возвращает сводку обо всех задачах, обрабатываемых в настоящий момент.

 

Используйте маркер OAuth из шага 2 с конечной точкой Привязка номеров отслеживания, чтобы добавить номера отслеживания в ваш webhook.

Правила проверки

  •  Названия webhook должны быть уникальными.
  •  Целевой URL-адрес должен соответствовать стандартным правилам синтаксиса.
  •  Необходимо заполнить все обязательные поля.
  •  Необходимо привязать хотя бы один действительный клиентский номер FedEx.

Результаты проверки

Статус Информация
Успех Появится подтверждение:
«<> успешно создан. Для вступления изменений в силу может потребоваться до 10 минут».
Неудача Если FedEx получает в ответе код состояния HTTP, отличный от 200 (ОК) или 202 (Принято), считается, что целевой URL-адрес webhook не прошел проверку.
CLOSE

Response

Copy