FedEx Dataworks (versão prévia)
A FedEx Corp. fornece aos clientes e empresas em todo o mundo um amplo portfólio de serviços de transporte, comércio eletrônico e negócios. Conecte-se à API do Serviço de Seleção de Transporte para receber a classificação e a recomendação de serviço nos planos de transporte.
Esse conector está disponível nos seguintes produtos e regiões:
| Service | Classe | Regions |
|---|---|---|
| Aplicativos Lógicos | Standard | Todas as regiões dos Aplicativos Lógicos , exceto as seguintes: – Azure Government regiões - Azure regiões da China - Departamento de Defesa dos EUA (DoD) |
| Contato | |
|---|---|
| Nome | Microsoft Dynamics |
| URL | https://aka.ms/iomsupport |
| iomdri@microsoft.com |
| Metadados do conector | |
|---|---|
| Publicador | Microsoft |
| Site | https://www.fedex.com/ |
| Política de privacidade | https://www.fedex.com/en-us/trust-center.html |
| Categorias | Comércio; Gestão de empresas |
O conector do FedEx Dataworks foi desenvolvido especificamente para ser usado para a integração do Provedor do Dynamics 365 Intelligent Order Management.
Pré-requisitos
Entre em contato com a FedEx para o processo de integração.
Observação: é recomendável usar esse conector especificamente para configurar o provedor FedEx do Gerenciamento inteligente de pedidos do Dynamics 365.
Como obter credenciais
- Como parte do processo de integração, cada marca será necessária para gerar um par de chaves PGP para que a equipe de desenvolvimento do Dataworks possa criptografar suas credenciais de ID do Microsoft Entra. A chave pública deve ser enviada à equipe de Desenvolvimento do Dataworks para executar a criptografia.
- O par de chaves PGP pode ser gerado usando o GnuPG. Ele pode ser baixado no link especificado: https://gpg4win.org/get-gpg4win.html
- Depois que o segredo do cliente for provisionado pela equipe de Desenvolvimento do Dataworks, a chave será enviada para a marca. Depois que a marca estiver em posse da chave, ela poderá ser descriptografada.
- Detalhes adicionais serão compartilhados como parte do processo de integração.
Introdução ao conector
Siga https://docs.microsoft.com/en-us/dynamics365/intelligent-order-management/work-providers#set-up-a-provider para habilitar o Provedor FedEx com as Credenciais do Cliente.
Problemas e limitações conhecidos
Esse conector foi desenvolvido especificamente para ser usado para a integração do FedEx Provider do Dynamics 365 Intelligent Order Management. O suporte para casos de uso fora do Dynamics 365 Intelligent Order Management será limitado.
Criando uma conexão
O conector dá suporte aos seguintes tipos de autenticação:
| Default | Parâmetros para criar conexão. | Todas as regiões | Não compartilhável |
Padrão
Aplicável: todas as regiões
Parâmetros para criar conexão.
Essa não é uma conexão compartilhável. Se o aplicativo de energia for compartilhado com outro usuário, outro usuário será solicitado a criar uma nova conexão explicitamente.
| Nome | Tipo | Descrição | Obrigatório |
|---|---|---|---|
| ID do cliente | cadeia | ID do cliente FedEx Dataworks | Verdade |
| Segredo de Cliente | secureString | Segredo do cliente FedEx Dataworks | Verdade |
Limitações
| Nome | Chamadas | Período de renovação |
|---|---|---|
| Chamadas à API por conexão | 100 | 60 segundos |
| Frequência das pesquisas de gatilho | 1 | 15 s |
Ações
| Assinatura do Webhook para uma determinada empresa por evento |
Assinatura do Webhook para uma determinada empresa por evento. |
| Excluir assinatura do Webhook para uma determinada empresa por evento |
Exclua a assinatura do Webhook para uma determinada empresa por evento. |
| Excluir o registro do Webhook para uma determinada empresa por evento |
Exclua o registro do Webhook para uma determinada empresa por evento. |
| Obter estimativas de entrega preditiva |
Obtenha estimativas de entrega preditiva. |
| Obter informações sobre a lista de assinaturas do Webhook para uma determinada empresa |
Obtenha informações sobre a lista de assinaturas do Webhook para uma determinada empresa. |
| Obter informações sobre a lista de registros do Webhook por evento para uma determinada empresa |
Obtenha informações sobre a lista de registros do Webhook por evento para uma determinada empresa. |
| Obter pontuações do plano de transporte |
Obter pontuações do plano de transporte. |
| Validar assinatura de HMACSHA256 de notificação do Webhook |
Validar a Notificação do Webhook HMACSHA256 Assinatura. |
Assinatura do Webhook para uma determinada empresa por evento
Assinatura do Webhook para uma determinada empresa por evento.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
evento
|
event | True | string |
Tipo de evento- EDD_CHANGED ou EDTW_CHANGED. |
|
registrationId
|
registrationId | True | string |
WebhookId gerado ao se registrar no webhook. |
|
callbackUrl
|
callbackUrl | string |
URL de retorno de chamada do cliente usada para enviar atualizações se optar por substituir as usadas no registro. |
|
|
chave
|
key | True | string |
Maneiras permitidos de uma empresa acompanhar suas informações– trackingNumber. |
|
values
|
values | True | array of string |
Acompanhamento de IDs interessadas em receber atualizações de status. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
com êxito
|
successful | boolean |
Verdadeiro ou falso. |
|
código de erro
|
errorCode | string |
Código de erro. |
|
errorMessage
|
errorMessage | string |
Mensagem de erro. |
|
subscriptionId
|
subscriptionId | array of string |
Lista de IDs de Assinatura Inseridas. |
Excluir assinatura do Webhook para uma determinada empresa por evento
Exclua a assinatura do Webhook para uma determinada empresa por evento.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Subscripton Id
|
subscriptionId | True | string |
ID do subscripton a ser excluída. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
com êxito
|
successful | boolean |
Verdadeiro ou falso. |
|
código de erro
|
errorCode | string |
Código de erro. |
|
errorMessage
|
errorMessage | string |
Mensagem de erro. |
|
subscriptionId
|
subscriptionId | string |
ID da assinatura excluída. |
Excluir o registro do Webhook para uma determinada empresa por evento
Exclua o registro do Webhook para uma determinada empresa por evento.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID de registro
|
registrationId | string |
ID de registro a ser excluída. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
com êxito
|
successful | boolean |
Verdadeiro ou falso. |
|
código de erro
|
errorCode | string |
Código de erro. |
|
errorMessage
|
errorMessage | string |
Mensagem de erro. |
Obter estimativas de entrega preditiva
Obtenha estimativas de entrega preditiva.
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
originofpackage
|
responsebody.originofpackage | string |
Origem do pacote |
|
destinationofpackage
|
responsebody.destinationofpackage | string |
Destino do pacote |
|
datetimeofpossession
|
responsebody.datetimeofpossession | string |
Datetime de posse |
|
Edds
|
responsebody.edds | array of object |
Edds |
|
Requestid
|
responsebody.metadata.requestid | string |
Requestid |
|
shipperId
|
responsebody.metadata.shipperId | string |
ShipperId |
Obter informações sobre a lista de assinaturas do Webhook para uma determinada empresa
Obtenha informações sobre a lista de assinaturas do Webhook para uma determinada empresa.
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
com êxito
|
successful | boolean |
Verdadeiro ou falso. |
|
código de erro
|
errorCode | string |
Código de erro. |
|
errorMessage
|
errorMessage | string |
Mensagem de erro. |
|
subscriptionId
|
subscriptionId | array of string |
Lista de IDs de assinatura buscadas. |
Obter informações sobre a lista de registros do Webhook por evento para uma determinada empresa
Obtenha informações sobre a lista de registros do Webhook por evento para uma determinada empresa.
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
com êxito
|
successful | boolean |
Verdadeiro ou falso. |
|
código de erro
|
errorCode | string |
Código de erro. |
|
errorMessage
|
errorMessage | string |
Mensagem de erro. |
|
events
|
events | array of object |
Listar eventos para os quais uma determinada empresa se inscreveu. |
|
authUrl
|
events.authUrl | string |
Ponto de extremidade de autorização OAuth2 do cliente. |
|
callbackUrl
|
events.callbackUrl | string |
URL de retorno de chamada do cliente usada para enviar atualizações. |
|
callbackClientId
|
events.callbackClientId | string |
ID do cliente usada para autorização do ambiente do cliente. |
|
callbackSignatureAlgorithm
|
events.callbackSignatureAlgorithm | string |
A assinatura algorithim é usada para gerar a assinatura para esse conteúdo usando o hmac-sha256. |
|
registrationId
|
events.registrationId | string |
Um identificador que identifica exclusivamente o registro especificado. |
Obter pontuações do plano de transporte
Obter pontuações do plano de transporte.
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
httpStatusCode
|
httpStatusCode | integer |
Código de resposta de Status Http. |
|
responseDateTime
|
data.responseDateTime | string |
Data e hora da resposta. |
|
transportationPlanScores
|
data.transportationPlanScores | array of object |
Lista de planos de transporte com pontuações. |
|
planId
|
data.transportationPlanScores.planId | string |
Identificador exclusivo do plano. |
|
value
|
data.transportationPlanScores.score.value | string |
Escala ordinal crescente de inteiros. |
|
confiança
|
data.transportationPlanScores.score.confidence | string |
Detalhes de confiança. |
|
shipmentServiceConditions
|
data.transportationPlanScores.shipmentServiceConditions | array of object |
Condições do serviço de entrega de remessa. |
|
shipmentId
|
data.transportationPlanScores.shipmentServiceConditions.shipmentId | string |
Identificador exclusivo da remessa. |
|
serviceCode
|
data.transportationPlanScores.shipmentServiceConditions.recommendedTransportationService.serviceCode | string |
Código de serviço para entrega de remessa. |
|
operadora
|
data.transportationPlanScores.shipmentServiceConditions.recommendedTransportationService.carrier | string |
Informações da transportadora. |
|
estimatedDeliveryDate
|
data.transportationPlanScores.shipmentServiceConditions.recommendedTransportationService.estimatedDeliveryDate | string |
Data de entrega estimada da remessa. |
|
results
|
results | array of object |
Lista de resultados que contêm status. |
|
status
|
results.status | array of object | |
|
codificar
|
results.status.code | string |
Erro ou código informativo para respostas. |
|
gravidade
|
results.status.severity | string |
A gravidade do status em resposta pode ser ERROR/FATAL/INFO. |
|
mensagem
|
results.status.message | string |
Mensagem que descreve o código acima. |
|
caminho
|
results.status.path | string |
Caminho do campo para o qual o status é fornecido. |
|
helpUrl
|
results.status.helpUrl | string |
URL para obter mais informações sobre o código e a mensagem. |
|
recommendedRetryMinutes
|
results.status.recommendedRetryMinutes | integer |
Tente novamente os minutos para os quais a mesma solicitação pode ser tentada novamente. |
|
versão
|
version | string |
Versão da API. |
|
requestTimeStamp
|
requestTimeStamp | string |
Data e hora da solicitação. |
Validar assinatura de HMACSHA256 de notificação do Webhook
Validar a Notificação do Webhook HMACSHA256 Assinatura.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Assinatura de Mensagem
|
MessageSignature | True | string |
Assinatura de Mensagem com a qual validar. |
|
Chave secreta
|
SecretKey | True | string |
Chave secreta para HMAC. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
isValid
|
isValid | boolean |
isValid |
Gatilhos
| Registro de webhook para uma determinada empresa por evento |
Registro de webhook para uma determinada empresa por evento. |
Registro de webhook para uma determinada empresa por evento
Registro de webhook para uma determinada empresa por evento.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
evento
|
event | True | string |
Tipo de evento- EDD_CHANGED ou EDTW_CHANGED. |
|
callbackSignatureSecretKey
|
callbackSignatureSecretKey | True | string |
O cliente fornece o segredo para produzir a assinatura com o retorno de chamada. |
|
callbackAuthUrl
|
callbackAuthUrl | string |
Ponto de extremidade de autorização OAuth2 do cliente. |
|
|
callbackClientId
|
callbackClientId | string |
ID do cliente usada para autorização do ambiente do cliente. |
|
|
callbackClientSecret
|
callbackClientSecret | string |
Segredo do cliente criptografado usado para autorização do ambiente do cliente. |
|
|
callbackSignatureAlgorithm
|
callbackSignatureAlgorithm | True | string |
A assinatura algorithim é usada para gerar a assinatura para esse conteúdo usando o hmac-sha256. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ftmTrackingNumber
|
ftmTrackingNumber | string |
Identificador de remessa. |
|
ftmTrackingQualifier
|
ftmTrackingQualifier | string |
O qualificador é usado para identificar exclusivamente a remessa dentro do OpCo. |
|
ftmTrackingCarrier
|
ftmTrackingCarrier | string |
OpCo da operadora de pacotes. |
|
eddTime
|
eddTime | string |
Previsão de data de entrega estimada do GDPP. |
|
eddPrevTime
|
eddPrevTime | string |
EDD anterior. |
|
eddStatus
|
eddStatus | string |
CEDO OU EM TEMPO OU ATRASADO. |
|
eddChanged
|
eddChanged | string |
Sinalizador que indica que a previsão do EDD foi alterada. 1 representa que houve uma alteração de EDD. |
|
eddDelaysRiskScore
|
eddDelaysRiskScore | string |
Pontuação de risco EDD que permite aos consumidores tomar decisões sobre como usar as informações de previsão. |
|
eddDelayTypeCode
|
eddDelayTypeCode | string |
Código de motivo de atraso. Op de exemplo – Operacional, WE – Clima. |
|
edtwBegin
|
edtwBegin | string |
Início da janela tempo de entrega estimada. |
|
edtwEnd
|
edtwEnd | string |
Fim da janela de tempo de entrega estimada. |
|
edtwPrevBegin
|
edtwPrevBegin | string |
Valor inicial da janela de tempo de entrega estimada anterior. |
|
edtwPrevEnd
|
edtwPrevEnd | string |
Valor final da janela de tempo de entrega estimado anterior. |
|
edtwChanged
|
edtwChanged | string |
Sinalizador que indica que a previsão do EDTW foi alterada. 1 representa que houve uma alteração de EDTW. |
|
edtwDelaysRiskScore
|
edtwDelaysRiskScore | string |
Pontuação de riscos edtw para limitação do consumidor downstream. |