Jak działa usługa Advanced Integrated Visibility
Omówienie elementu webhook Advanced Integrated Visibility
Element webhook Advanced Integrated Visibility umożliwia systemowi FedEx bezpieczne wysyłanie w czasie zbliżonym do rzeczywistego danych dotyczących zdarzeń monitorowania na określony docelowy adres URL w przypadku przesyłek powiązanych z konkretnymi numerami kont FedEx.
Aby można było używać tej funkcji, administrator FedEx lub administrator DI musi utworzyć projekt elementu webhook Advanced Integrated Visibility.
Opcje nawigacyjne
Dostęp do strony Elementy webhook Advanced Integrated Visibility możesz uzyskać na dwa sposoby:
Opcja 1. Przy użyciu strony Moje projekty
- Z lewego panelu nawigacyjnego przejdź do strony Moje projekty.
- Kliknij kartę Elementy webhook.
Opcja 2. Przy użyciu strony Katalog interfejsów API
- Z lewego panelu nawigacyjnego przejdź do strony Katalog interfejsów API.
- Użyj paska wyszukiwania, aby znaleźć pozycję Advanced Integrated Visibility, lub wybierz ją z sekcji FILTRY.
- Na karcie Element webhook:
- Kliknij opcję Dokumenty → kliknij opcję + Zarządzaj elementami webhook.
Wyświetlanie projektu subskrypcji Advanced Integrated Visibility opartej na numerze przesyłki
1. Dostęp osobisty do systemu FedEx i jego konfiguracja
- Administrator FedEx lub Opiekun Handlowy FedEx zainicjuje proces konfiguracji.
- Profil organizacji jest tworzony przez wyznaczonego administratora w imieniu klientów CSP.
- Numer spełniającego wymagania konta rozliczeniowego ze Stanów Zjednoczonych jest dodawany na poziomie organizacji przez administratora w imieniu klienta.
- Administrator przeprowadzający konfigurację musi mieć odpowiednie uprawnienia do zarządzania konfiguracjami na poziomie organizacji.
2. Wyświetlanie przepływu pracy dla subskrypcji opartej na numerze przesyłki
2.1. Wyświetlanie subskrypcji
- Gdy Administrator FedEx lub Opiekun Handlowy FedEx utworzy projekt, użytkownicy mogą wyświetlić na swoim pulpicie powiązany projekt subskrypcji Advanced Integrated Visibility opartej na numerze przesyłki.
2. Wyświetlanie funkcji
- Użytkownicy mogą zapoznać się z dostępnymi funkcjami powiązanymi z projektem subskrypcji w celu ich lepszego zrozumienia i wykorzystania.
Opisy funkcji
| Nazwa pola | Opis |
|---|---|
| Potwierdzenie doręczenia | Potwierdza pomyślne doręczenie przesyłki. Obejmuje:
|
| Szacowany termin doręczenia | Pomaga odbiorcom w planowaniu, ponieważ udostępnia następujące informacje:
|
| Monitorowanie zdarzeń | Umożliwia wybranie co najmniej jednej kategorii zdarzeń, których mają dotyczyć przesyłane powiadomienia:
|
Na stronie Szczegóły będą wyświetlane następujące informacje:
| Nazwa pola | Opis |
|---|---|
| Nazwa projektu elementu webhook | Unikatowa niepusta nazwa projektu elementu webhook. Proponowana nazwa jest wypełniana automatycznie, ale można ją edytować. Ta nazwa nie może powtórzyć się w żadnym innym elemencie webhook. |
| Adres URL miejsca docelowego | Bezpieczny punkt końcowy HTTPS, do którego FedEx wyśle dane zdarzenia monitorowania. Wymagania:
|
| Token zabezpieczeń | Wspólny klucz tajny do uwierzytelniania i weryfikowania odpowiedzi elementu webhook za pośrednictwem kodu HMAC. Wymagania:
|
| Język (kraj) ładunku | Wybierz z listy rozwijanej preferowany język tłumaczenia danych monitorowania. |
| Typ monitorowania | Wybierz sposób dostarczania danych monitorowania:
|
| Adres email | Podaj prawidłowy adres e-mail na potrzeby odbierania powiadomień. |
| Język (kraj) wiadomości e-mail | Wybierz preferowany język powiadomień e-mail. Uwaga: Obsługiwane są tylko ustawienia regionalne Stanów Zjednoczonych (np. en-US, es-US). |
Procedura krok po kroku
4. Tworzenie projektu subskrypcji
- Wykonaj kroki z poprzedniej sekcji lub zapoznaj się z przewodnikiem po pierwszych krokach.
5. Generowanie tokenu OAuth
- Do wykonywania wywołań API potrzebujesz tokenu OAuth.
- Użyj interfejsu API autoryzacji, aby wygenerować token.
- Szczegółowe informacje o krokach do wykonania zawiera dokumentacja interfejsu API autoryzacji dostępna w katalogu interfejsów API.
6. Uzyskiwanie dostępu do dokumentacji interfejsu API
- W lewym menu nawigacyjnym kliknij opcję Szczegóły projektu.
- Na karcie Klucze produkcyjne przewiń w dół i znajdź dokumentację interfejsu API subskrypcji Advanced Integrated Visibility opartej na numerze przesyłki.
Omówienie punktów końcowych API
| Punkt końcowy | Przeznaczenie |
|---|---|
| Powiązanie numeru przesyłki | Służy do dodawania numerów przesyłek do subskrypcji elementu webhook lub do ich usuwania. Jest to zadanie asynchroniczne. Identyfikator zadania jest zwracany w odpowiedzi. |
| Szczegóły zadania dotyczącego numerów przesyłek | Udostępnia szczegółowe informacje związane z konkretnym identyfikatorem zadania, na przykład informacje o liczbie pomyślnie dodanych lub nadal przetwarzanych numerów przesyłek. |
| Status zadań dotyczących numerów przesyłek | Zwraca podsumowanie wszystkich aktualnie przetwarzanych zadań. |
Użyj wygenerowanego tokenu OAuth (z kroku 2) z punktem końcowym Powiązanie numeru przesyłki, aby dodać numery przesyłek do elementu webhook.
Zasady weryfikacji
- Nazwy elementów webhook muszą być unikalne.
- Docelowy adres URL musi mieć standardowy format pod względem składni.
- Wszystkie wymagane pola muszą być wypełnione.
- Musi być powiązany co najmniej jeden prawidłowy numer konta wysyłkowego FedEx.
Wyniki weryfikacji
| Status | Szczegóły |
|---|---|
| Powodzenie | Pojawia się komunikat z potwierdzeniem: „Element <> został utworzony. Wprowadzenie zmian może potrwać do 10 minut”. |
| Niepowodzenie | Jeśli FedEx otrzyma odpowiedź inną niż 200 (OK) lub 202 (zaakceptowano), oznacza to, że weryfikacja docelowego adresu URL elementu webhook zakończyła się niepowodzeniem. |
