Fedex Logo

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

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

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

Как получить доступ к странице Advanced Integrated Visibility

Вы можете получить доступ к настройке Advanced Integrated Visibility двумя способами:

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

    1. Перейдите в раздел Мои проекты на панели навигации слева.

    2. Перейдите на вкладку Webhook .

    3. Выберите +СОЗДАТЬ ПРОЕКТ WEBHOOK.

Вариант 2. С помощью каталога API

    1. Откройте каталог API на панели навигации слева.

    2. Выполните поиск Advanced Integrated Visibility.

    3. Используйте фильтр WEBHOOK , чтобы найти нужную карточку.

    4. На карточке:

  •  Нажмите Обзор, затем кнопку Документация и выберите +СОЗДАТЬ ПРОЕКТ WEBHOOK.
  •  Или перейдите в раздел ДОКУМЕНТЫ и нажмите +СОЗДАТЬ ПРОЕКТ WEBHOOK.

 

Шаг 1. Выберите тип компании

Нажмите +СОЗДАТЬ ПРОЕКТ и выберите тип компании из раскрывающегося списка:

    1. Отправляет грузы через FedEx и требует интеграции webhook FedEx в свою систему.

    2. Продает или предлагает программный продукт, в котором используются данные FedEx, но не является сертифицированным поставщиком решений для программы FedEx Compatible.

    3. Является поставщиком решений для программы FedEx Compatible.

 

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

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

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

 

Шаги по оформлению подписки

Процесс включает четыре основных этапа:

    1. Настройка проекта

    2. Ввод данных о проекте

    3. Подтверждение сведений и принятие условий

    4. Добавление номеров отслеживания

 

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

    1. На странице Настройка webhook:

         Посмотрите, какой у вас номер учетной записи плательщика

         Будет отображаться номер учетной записи плательщика по умолчанию для вашей организации.

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

  •  Нажмите ДОБАВИТЬ УЧЕТНУЮ ЗАПИСЬ ПЛАТЕЛЬЩИКА В ВАШУ ОРГАНИЗАЦИЮ (если у вас только одна учетная запись) или
  •  Нажмите ВЫБРАТЬ ДРУГУЮ УЧЕТНУЮ ЗАПИСЬ ПЛАТЕЛЬЩИКА (если у вас несколько учетных записей).

 

Примечание. Подробные сведения о тарифах см. на странице Обзор 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).

3. На странице Подтверждение данных:

  •  Проверьте сведения о вашем проекте webhook.
  •  Ознакомьтесь с Условиями и положениями и примите их.
  •  Нажмите Создать , чтобы завершить настройку проекта webhook.

4. После отправки запроса:

  •  FedEx создаст новый проект webhook.
  •  Вы получите рабочие ключи для API подписки на Advanced Integrated Visibility по номеру отслеживания.
  •  Этот API можно использовать для привязки номеров отслеживания к проекту.

Дополнительные сведения см. на странице документации API подписки на Advanced Integrated Visibility по номеру отслеживания.

Добавление номера отслеживания в webhook

Чтобы добавить номер отслеживания в подписку webhook с помощью API подписки на Advanced Integrated Visibility по номеру отслеживания, выполните следующие действия:

 

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

1. Создайте проект подписки

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

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

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

3. Получите доступ к документации по API

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

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

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

 

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

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

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

 

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

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

Response

Copy