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 jednym lub wieloma numerami kont FedEx. Możesz utworzyć projekt elementu webhook w celu uzyskiwania dostępu do tej funkcji za pośrednictwem FedEx Developer Portal.
Ścieżki nawigacyjne
Dostęp do strony tworzenia elementu webhook możesz uzyskać na jeden z poniższych sposobów:
- Przy użyciu strony Moje projekty: lewy panel nawigacyjny → karta Elementy webhook → +UTWÓRZ PROJEKT elementu webhook
- Przy użyciu strony Katalog interfejsów API:
- Lewy panel nawigacyjny → Katalog interfejsów API
- Wyszukaj pozycję Advanced Integrated Visibility lub użyj filtru Advanced Integrated Visibility
- 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. Wybieranie typu firmy
Kliknij opcję +UTWÓRZ PROJEKT i wybierz typ firmy z listy rozwijanej:
- Firma korzysta z usług wysyłkowych FedEx i musi zintegrować element webhook FedEx ze swoim systemem.
- Firma sprzedaje lub dostarcza oprogramowanie korzystające z danych FedEx, ale nie jest certyfikowanym dostawcą FedEx Compatible.
- 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 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łączenie subskrypcji Advanced Integrated Visibility opartej na numerze konta
Ten krok jest wykonywany przez Administratora FedEx lub Opiekuna Handlowego FedEx na wniosek klienta będącego stroną trzecią.
- Dokument MNDA: Administrator FedEx lub Opiekun Handlowy FedEx odbierze umowę o wzajemnym zachowaniu poufności (MNDA) wraz z listą zbiorczą numerów kont klientów bezpośrednich/wysyłających.
Uwaga: podczas przesyłania tych danych dozwolone są zduplikowane numery kont powiązane z innymi organizacjami.
- W stosownych przypadkach ceny niestandardowe zostaną włączone na poziomie organizacyjnym.
Uwaga: ta funkcja nie jest uwzględniona w lipcowym środowisku.
Krok 2. Utworzenie projektu
Na stronie Wybierz produkt(y):
- Kliknij opcję Advanced Integrated Visibility — subskrypcja oparta na numerze konta, a następnie kliknij przycisk Dalej.
- Wybierz konta rozliczeniowe, zaakceptuj warunki płatności i kliknij przycisk Dalej.
Należy dodać co najmniej jedno konto rozliczeniowe.
Na stronie Potwierdź szczegóły:
- Sprawdź informacje o projekcie.
- Zaakceptuj warunki i postanowienia.
- Jeśli mają zastosowanie ceny niestandardowe, powiązany dokument zostanie wyświetlony automatycznie.
Po pomyślnym utworzeniu pojawi się komunikat z potwierdzeniem:
„Produkt został dodany do projektu Mój projekt”.
Krok 3. Przegląd projektu — procedura aktywacji klucza API
- Na stronie Przegląd projektu na karcie Klucze API w sekcji Interfejsy API status produkcyjny subskrypcji będzie początkowo mieć wartość Wyłączona.
- Administrator FedEx lub Opiekun Handlowy FedEx włączy produkt po otrzymaniu wniosku.
- Po jego włączeniu stanie się dostępna karta Klucz produkcyjny, a status produkcyjny zostanie zmieniony na wartość Oczekuje na potwierdzenie.
- Po ukończeniu aktywacji przez Administratora FedEx lub Opiekuna Handlowego FedEx status produkcyjny będzie mieć wartość Włączona.
Krok 4. Przegląd projektu — konfigurowanie elementu webhook
- Przejdź na stronę Przegląd projektu.
- Wybierz kartę Elementy webhook.
- Kliknij przycisk + Konfiguruj elementy webhook, aby rozpocząć konfigurowanie elementu webhook. Nastąpi przekierowanie na kartę Elementy webhook.
Opisy funkcji
| Nazwa pola | Opis |
|---|---|
| Potwierdzenie doręczenia | Potwierdza pomyślne doręczenie przesyłki. Obejmuje: Zdjęcie potwierdzające doręczenie (PPOD): udostępnia zdjęcie dokładnie przedstawiające miejsce doręczenia. Potwierdzenie doręczenia podpisem (SPOD): udostępnia zdjęcie podpisu oraz imienia i nazwiska odbiorcy, a także daty i godziny oraz miejsca doręczenia. |
| Szacowany termin doręczenia | Pomaga odbiorcom w planowaniu, ponieważ udostępnia następujące informacje: Przewidywany termin doręczenia (EED) Szacowane godziny doręczenia (EDTW) |
| Monitorowanie zdarzeń | Umożliwia wybranie co najmniej jednej kategorii zdarzeń, których mają dotyczyć przesyłane powiadomienia: Wysyłka W trakcie przewozu Doręczenie Wyjątki Niestandardowe opcje doręczenia |
| Filtrowanie na podstawie zdarzeń | Filtruje odpowiedzi elementu webhook na podstawie przesyłek: Przesyłki przychodzące Przesyłki wychodzące Przesyłki stron trzecich |
2. Na stronie „Wprowadź szczegóły” 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: Musi być prawidłowy i działać. Musi być zgodny ze standardową składnią. Nie może zawierać domeny fedex.com ani jej poddomen. Może być ponownie wykorzystywany w wielu elementach webhook. Więcej szczegółowych informacji zawiera sekcja Reguły biznesowe i najlepsze praktyki. |
| Token zabezpieczeń | Wspólny klucz tajny do uwierzytelniania i weryfikowania odpowiedzi elementu webhook za pośrednictwem kodu HMAC. Wymagania: Musi zawierać 26–100 znaków. Musi zawierać co najmniej 1 wielką literę, 1 małą literę i 1 cyfrę. Może być ponownie wykorzystywany w wielu elementach webhook. |
| Język (kraj) ładunku | Wybierz z listy rozwijanej preferowany język tłumaczenia danych monitorowania. |
| Typ monitorowania | Wybierz sposób dostarczania danych monitorowania: Szczegółowe informacje monitorowania — pełna historia zdarzeń. Monitorowanie dotyczące zdarzenia — tylko ostatnie zdarzenie. |
| 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ć unikalna.
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 powodzeniem:
Po pomyślnym utworzeniu elementu webhook klient otrzyma następujący komunikat z potwierdzeniem:
Element <<nazwa elementu webhook>> został utworzony. 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.
