Обзор
Webhook Advanced Integrated Visibility позволяет FedEx отправлять защищенные данные о событиях отслеживания практически в режиме реального времени по указанному URL-адресу. Это касается отправлений, связанных с одним или несколькими клиентскими номерами FedEx. Чтобы использовать этот инструмент, необходимо создать проект webhook через FedEx Developer Portal.
Пути навигации
Вы можете получить доступ к странице создания webhook одним из следующих способов:
- Через Мои проекты: панель навигации слева → вкладка Webhook → +СОЗДАТЬ ПРОЕКТ WEBHOOK
- Через каталог API:
- Панель навигации слева → Каталог API
- Введите в поле поиска Advanced Integrated Visibility или примените нужные фильтры
- Обзор → Нажмите Документация → на панели изолированной среды нажмите +СОЗДАТЬ ПРОЕКТ
- Документы → Нажмите +СОЗДАТЬ WEBHOOK
Этапы создания webhook
Шаг 1. Выберите тип компании
Нажмите +СОЗДАТЬ ПРОЕКТ и выберите тип компании из раскрывающегося списка:
- Отправляет грузы через FedEx и требует интеграции webhook FedEx в свою систему.
- Продает или предлагает программный продукт, в котором используются данные FedEx, но не является сертифицированным поставщиком решений для программы FedEx Compatible.
- Является поставщиком решений для программы 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. + Создание проекта
На странице Выбор продуктов:
- Нажмите Advanced Integrated Visibility — клиентский номер, а затем — Далее.
- Выберите учетные записи плательщика, примите условия оплаты и нажмите Далее.
Необходимо добавить хотя бы одну учетную запись плательщика.
На странице Подтверждение данных:
- Проверьте сведения о проекте.
- Примите Условия и положения.
- Если применяются индивидуальные тарифы, соответствующий документ появится автоматически.
После успешного создания появится сообщение с подтверждением:
«Вы успешно добавили продукт в раздел "Мой проект".»
Этап 3. Обзор проекта — активация ключа API
- На странице Обзор проекта, во вкладке Ключи API в разделе API, статус подписки в рабочем режиме изначально будет отображаться как Отключено.
- Администратор или представитель FedEx активирует продукт по запросу.
- После активации станет доступна вкладка Рабочий ключ, а рабочий статус изменится на Ожидает подтверждения.
- После окончательной активации администратором или представителем FedEx рабочий статус будет отображаться как Включено.
Этап 4. Обзор проекта — настройка webhook
- Перейдите на страницу Обзор проекта.
- Откройте вкладку webhook.
- Нажмите кнопку + Настроить webhook, чтобы приступить к настройке webhook. Вы будете перенаправлены на вкладку webhook.
Описание функций
| Имя поля | Описание |
|---|---|
| подтверждение доставки | Подтверждает, что отправление успешно доставлено. Включает: Подтверждение доставки с помощью фото (PPOD): предоставление фотографии, подтверждающей точное место доставки. Подтверждение доставки подписью получателя (SPOD): предоставление изображения подписи получателя, а также имени получателя, даты, времени и места доставки. |
| Ожидаемая доставка | Помогает получателям планировать свои услуги и включает: Дату ожидаемой доставки (EDD) Временной промежуток ожидаемой доставки (EDTW) |
| События отслеживания | Позволяет выбрать одну или несколько категорий событий для получения уведомлений: Отправка В пути Доставка Исключения Индивидуальные условия доставки |
| Фильтрация по событиям | Фильтрует ответы webhook, включая: входящие отправления исходящие отправления отправления от третьих лиц |
2. На странице Ввод данных укажите следующую информацию:
| Имя поля | Описание |
|---|---|
| Название проекта Webhook | Уникальное название для проекта webhook, не являющееся пустым. Поле заполняется автоматически, но предложенное значение можно изменить. Это название не должно повторяться ни в одном другом webhook. |
| Целевой URL-адрес | Защищенная конечная точка HTTPS, на которую FedEx будет отправлять данные о событиях отслеживания. Требования: Должен быть действительным и рабочим. Должен соответствовать стандартизированному синтаксису. Не должен включать fedex.com и его поддомены. Может использоваться повторно в нескольких webhook. Более подробная информация содержится в разделе «Правила работы и рекомендации». |
| Маркер безопасности | Общий секретный ключ, используемый для аутентификации и проверки ответов webhook через HMAC. Требования: 26–100 символов Должен содержать по крайней мере одну заглавную букву, одну строчную букву и одну цифру. Может использоваться повторно в нескольких webhook. |
| Язык полезной нагрузки (страна) | Выберите в раскрывающемся списке язык перевода данных отслеживания. |
| Тип отслеживания | Выберите способ доставки данных отслеживания: Детальное отслеживание — полная история событий Отслеживание по конкретным событиям — только самое последнее событие |
| Адрес электронной почты | Укажите действующий адрес электронной почты, чтобы получать уведомления. |
| Язык (страна) сообщений электронной почты | Выберите язык уведомлений по электронной почте. Примечание. Поддерживаются только региональные настройки США (например, 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 будет считаться неудачной.
