Przegląd
Element webhook Advanced Integrated Visibility umożliwia systemowi FedEx wysyłanie w czasie zbliżonym do rzeczywistego zabezpieczonych danych dotyczących zdarzeń monitorowania na określony docelowy adres URL w przypadku przesyłek powiązanych z co najmniej jednym numerem konta FedEx. Aby korzystać z tej funkcji, możesz utworzyć projekt elementu webhook za pośrednictwem portalu FedEx Developer Portal.
Ścieżki nawigacyjne
Dostęp do strony tworzenia elementu webhook możesz uzyskać w jeden z poniższych sposobów:
1. Przez Moje projekty:
- Lewy panel nawigacyjny → karta Elementy webhook → +UTWÓRZ PROJEKT elementu webhook
2. Przez Katalog interfejsów API:
Lewy panel nawigacyjny → Katalog interfejsów API
Wyszukaj pozycję Advanced Integrated Visibility lub użyj takiego filtra.
Wybierz:
- Przegląd → kliknij opcję Dokumentacja → w konsoli eksperymentalnej kliknij opcję +UTWÓRZ PROJEKT
- Dokumenty → kliknij +UTWÓRZ element webhook
Kroki procedury tworzenia elementu webhook
Krok 1. Wybierz typu firmy
Kliknij opcję +UTWÓRZ PROJEKT i wybierz typ firmy z listy rozwijanej:
1. Firma korzysta z usług wysyłkowych FedEx i musi zintegrować element webhook FedEx ze swoim systemem.
2. Firma sprzedaje lub dostarcza oprogramowanie korzystające z danych FedEx, ale nie jest certyfikowanym dostawcą FedEx Compatible.
3. Firma jest certyfikowanym dostawcą FedEx Compatible.
Uwaga: obecnie w przypadku tej opcji nie jest dostępny element webhook FedEx Advanced Integrated Visibility. Jeśli jako uczestnik programu FedEx Compatible chcesz uzyskać dostęp do usługi Basic Integrated Visibility lub innych rozwiązań do integracji firmy FedEx, skontaktuj się ze swoim menedżerem kanału. Jeśli nie wiesz, kto jest Twoim menedżerem kanału, skontaktuj się z administratorem firmy.
Następnie jako typ subskrypcji wybierz opcję Subskrypcja Advanced Integrated Visibility oparta na numerze konta.
Tworzenie subskrypcji Advanced Integrated Visibility opartej na numerze konta
Procedura tworzenia obejmuje cztery główne kroki:
Krok 1. Włącz subskrypcję Advanced Integrated Visibility opartą na numerze konta
Ten krok jest zarządzany przez Administratora FedEx lub Opiekuna Handlowego FedEx na prośbę klientów zewnętrznych.
- Dokument MNDA: Administrator FedEx lub Opiekun Handlowy FedEx odbierze umowę o wzajemnym zachowaniu poufności (MNDA) wraz ze zbiorczą listą numerów kont klientów bezpośrednich/nadawców.
Uwaga: podczas tego przesyłania dozwolone są zduplikowane numery kont powiązane z innymi organizacjami.
- Jeśli ma to zastosowanie, Niestandardowa wycena zostanie włączona na poziomie organizacji.
Uwaga: ta funkcja nie jest uwzględniona w wersji lipcowej.
Krok 2. + Utwórz projekt
Na stronie Wybierz produkty:
1. Kliknij Advanced Integrated Visibility — numer konta, a następnie kliknij Dalej.
2. Wybierz konta rozliczeniowe, zaakceptuj warunki płatności i kliknij Dalej.
Należy dodać co najmniej jedno konto rozliczeniowe.
3. Na stronie Potwierdź szczegóły:
- Przejrzyj informacje o projekcie.
- Zaakceptuj Warunki i postanowienia.
- Jeśli opcja Niestandardowej wyceny ma zastosowanie, odpowiedni dokument pojawi się automatycznie.
4. Po pomyślnym utworzeniu projektu pojawi się komunikat z potwierdzeniem:
„Produkt został dodany do Moich projektów”.
5. Przegląd projektu — proces aktywacji klucza API
- Stan produkcyjny subskrypcji widoczny na stronie Przegląd projektu, na karcie Klucze API w sekcji Interfejsy API, będzie początkowo wyświetlany jako Wyłączona.
- Na prośbę klienta Administrator lub Opiekun Handlowy FedEx włączy produkt.
- Po jego włączeniu karta Klucz produkcyjny stanie się dostępna, a stan produkcyjny zostanie zaktualizowany na Oczekiwanie na potwierdzenie.
- Po ostatecznej aktywacji przez Administratora lub Opiekuna Handlowego FedEx status produkcyjny będzie widoczny jako Włączona.
Krok 3. Przegląd projektu — skonfiguruj element webhook
1. Przejdź na stronę Przegląd projektu.
2. Wybierz kartę Elementy webhook.
3. Kliknij przycisk + Konfiguruj elementy webhook, aby rozpocząć konfigurację elementu webhook, który zostanie przekierowany do zakładki Elementy webhook.
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ń, o których mają być otrzymywane powiadomienia:
|
| Filtrowanie na podstawie zdarzeń | Filtruje odpowiedzi elementu webhook, aby uwzględniały:
|
2. Na stronie wprowadzania szczegółów podaj 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). |
Krok 3. Wybierz konta wysyłkowe
Na stronie Wybierz konta wysyłkowe:
- Wybierz co najmniej jeden numer konta FedEx do powiązania z projektem elementu webhook.
Ważne uwagi:
- Będą widoczne wyłącznie konta, których jeszcze nie powiązano z innymi elementami webhook.
- Aby kontynuować, musisz powiązać co najmniej jedno konto.
- Przy użyciu interfejsu UI elementu webhook można dodać maksymalnie 100 kont.
- Aby powiązać więcej niż 100 kont, użyj interfejsu API elementów webhook.
Aby wnioskować o dostęp do interfejsu API, skontaktuj się z Biurem Obsługi Klienta FedEx lub działem pomocy.
Krok 4. Potwierdź szczegóły i utwórz
Na stronie Potwierdź szczegóły:
1. Sprawdź wszystkie wprowadzone informacje dotyczące projektu elementu webhook.
2. Zaznacz pole, aby zaakceptować warunki i postanowienia.
3. Kliknij opcję Utwórz, aby sfinalizować konfigurację elementu webhook.
Po pomyślnym przesłaniu danych element webhook zostanie utworzony z wygenerowanym przez system identyfikatorem subskrypcji i statusem Aktywny.
Zasady weryfikacji
Ogólne wymagania:
- Nazwa elementu webhook musi być unikatowa.
- Docelowy adres URL musi mieć standardowy format pod względem składni (bezpieczny adres HTTPS, który nie może zawierać domeny fedex.com ani jej poddomen).
- Wszystkie wymagane pola muszą być wypełnione — żadne pole obowiązkowe nie może pozostać puste.
- Z elementem webhook musi być powiązany co najmniej jeden prawidłowy numer konta wysyłkowego FedEx.
Weryfikacja zakończona sukcesem:
Po pomyślnym utworzeniu elementu webhook klient otrzyma następujący komunikat z potwierdzeniem:
Pomyślnie utworzono <<nazwa elementu webhook>>. Wprowadzenie zmian może potrwać do 10 minut.
Weryfikacja zakończona niepowodzeniem:
Jeśli FedEx otrzyma z docelowego adresu URL odpowiedź inną niż kod HTTP 200 (OK) lub 202 (zaakceptowano), oznacza to, że weryfikacja elementu webhook zakończyła się niepowodzeniem.
