Обзор
С помощью webhook Advanced Integrated Visibility FedEx рассылает по целевым URL-адресам защищенные оперативные сведения о событиях отслеживания посылок, связанных с соответствующими клиентскими номерами FedEx. Чтобы получить доступ к этому инструменту, нужно создать проект webhook на портале FedEx Developer Portal.
Пути навигации
Вы можете перейти на страницу создания webhook одним из следующих способов:
1. Через страницу «Мои проекты»
- Панель навигации слева → вкладка Webhook → +СОЗДАТЬ ПРОЕКТ WEBHOOK.
2. Через каталог API
Панель навигации слева → Каталог API.
Введите в поле поиска Advanced Integrated Visibility или примените нужные фильтры.
Выберите:
- Обзор → Нажмите Документация → на панели изолированной среды нажмите +СОЗДАТЬ ПРОЕКТ.
- Документы → нажмите +СОЗДАТЬ WEBHOOK.
Этапы создания webhook
Шаг 1. Выберите тип компании
Нажмите +СОЗДАТЬ ПРОЕКТ и выберите тип компании из раскрывающегося списка:
1. Отправляет грузы через FedEx и требует интеграции webhook FedEx в свою систему.
2. Продает или предлагает программный продукт, в котором используются данные FedEx, но не является сертифицированным поставщиком решений для программы FedEx Compatible.
3. Является поставщиком решений для программы FedEx Compatible.
Примечание. В настоящее время данная функция не работает в сочетании с webhook Advanced Integrated Visibility FedEx. Поскольку вы являетесь участником программы FedEx Compatible, обратитесь к менеджеру канала, чтобы получить доступ к Basic Integrated Visibility или другим решениям FedEx для интеграции. Если вы не знаете контактных данных менеджера канала, обратитесь к администратору компании.
Затем выберите в качестве типа подписки Подписка на Advanced Integrated Visibility по клиентскому номеру.
Создание подписки на Advanced Integrated Visibility по клиентскому номеру
Процесс создания включает четыре ключевых этапа:
Этап 1. Активация подписки на Advanced Integrated Visibility по клиентскому номеру
Этот этап осуществляется администратором или сотрудником FedEx по запросу сторонних клиентов.
- Документ MNDA. Администратор или сотрудник FedEx должен получить подписанное взаимное соглашение о неразглашении (MNDA) вместе с общим списком клиентских номеров первой стороны/отправителя.
Примечание. Во время этой загрузки можно указывать дублирующиеся клиентские номера, связанные с другими организациями.
- Если это применимо, Индивидуальные тарифы будут действовать на уровне организации.
Примечание. Эта функция не включена в июльский выпуск.
Этап 2. + Создание проекта
На странице Выбор продуктов:
1. Нажмите Advanced Integrated Visibility — клиентский номер, а затем — Далее.
2. Выберите учетные записи плательщика, примите условия оплаты и нажмите Далее.
Необходимо добавить хотя бы одну учетную запись плательщика.
3. На странице Подтверждение данных:
- Проверьте сведения о проекте.
- Примите Условия и положения.
- Если применяются индивидуальные тарифы, соответствующий документ появится автоматически.
4. После успешного создания появится сообщение с подтверждением:
«Вы успешно добавили продукт в раздел "Мой проект".»
5. Обзор проекта — активация ключа API.
- На странице Обзор проекта, во вкладке Ключи API в разделе API, статус подписки в рабочем режиме изначально будет отображаться как Отключено.
- Администратор или представитель FedEx активирует продукт по запросу.
- После активации станет доступна вкладка Рабочий ключ, а рабочий статус изменится на Ожидает подтверждения.
- После окончательной активации администратором или представителем FedEx рабочий статус будет отображаться как Включено.
Этап 3. Обзор проекта — настройка webhook
1. Перейдите на страницу Обзор проекта.
2. Откройте вкладку webhook.
3. Нажмите кнопку + Настроить webhook, чтобы приступить к настройке webhook. Вы будете перенаправлены на вкладку webhook.
Описание функций
| Имя поля | Описание |
|---|---|
| подтверждение доставки | Подтверждает, что отправление успешно доставлено. Включает следующие варианты.
|
| Ожидаемая доставка | Предоставляет получателям следующие возможности.
|
| События отслеживания | Позволяет выбрать одну или несколько категорий событий для получения уведомлений.
|
| Фильтрация по событиям | Позволяет фильтровать ответы webhook по следующим критериям:
|
2. На странице Ввод данных укажите следующую информацию:
| Имя поля | Описание |
|---|---|
| Название проекта Webhook | Уникальное название для проекта webhook, не являющееся пустым. Поле заполняется автоматически, но предложенное значение можно изменить. Это название не должно повторяться ни в одном другом webhook. |
| Целевой URL-адрес | Защищенная конечная точка HTTPS, на которую FedEx будет отправлять данные о событиях отслеживания. Требования:
|
| Маркер безопасности | Общий секретный ключ, используемый для аутентификации и проверки ответов webhook через HMAC. Требования:
|
| Язык полезной нагрузки (страна) | Выберите в раскрывающемся списке язык перевода данных отслеживания. |
| Тип отслеживания | Выберите способ доставки данных отслеживания.
|
| Адрес электронной почты | Укажите действующий адрес электронной почты, чтобы получать уведомления. |
| Язык (страна) сообщений электронной почты | Выберите язык уведомлений по электронной почте. Примечание. Поддерживаются только региональные настройки США (например, en-US, es-US). |
Этап 3. Выбор учетных записей для доставки
На странице Выбор учетных записей для доставки:
- Выберите один или несколько клиентских номеров FedEx, которые будут связаны с вашим проектом webhook.
Важные примечания
- Будут отображаться только учетные записи, еще не связанные ни с одним другим проектом webhook.
- Чтобы продолжить, необходимо привязать хотя бы одну учетную запись.
- Можно добавить не более 100 учетных записей через интерфейс webhook.
- Чтобы связать более 100 учетных записей, используйте API webhook.
Чтобы получить доступ к API, обратитесь в Центр поддержки клиентов FedEx или в службу поддержки.
Этап 4. Подтверждение данных и создание
На странице Подтверждение данных:
1. Проверьте все сведения, которые вы указали для проекта webhook.
2. Чтобы принять условия и положения, установите флажок.
3. Нажмите Создать, чтобы завершить настройку webhook.
После успешной отправки будет создан webhook с созданным системой идентификатором подписки и статусом Активный.
Правила проверки
Общие требования:
- Название webhook должно быть уникальным.
- Целевой URL-адрес должен соответствовать стандартным правилам синтаксиса (безопасный протокол HTTPS, запрещены fedex.com и его поддомены).
- Необходимо заполнить все обязательные поля — ни одно из них не должно быть пустым.
- С webhook должен быть связан хотя бы один действующий клиентский номер FedEx для доставки.
Успешная проверка:
Если webhook создан успешно, клиент получит сообщение с подтверждением:
<<Webhook name>> успешно создан. Для вступления изменений в силу может потребоваться до 10 минут.
Неудача/ошибка проверки:
Если FedEx получит от целевого URL-адреса ответ, отличный от HTTP 200 (OK) или 202 (Accepted), проверка webhook будет считаться неудачной.
