Настройка webhook Advanced Integrated Visibility
Обзор
С помощью 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. Настройка проекта
На странице Настройка Webhook выполните указанные ниже действия.
- Клиентский номер плательщика:
- Проверьте учетную запись плательщика по умолчанию.
- Чтобы изменить ее:
- Нажмите ДОБАВИТЬ УЧЕТНУЮ ЗАПИСЬ ПЛАТЕЛЬЩИКА В ОРГАНИЗАЦИЮ (если существует только одна учетная запись) или
- Нажмите ВЫБРАТЬ ДРУГУЮ УЧЕТНУЮ ЗАПИСЬ ПЛАТЕЛЬЩИКА (если существует несколько учетных записей).
Примечание. Требуется учетная запись плательщика с адресом в США. Подробные сведения о тарифах см. в Руководстве по тарифам Advanced Integrated Visibility.
Выбор функций:
- Выберите функции, которые хотите включить, затем нажмите Далее.
Описание функций
| Имя поля | Описание |
|---|---|
| подтверждение доставки | Подтверждает, что отправление успешно доставлено. Подтверждение доставки с помощью фото (PPODA): предоставление фотографии, подтверждающей точное место доставки. Подтверждение доставки подписью получателя (SPOD): предоставление изображения подписи получателя, а также имени получателя, даты, времени и места доставки. |
| Ожидаемая доставка | Помогает получателям планировать свои услуги и включает: Дату ожидаемой доставки (EDD) Временной промежуток ожидаемой доставки (EDTW) |
| События отслеживания | Позволяет выбрать одну или несколько категорий событий для получения уведомлений: Отправка В пути Доставка Исключения Индивидуальные условия доставки |
| Фильтрация по событиям | Фильтрует ответы webhook, включая: входящие отправления исходящие отправления отправления от третьих лиц |
На странице Ввод данных укажите следующую информацию:
| Имя поля | Описание |
|---|---|
| Название проекта 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 будет считаться неудачной.
