FedEx Dataworks (wersja zapoznawcza)
Firma FedEx Corp oferuje klientom i firmom na całym świecie szerokie portfolio usług transportowych, handlu elektronicznego i biznesowych. Połącz się z interfejsem API usługi Transport Selection Service, aby otrzymywać rekomendacje dotyczące klasyfikacji i usług w planach transportu.
Ten łącznik jest dostępny w następujących produktach i regionach:
| Service | Klasa | Regiony |
|---|---|---|
| Logic Apps | Standard | Wszystkie regiony usługi Logic Apps z wyjątkiem następujących: - Azure Government regionów - Azure regionach Chin - Departament Obrony USA (DoD) |
| Kontakt biznesowy | |
|---|---|
| Nazwa | Microsoft Dynamics |
| adres URL | https://aka.ms/iomsupport |
| iomdri@microsoft.com |
| Metadane łącznika | |
|---|---|
| Publisher | Microsoft |
| Witryna internetowa | https://www.fedex.com/ |
| Zasady ochrony prywatności | https://www.fedex.com/en-us/trust-center.html |
| Kategorie | Handel; Zarządzanie biznesem |
Łącznik FedEx Dataworks został specjalnie opracowany do obsługi integracji dostawcy usług Dynamics 365 Intelligent Order Management.
Wymagania wstępne
Skontaktuj się z firmą FedEx w celu uzyskania procesu dołączania.
Uwaga: zaleca się użycie tego łącznika w szczególności do skonfigurowania dostawcy usługi Dynamics 365 Intelligent Order Management FedEx.
Jak uzyskać poświadczenia
- W ramach procesu dołączania każda marka będzie wymagana do wygenerowania pary kluczy PGP, aby zespół deweloperów usługi Dataworks mógł zaszyfrować swoje poświadczenia identyfikatora Entra firmy Microsoft. Klucz publiczny musi zostać wysłany do zespołu deweloperów usługi Dataworks w celu przeprowadzenia szyfrowania.
- Para kluczy PGP może być generowana przy użyciu systemu GnuPG. Można go pobrać z podanego linku: https://gpg4win.org/get-gpg4win.html
- Po aprowizacji wpisu tajnego klienta przez zespół deweloperów usługi Dataworks klucz zostanie wysłany do marki. Gdy marka jest w posiadaniu klucza, można go odszyfrować.
- Dodatkowe szczegóły zostaną udostępnione w ramach procesu dołączania.
Wprowadzenie do łącznika
Postępuj zgodnie z instrukcjami https://docs.microsoft.com/en-us/dynamics365/intelligent-order-management/work-providers#set-up-a-provider , aby włączyć dostawcę FedEx przy użyciu poświadczeń klienta.
Znane problemy i ograniczenia
Ten łącznik został specjalnie opracowany do użycia na potrzeby integracji dostawcy FedEx usługi Dynamics 365 Intelligent Order Management. Obsługa przypadków użycia poza usługą Dynamics 365 Intelligent Order Management będzie ograniczona.
Tworzenie połączenia
Łącznik obsługuje następujące typy uwierzytelniania:
| Wartość domyślna | Parametry tworzenia połączenia. | Wszystkie regiony | Nie można udostępniać |
Domyślny
Dotyczy: wszystkie regiony
Parametry tworzenia połączenia.
Nie jest to możliwe do udostępnienia połączenie. Jeśli aplikacja power zostanie udostępniona innemu użytkownikowi, zostanie wyświetlony monit o jawne utworzenie nowego połączenia.
| Nazwa | Typ | Opis | Wymagane |
|---|---|---|---|
| identyfikator klienta | ciąg | Identyfikator klienta FedEx Dataworks | Prawda |
| Tajemnica klienta | securestring | Wpis tajny klienta FedEx Dataworks | Prawda |
Limity ograniczania
| Nazwa | Wywołania | Okres odnowienia |
|---|---|---|
| Wywołania interfejsu API na połączenie | 100 | 60 sekund |
| Częstotliwość sond wyzwalacza | 1 | 15 sekund |
Akcje
| Pobieranie oszacowań dostarczania predykcyjnego |
Uzyskiwanie oszacowań dostarczania predykcyjnego. |
| Subskrypcja elementu webhook dla danej firmy według zdarzenia |
Subskrypcja elementu webhook dla danej firmy według zdarzenia. |
| Usuwanie rejestracji elementu webhook dla danej firmy według zdarzenia |
Usuń rejestrację elementu webhook dla danej firmy według zdarzenia. |
| Usuwanie subskrypcji elementu webhook dla danej firmy według zdarzenia |
Usuń subskrypcję elementu webhook dla danej firmy według zdarzenia. |
| Uzyskiwanie informacji na temat listy rejestracji elementów webhook według zdarzenia dla danej firmy |
Uzyskaj informacje na temat listy rejestracji elementów webhook według zdarzenia dla danej firmy. |
| Uzyskiwanie informacji na temat listy subskrypcji elementów webhook dla danej firmy |
Uzyskaj informacje na temat listy subskrypcji elementów webhook dla danej firmy. |
| Uzyskiwanie wyników planu transportu |
Uzyskaj wyniki planu transportu. |
| Weryfikowanie podpisu HMACSHA256 powiadomienia elementu webhook |
Zweryfikuj pozycję Powiadomienie elementu webhook HMACSHA256 Signature. |
Pobieranie oszacowań dostarczania predykcyjnego
Uzyskiwanie oszacowań dostarczania predykcyjnego.
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
originofpackage
|
responsebody.originofpackage | string |
Źródło pakietu |
|
destinationofpackage
|
responsebody.destinationofpackage | string |
Miejsce docelowe pakietu |
|
datetimeofpossession
|
responsebody.datetimeofpossession | string |
Data/godzina posiadania |
|
edds
|
responsebody.edds | array of object |
edds |
|
Requestid
|
responsebody.metadata.requestid | string |
Requestid |
|
shipperId
|
responsebody.metadata.shipperId | string |
Identyfikator nadawcy |
Subskrypcja elementu webhook dla danej firmy według zdarzenia
Subskrypcja elementu webhook dla danej firmy według zdarzenia.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
wydarzenie
|
event | True | string |
Typ zdarzenia — EDD_CHANGED lub EDTW_CHANGED. |
|
identyfikator rejestracji
|
registrationId | True | string |
WebhookId wygenerowany podczas rejestrowania dla elementu webhook. |
|
callbackUrl (adres URL wywołania zwrotnego)
|
callbackUrl | string |
Adres URL wywołania zwrotnego klienta używany do wysyłania aktualizacji, jeśli zdecyduje się zastąpić te używane podczas rejestracji. |
|
|
klucz
|
key | True | string |
Dozwolone sposoby, w jakie firma może śledzić swoje informacje — trackingNumber. |
|
values
|
values | True | array of string |
Identyfikatory śledzenia zainteresowanych otrzymywaniem aktualizacji stanu. |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
udany
|
successful | boolean |
Prawda czy fałsz? |
|
kod błędu
|
errorCode | string |
Kod błędu. |
|
errorMessage
|
errorMessage | string |
Komunikat o błędzie. |
|
Identyfikator subskrypcji
|
subscriptionId | array of string |
Lista wstawionych identyfikatorów subskrypcji. |
Usuwanie rejestracji elementu webhook dla danej firmy według zdarzenia
Usuń rejestrację elementu webhook dla danej firmy według zdarzenia.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator rejestracji
|
registrationId | string |
Identyfikator rejestracji do usunięcia. |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
udany
|
successful | boolean |
Prawda czy fałsz? |
|
kod błędu
|
errorCode | string |
Kod błędu. |
|
errorMessage
|
errorMessage | string |
Komunikat o błędzie. |
Usuwanie subskrypcji elementu webhook dla danej firmy według zdarzenia
Usuń subskrypcję elementu webhook dla danej firmy według zdarzenia.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator indeksu dolnego
|
subscriptionId | True | string |
Identyfikator indeksu do usunięcia. |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
udany
|
successful | boolean |
Prawda czy fałsz? |
|
kod błędu
|
errorCode | string |
Kod błędu. |
|
errorMessage
|
errorMessage | string |
Komunikat o błędzie. |
|
Identyfikator subskrypcji
|
subscriptionId | string |
Usunięty identyfikator subskrypcji. |
Uzyskiwanie informacji na temat listy rejestracji elementów webhook według zdarzenia dla danej firmy
Uzyskaj informacje na temat listy rejestracji elementów webhook według zdarzenia dla danej firmy.
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
udany
|
successful | boolean |
Prawda czy fałsz? |
|
kod błędu
|
errorCode | string |
Kod błędu. |
|
errorMessage
|
errorMessage | string |
Komunikat o błędzie. |
|
events
|
events | array of object |
Wyświetlanie listy zdarzeń zarejestrowanych przez daną firmę. |
|
authUrl (Adres URL uwierzytelniania)
|
events.authUrl | string |
Punkt końcowy autoryzacji OAuth2 klienta. |
|
callbackUrl (adres URL wywołania zwrotnego)
|
events.callbackUrl | string |
Adres URL wywołania zwrotnego klienta używany do wysyłania aktualizacji. |
|
callbackClientId
|
events.callbackClientId | string |
Identyfikator klienta używany do autoryzacji środowiska klienta. |
|
callbackSignatureAlgorithm
|
events.callbackSignatureAlgorithm | string |
Sygnatura algorithim służy do generowania podpisu dla tego ładunku przy użyciu hmac-sha256. |
|
identyfikator rejestracji
|
events.registrationId | string |
Identyfikator, który jednoznacznie identyfikuje daną rejestrację. |
Uzyskiwanie informacji na temat listy subskrypcji elementów webhook dla danej firmy
Uzyskaj informacje na temat listy subskrypcji elementów webhook dla danej firmy.
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
udany
|
successful | boolean |
Prawda czy fałsz? |
|
kod błędu
|
errorCode | string |
Kod błędu. |
|
errorMessage
|
errorMessage | string |
Komunikat o błędzie. |
|
Identyfikator subskrypcji
|
subscriptionId | array of string |
Lista pobranych identyfikatorów subskrypcji. |
Uzyskiwanie wyników planu transportu
Uzyskaj wyniki planu transportu.
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
kod stanu HTTP
|
httpStatusCode | integer |
Kod stanu HTTP odpowiedzi. |
|
responseDateTime
|
data.responseDateTime | string |
Data i godzina odpowiedzi. |
|
transportationPlanScores
|
data.transportationPlanScores | array of object |
Lista planów transportu z wynikami. |
|
identyfikator planu
|
data.transportationPlanScores.planId | string |
Unikatowy identyfikator planu. |
|
wartość
|
data.transportationPlanScores.score.value | string |
Porządkowa rosnąca skala liczb całkowitych. |
|
pewność
|
data.transportationPlanScores.score.confidence | string |
Szczegóły ufności. |
|
shipmentServiceConditions
|
data.transportationPlanScores.shipmentServiceConditions | array of object |
Warunki usługi dostarczania przesyłki. |
|
identyfikator wysyłki
|
data.transportationPlanScores.shipmentServiceConditions.shipmentId | string |
Unikatowy identyfikator przesyłki. |
|
serviceCode
|
data.transportationPlanScores.shipmentServiceConditions.recommendedTransportationService.serviceCode | string |
Kod usługi do dostarczania przesyłki. |
|
operator
|
data.transportationPlanScores.shipmentServiceConditions.recommendedTransportationService.carrier | string |
Informacje o przewoźniku. |
|
estimatedDeliveryDate
|
data.transportationPlanScores.shipmentServiceConditions.recommendedTransportationService.estimatedDeliveryDate | string |
Szacowana data dostawy przesyłki. |
|
results
|
results | array of object |
Lista wyników zawierających stan. |
|
stan
|
results.status | array of object | |
|
kod
|
results.status.code | string |
Błąd lub kod informacyjny odpowiedzi. |
|
severity
|
results.status.severity | string |
Ważność stanu w odpowiedzi może mieć wartość ERROR/FATAL/INFO. |
|
komunikat
|
results.status.message | string |
Komunikat opisujący powyższy kod. |
|
ścieżka
|
results.status.path | string |
Ścieżka pola, dla którego podano stan. |
|
helpUrl
|
results.status.helpUrl | string |
Adres URL umożliwiający uzyskanie dodatkowych informacji na temat kodu i komunikatu. |
|
recommendedRetryMinutes
|
results.status.recommendedRetryMinutes | integer |
Ponów próbę minut, dla których można ponowić próbę tego samego żądania. |
|
wersja
|
version | string |
Wersja interfejsu API. |
|
requestTimeStamp
|
requestTimeStamp | string |
Data i godzina żądania. |
Weryfikowanie podpisu HMACSHA256 powiadomienia elementu webhook
Zweryfikuj pozycję Powiadomienie elementu webhook HMACSHA256 Signature.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Podpis wiadomości
|
MessageSignature | True | string |
Podpis wiadomości w celu zweryfikowania. |
|
Klucz tajny
|
SecretKey | True | string |
Klucz tajny dla HMAC. |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
isValid
|
isValid | boolean |
isValid |
Wyzwalacze
| Rejestracja elementu webhook dla danej firmy według zdarzenia |
Rejestracja elementu webhook dla danej firmy według zdarzenia. |
Rejestracja elementu webhook dla danej firmy według zdarzenia
Rejestracja elementu webhook dla danej firmy według zdarzenia.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
wydarzenie
|
event | True | string |
Typ zdarzenia — EDD_CHANGED lub EDTW_CHANGED. |
|
callbackSignatureSecretKey
|
callbackSignatureSecretKey | True | string |
Klient udostępnia wpis tajny do utworzenia podpisu za pomocą wywołania zwrotnego. |
|
callbackAuthUrl
|
callbackAuthUrl | string |
Punkt końcowy autoryzacji OAuth2 klienta. |
|
|
callbackClientId
|
callbackClientId | string |
Identyfikator klienta używany do autoryzacji środowiska klienta. |
|
|
callbackClientSecret
|
callbackClientSecret | string |
Klucz tajny zaszyfrowanego klienta używany do autoryzacji środowiska klienta. |
|
|
callbackSignatureAlgorithm
|
callbackSignatureAlgorithm | True | string |
Sygnatura algorithim służy do generowania podpisu dla tego ładunku przy użyciu hmac-sha256. |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
ftmTrackingNumber
|
ftmTrackingNumber | string |
Identyfikator przesyłki. |
|
ftmTrackingQualifier
|
ftmTrackingQualifier | string |
Kwalifikator służy do unikatowego identyfikowania przesyłki w ramach OpCo. |
|
ftmTrackingCarrier
|
ftmTrackingCarrier | string |
OpCo operatora pakietów. |
|
eddTime
|
eddTime | string |
Szacowana data dostawy z PKBP. |
|
eddPrevTime
|
eddPrevTime | string |
Poprzednia EDD. |
|
eddStatus
|
eddStatus | string |
WCZEŚNIE LUB ONTIME LUB OPÓŹNIONE. |
|
eddChanged
|
eddChanged | string |
Flaga wskazująca, że przewidywanie EDD uległo zmianie. 1 oznacza, że nastąpiła zmiana EDD. |
|
eddDelaysRiskScore
|
eddDelaysRiskScore | string |
Ocena ryzyka EDD, która umożliwia konsumentom podejmowanie decyzji dotyczących sposobu korzystania z informacji o przewidywaniu. |
|
eddDelayTypeCode
|
eddDelayTypeCode | string |
Kod przyczyny opóźnienia. Przykład OP — operacyjne, WE — pogoda. |
|
edtwBegin
|
edtwBegin | string |
Początek szacowanego przedziału czasu dostawy. |
|
edtwEnd
|
edtwEnd | string |
Koniec szacowanego przedziału czasu dostawy. |
|
edtwPrevBegin
|
edtwPrevBegin | string |
Poprzednia szacowana wartość okna czasu dostarczenia. |
|
edtwPrevEnd
|
edtwPrevEnd | string |
Poprzednia szacowana wartość zakończenia przedziału czasu dostawy. |
|
edtwChanged
|
edtwChanged | string |
Flaga wskazująca, że przewidywanie EDTW uległo zmianie. 1 oznacza, że nastąpiła zmiana EDTW. |
|
edtwDelaysRiskScore
|
edtwDelaysRiskScore | string |
Wskaźnik ryzyka EDTW dla progów odbiorców podrzędnych. |