FedEx Dataworks (предварительная версия)
FedEx Corp. предоставляет клиентам и предприятиям по всему миру широкий портфель транспортных услуг, электронной коммерции и бизнес-услуг. Подключитесь к API службы выбора транспорта, чтобы получить рекомендации по ранжированию и обслуживанию по планам транспорта.
Этот соединитель доступен в следующих продуктах и регионах:
| Услуга | Класс | Регионы |
|---|---|---|
| Логические приложения | Стандарт | Все регионы Logic Apps , кроме следующих: — Регионы Azure для государственных организаций - Azure регионы Китая - Министерство обороны США (DoD) |
| Контакт | |
|---|---|
| Имя | Microsoft Dynamics |
| URL | https://aka.ms/iomsupport |
| Эл. почта | iomdri@microsoft.com |
| Метаданные соединителя | |
|---|---|
| Publisher | Корпорация Майкрософт |
| Веб-сайт | https://www.fedex.com/ |
| Политика конфиденциальности | https://www.fedex.com/en-us/trust-center.html |
| Категории | Торговля; Управление бизнесом |
Соединитель FedEx Dataworks специально разработан для интеграции поставщика управления интеллектуальными заказами Dynamics 365.
Необходимые условия
Обратитесь к FedEx для процесса подключения.
Примечание. Рекомендуется использовать этот соединитель специально для настройки поставщика Dynamics 365 Intelligent Order Management FedEx.
Получение учетных данных
- В рамках процесса подключения каждый бренд будет необходим для создания пары ключей PGP, чтобы команда разработчиков Dataworks могли зашифровать свои учетные данные идентификатора Microsoft Entra ID. Для выполнения шифрования необходимо отправить открытый ключ группе разработки Dataworks.
- Пару ключей PGP можно создать с помощью GnuPG. Его можно скачать по данной ссылке: https://gpg4win.org/get-gpg4win.html
- После подготовки секрета клиента командой разработки Dataworks ключ будет отправлен в бренд. После того как бренд владеет ключом, его можно расшифровать.
- Дополнительные сведения будут предоставляться в рамках процесса подключения.
Начало работы с соединителем
Следуйте инструкциям https://docs.microsoft.com/en-us/dynamics365/intelligent-order-management/work-providers#set-up-a-provider , чтобы включить поставщик FedEx с учетными данными клиента.
Известные проблемы и ограничения
Этот соединитель специально разработан для интеграции поставщика FedEx в Dynamics 365 Intelligent Order Management. Поддержка вариантов использования за пределами Dynamics 365 Intelligent Order Management будет ограничена.
Создание подключения
Соединитель поддерживает следующие типы проверки подлинности:
| По умолчанию | Параметры для создания подключения. | Все регионы | Недоступен для совместного использования |
По умолчанию
Применимо: все регионы
Параметры для создания подключения.
Это недоступно для общего доступа. Если приложение power предоставляется другому пользователю, пользователю будет предложено явно создать новое подключение.
| Имя | Тип | Описание | Обязательный |
|---|---|---|---|
| идентификатор клиента | струна | Идентификатор клиента FedEx Dataworks | True |
| Секрет клиента | securestring | Секрет клиента FedEx Dataworks | True |
Ограничения регулирования
| Имя | Вызовы | Период обновления |
|---|---|---|
| Вызовы API для каждого подключения | 100 | 60 секунд |
| Частота опросов триггеров | 1 | 15 секунд |
Действия
| Подписка на веб-перехватчик для определенной компании по событию |
Подписка на веб-перехватчик для определенной компании по событию. |
| Получение показателей плана транспорта |
Получение показателей плана транспорта. |
| Получение прогнозных оценок доставки |
Получение прогнозных оценок доставки. |
| Получение сведений о списке подписок веб-перехватчика для данной компании |
Получите сведения о списке подписок веб-перехватчика для определенной компании. |
| Получение сведений о списке регистраций веб-перехватчиков по событию для определенной компании |
Получение сведений о списке регистраций веб-перехватчиков по событию для данной компании. |
| Проверка подписи уведомления веб-перехватчика HMACSHA256 |
Проверка подписи уведомления веб-перехватчика HMACSHA256. |
| Удаление подписки веб-перехватчика для определенной компании по событию |
Удаление подписки веб-перехватчика для определенной компании по событию. |
| Удаление регистрации веб-перехватчика для определенной компании по событию |
Удаление регистрации веб-перехватчика для определенной компании по событию. |
Подписка на веб-перехватчик для определенной компании по событию
Подписка на веб-перехватчик для определенной компании по событию.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
событие
|
event | True | string |
Тип события— EDD_CHANGED или EDTW_CHANGED. |
|
идентификатор регистрации
|
registrationId | True | string |
WebhookId, созданный при регистрации для веб-перехватчика. |
|
callbackUrl
|
callbackUrl | string |
URL-адрес обратного вызова клиента, используемый для отправки обновлений, если они решили переопределить те, которые используются при регистрации. |
|
|
ключ
|
key | True | string |
Допустимые способы, которыми компания может отслеживать свои данные- trackingNumber. |
|
values
|
values | True | array of string |
Отслеживание идентификаторов, заинтересованных в получении обновлений состояния. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Успешной
|
successful | boolean |
Верно или неверно. |
|
Код ошибки
|
errorCode | string |
Код ошибки. |
|
errorMessage
|
errorMessage | string |
Сообщение об ошибке. |
|
subscriptionId
|
subscriptionId | array of string |
Список вставленных идентификаторов подписки. |
Получение показателей плана транспорта
Получение показателей плана транспорта.
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Код состояния HTTP
|
httpStatusCode | integer |
Код состояния HTTP ответа. |
|
responseDateTime
|
data.responseDateTime | string |
Время ответа. |
|
transportationPlanScores
|
data.transportationPlanScores | array of object |
Список планов транспорта с оценками. |
|
planId
|
data.transportationPlanScores.planId | string |
Уникальный идентификатор плана. |
|
value
|
data.transportationPlanScores.score.value | string |
Порядковый порядковый масштаб целых чисел. |
|
confidence
|
data.transportationPlanScores.score.confidence | string |
Сведения о достоверности. |
|
shipmentServiceConditions
|
data.transportationPlanScores.shipmentServiceConditions | array of object |
Условия доставки доставки. |
|
shipmentId
|
data.transportationPlanScores.shipmentServiceConditions.shipmentId | string |
Уникальный идентификатор отгрузки. |
|
serviceCode
|
data.transportationPlanScores.shipmentServiceConditions.recommendedTransportationService.serviceCode | string |
Код службы для доставки доставки. |
|
carrier
|
data.transportationPlanScores.shipmentServiceConditions.recommendedTransportationService.carrier | string |
Сведения о перевозчике. |
|
estimatedDeliveryDate
|
data.transportationPlanScores.shipmentServiceConditions.recommendedTransportationService.estimatedDeliveryDate | string |
Оценочная дата поставки. |
|
results
|
results | array of object |
Список результатов, содержащих состояние. |
|
статус
|
results.status | array of object | |
|
код
|
results.status.code | string |
Ошибка или информационный код для ответов. |
|
severity
|
results.status.severity | string |
Серьезность состояния в ответе может быть ERROR/FATAL/INFO. |
|
сообщение
|
results.status.message | string |
Сообщение, описывающее приведенный выше код. |
|
путь
|
results.status.path | string |
Путь к полю, для которого предоставляется состояние. |
|
helpUrl
|
results.status.helpUrl | string |
URL-адрес для получения дополнительных сведений о коде и сообщении. |
|
рекомендуемыеretryMinutes
|
results.status.recommendedRetryMinutes | integer |
Повторите попытку в минутах, для которых один и тот же запрос можно повторить. |
|
версия
|
version | string |
Версия API. |
|
requestTimeStamp
|
requestTimeStamp | string |
Дата запроса. |
Получение прогнозных оценок доставки
Получение прогнозных оценок доставки.
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
originofpackage
|
responsebody.originofpackage | string |
Источник пакета |
|
destinationofpackage
|
responsebody.destinationofpackage | string |
Назначение пакета |
|
datetimeofpossession
|
responsebody.datetimeofpossession | string |
Дата и время владения |
|
edds
|
responsebody.edds | array of object |
edds |
|
requestid
|
responsebody.metadata.requestid | string |
Requestid |
|
shipperId
|
responsebody.metadata.shipperId | string |
ShipperId |
Получение сведений о списке подписок веб-перехватчика для данной компании
Получите сведения о списке подписок веб-перехватчика для определенной компании.
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Успешной
|
successful | boolean |
Верно или неверно. |
|
Код ошибки
|
errorCode | string |
Код ошибки. |
|
errorMessage
|
errorMessage | string |
Сообщение об ошибке. |
|
subscriptionId
|
subscriptionId | array of string |
Список идентификаторов подписки. |
Получение сведений о списке регистраций веб-перехватчиков по событию для определенной компании
Получение сведений о списке регистраций веб-перехватчиков по событию для данной компании.
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Успешной
|
successful | boolean |
Верно или неверно. |
|
Код ошибки
|
errorCode | string |
Код ошибки. |
|
errorMessage
|
errorMessage | string |
Сообщение об ошибке. |
|
events
|
events | array of object |
Перечислить события, на которые компания зарегистрировалась. |
|
authUrl
|
events.authUrl | string |
Конечная точка авторизации OAuth2 клиента. |
|
callbackUrl
|
events.callbackUrl | string |
URL-адрес обратного вызова клиента, используемый для отправки обновлений. |
|
callbackClientId
|
events.callbackClientId | string |
Идентификатор клиента, используемый для авторизации среды клиента. |
|
callbackSignatureAlgorithm
|
events.callbackSignatureAlgorithm | string |
Сигнатура algorithim используется для создания подписи для этой полезных данных с помощью hmac-sha256. |
|
идентификатор регистрации
|
events.registrationId | string |
Идентификатор, который однозначно идентифицирует указанную регистрацию. |
Проверка подписи уведомления веб-перехватчика HMACSHA256
Проверка подписи уведомления веб-перехватчика HMACSHA256.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Подпись сообщения
|
MessageSignature | True | string |
Подпись сообщения для проверки. |
|
Секретный ключ
|
SecretKey | True | string |
Секретный ключ для HMAC. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
isValid
|
isValid | boolean |
isValid |
Удаление подписки веб-перехватчика для определенной компании по событию
Удаление подписки веб-перехватчика для определенной компании по событию.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор подстроки
|
subscriptionId | True | string |
Идентификатор подстроки для удаления. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Успешной
|
successful | boolean |
Верно или неверно. |
|
Код ошибки
|
errorCode | string |
Код ошибки. |
|
errorMessage
|
errorMessage | string |
Сообщение об ошибке. |
|
subscriptionId
|
subscriptionId | string |
Удаленный идентификатор подписки. |
Удаление регистрации веб-перехватчика для определенной компании по событию
Удаление регистрации веб-перехватчика для определенной компании по событию.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор регистрации
|
registrationId | string |
Идентификатор регистрации для удаления. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Успешной
|
successful | boolean |
Верно или неверно. |
|
Код ошибки
|
errorCode | string |
Код ошибки. |
|
errorMessage
|
errorMessage | string |
Сообщение об ошибке. |
Триггеры
| Регистрация веб-перехватчика для определенной компании по событию |
Регистрация веб-перехватчика для определенной компании по событию. |
Регистрация веб-перехватчика для определенной компании по событию
Регистрация веб-перехватчика для определенной компании по событию.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
событие
|
event | True | string |
Тип события— EDD_CHANGED или EDTW_CHANGED. |
|
callbackSignatureSecretKey
|
callbackSignatureSecretKey | True | string |
Клиент предоставляет секрет для создания подписи с обратным вызовом. |
|
callbackAuthUrl
|
callbackAuthUrl | string |
Конечная точка авторизации OAuth2 клиента. |
|
|
callbackClientId
|
callbackClientId | string |
Идентификатор клиента, используемый для авторизации среды клиента. |
|
|
callbackClientSecret
|
callbackClientSecret | string |
Зашифрованный секрет клиента, используемый для авторизации среды клиента. |
|
|
callbackSignatureAlgorithm
|
callbackSignatureAlgorithm | True | string |
Сигнатура algorithim используется для создания подписи для этой полезных данных с помощью hmac-sha256. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
ftmTrackingNumber
|
ftmTrackingNumber | string |
Идентификатор отгрузки. |
|
ftmTrackingQualifier
|
ftmTrackingQualifier | string |
Квалификатор используется для уникальной идентификации отгрузки в OpCo. |
|
ftmTrackingCarrier
|
ftmTrackingCarrier | string |
Оператор пакета OpCo. |
|
eddTime
|
eddTime | string |
Прогноз предполагаемой даты доставки из GDPP. |
|
eddPrevTime
|
eddPrevTime | string |
Предыдущий EDD. |
|
eddStatus
|
eddStatus | string |
РАННИЕ или ОТЛОЖЕННЫЕ ИЛИ ОТЛОЖЕННЫЕ. |
|
eddChanged
|
eddChanged | string |
Флаг, указывающий, что прогноз EDD изменился. 1 представляет, что произошло изменение EDD. |
|
eddDelaysRiskScore
|
eddDelaysRiskScore | string |
Оценка риска EDD, которая позволяет потребителям принимать решения о том, как использовать информацию прогнозирования. |
|
eddDelayTypeCode
|
eddDelayTypeCode | string |
Задержка кода причины. Пример OP — операционный, WE — погода. |
|
edtwBegin
|
edtwBegin | string |
Начало предполагаемого периода времени доставки. |
|
edtwEnd
|
edtwEnd | string |
Окончание предполагаемого периода времени доставки. |
|
edtwPrevBegin
|
edtwPrevBegin | string |
Начальное значение предыдущего предполагаемого периода времени доставки. |
|
edtwPrevEnd
|
edtwPrevEnd | string |
Предыдущее предполагаемое значение окна времени доставки. |
|
edtwChanged
|
edtwChanged | string |
Флаг, указывающий, что прогноз EDTW изменился. 1 представляет, что произошло изменение EDTW. |
|
edtwDelaysRiskScore
|
edtwDelaysRiskScore | string |
Оценка рисков EDTW для нижнего порогового значения потребителей. |