Sandbox Console
Testowanie elementu webhook
Z funkcji testowania adresu URL elementu webhook możesz skorzystać w celu przetestowania typu danych monitorowania odsyłanych na docelowy adres URL (do odbiorcy/serwera odbierającego). Pomaga to w weryfikacji adresu URL i zwracanych danych przed utworzeniem elementu webhook Advanced Integrated Visibility.
Nawigacja:
Poniżej opisano sposoby przejścia do konsoli eksperymentalnej Przetestuj adres URL elementu webhook:
- Moje projekty (lewy panel nawigacyjny) -> karta Advanced Integrated Visibility -> przycisk Przetestuj adres URL elementu webhook ->w konsoli eksperymentalnej kliknij opcję Wypróbuj ten projekt Advanced Integrated Visibility
- Katalog API (lewy panel nawigacyjny) -> wyszukaj Advanced Integrated Visibility lub kliknij Advanced Integrated Visibility w sekcji FILTRY -> karta Advanced Integrated Visibility:
- -> Przegląd -> przycisk Dokumentacja -> w konsoli eksperymentalnej kliknij opcję Wypróbuj ten projekt Advanced Integrated Visibility.
- -> Dokumenty -> w konsoli eksperymentalnej kliknij opcję Wypróbuj ten projekt Advanced Integrated Visibility.
Kroki:
Poniżej opisano krok po kroku, jak skorzystać z funkcji Przetestuj adres URL elementu webhook.
- Kliknij przycisk Przetestuj adres URL elementu webhook.
- Wprowadź następujące parametry testowe:
Nazwa pola Opis Adres URL miejsca docelowego
To adres URL, pod którym otrzymasz dane/ładunek monitorowanego zdarzenia.
- Klient powinien podać działający i prawidłowy adres URL miejsca przeznaczenia.
- Podany adres URL miejsca przeznaczenia powinien mieć standardowy format pod względem składni (bezpieczny adres URL https).
Token zabezpieczeń
Używany jako wspólny klucz tajny do uwierzytelniania i weryfikowania odpowiedzi elementu webhook Advanced Integrated Visibility.
- Wartość tokena powinna się mieścić w przedziale między minimalną długością 26 znaków a maksymalną długością 100 znaków.
- Wymagana jest przynajmniej 1 wielka litera, 1 mała litera i 1 cyfra.
- Token zabezpieczeń zostanie użyty do utworzenia podpisu HMAC (Hash Based Message Authentication Code) w celu weryfikacji odpowiedzi.
Język ładunku
Wybierz z listy rozwijanej preferowany język tłumaczenia danych monitorowania. 6 przykładowych języków:
- Angielski (Stany Zjednoczone)(domyślnie)
Typ monitorowania
Wybierz typ odpowiedzi, przy użyciu której powinny być odbierane dane monitorowania.
- Odpowiedź zawierająca szczegółowe dane monitorowania (obejmuje zabezpieczone dane monitorowania z całą historią zdarzeń)(domyślnie)
- Odpowiedź zawierająca dane monitorowania pod kątem zdarzenia (obejmuje zabezpieczone dane monitorowania jedynie z informacjami dotyczącymi ostatniego zdarzenia).(wkrótce)
Monitorowanie zdarzeń
Wybierz jedną kategorię wyższego poziomu, aby otrzymywać powiadomienia e-mail o zdarzeniach dotyczących przesyłki w cyklu życia paczki. Kategorie wyższego poziomu:
- Wysyłka
- W drodze
- Doręczenie
- Wyjątki
- Szacowany termin doręczenia
Zdarzenie statusu
Zdarzenie monitorowania w cyklu życia paczek. Wybierz jedno ze zdarzeń monitorowania, o którym chcesz otrzymać informacje. 10 przykładowych dostępnych zdarzeń związanych ze statusem:
- Odebrana
- W trakcie przewozu
- Doręczono
- Wyjątek w doręczeniu
Uwaga: wartości w polu Zdarzenie statusu zostaną wypełnione w zależności od wybranej kategorii zdarzenia monitorowania. Więcej informacji na temat kategorii zdarzenia monitorowania i odpowiadających jej zdarzeń statusu można znaleźć w poniższej tabeli.
Kategoria zdarzenia statusu Zdarzenie statusu Wysyłka
- Odebrana
W trakcie przewozu
- W trakcie przewozu
Doręczenie
- Doręczono
Wyjątki
- Wyjątek w doręczeniu
Spodziewany termin doręczenia(wkrótce)
- Spodziewana data doręczenia (EDD)
- Okno czasowe dla spodziewanego terminu doręczenia (EDTW)
- Zaznacz pole Umowa licencyjna FedEx Developer Portal (FDPLA), aby podpisać/zaakceptować umowę licencyjną.
- Kliknij przycisk WYPCHNIJ, aby wyświetlić wyniki testu.
Odpowiedź:
Parametry odpowiedzi w konsoli eksperymentalnej:
- Treść — treść zawiera parametry odpowiedzi na karcie Przetestuj adres URL elementu webhook w konsoli eksperymentalnej.
- Status — ta sekcja na karcie Wyniki testu zawiera status przetwarzanego żądania.
Przykładowy komunikat o sukcesie:
Sukces
Dostarczono powiadomienie o monitorowanym zdarzeniu testowym usługi Advanced Integrated Visibility.
Status
Success
Test webhook tracking event details delivered successfully
Error
Test webhook tracking event details delivery failed
Jeśli dostarczenie w przypadku zdarzenia testowego się nie powiedzie, na karcie Wyniki testu będzie wyświetlany STATUS Błąd wraz z odpowiednim kodem błędu i komunikatem o błędzie.
Przykładowy komunikat o błędzie:
Kod błędu:<<error code>>
Dostarczenie powiadomienia o monitorowanym zdarzeniu testowym usługi Advanced Integrated Visibility nie powiodło się.
Zasady weryfikacji:
- Adres URL usługi Advanced Integrated Visibility musi mieć standardowy format pod względem składni.
- Konieczne jest wypełnienie wszystkich wymaganych pól testowanego adresu URL usługi Advanced Integrated Visibility.
- W przypadku weryfikacji pomyślnej:
- FedEx wyśle żądanie z przykładowym plikiem JSON zdarzenia. Uwaga: docelowy adres URL w usłudze Advanced Integrated Visibility powinien odpowiedzieć na żądanie FedEx kodem HTTP o statusie 200 (OK).
- W przypadku nieudanej weryfikacji/błędu weryfikacji:
- Jeśli FedEx otrzyma odpowiedź ze statusem kodu innym niż 200 (OK), weryfikacja docelowego adresu URL w usłudze Advanced Integrated Visibility zostanie uznana za nieudaną.
- Na karcie Wyniki testu w systemie FedEx zostanie wyświetlony odpowiedni kod błędu i komunikat o błędzie.
Kalkulator danych właściwych
Kalkulator danych właściwych pomaga subskrybentom oszacować ilość danych generowanych przez aktywność ich elementów webhook. Zapewnia wgląd w dzienne rozmiary danych właściwych, liczbę przesyłek i zdarzenia monitorowania, pomagając w podejmowaniu przemyślanych decyzji dotyczących wykorzystania danych i planowania integracji.
Korzystanie z kalkulatora
Użytkownicy mogą wprowadzić następujące parametry:
- Liczba przesyłek
- Zdarzenia na przesyłkę (domyślnie: 5)
- Dzienna ilość danych właściwych (obliczana automatycznie)
Na podstawie tych danych wejściowych kalkulator dynamicznie wyświetla następujące informacje:
- łączna liczba zdarzeń monitorowania,
- dzienne dane właściwe,
- szacowany całkowity rozmiar danych.
Dodatkowe uwagi:
- Parametr Zdarzenia na przesyłkę ma domyślnie wartość 5. Została ona ustalona na podstawie średniej liczby 17–18 zdarzeń na przesyłkę i typowych terminów doręczenia wynoszących 1–7 dni w zależności od rodzaju usługi, przewoźnika i miejsca przeznaczenia. Przyjęto, że średni czas doręczenia wynosi 3 dni. Uwaga: użytkownik może edytować tę wartość.
- Dzienna ilość danych właściwych jest obliczana według wzoru: liczba przesyłek × liczba zdarzeń na przesyłkę (domyślnie: 5).
- Aby wygenerować wyniki, użytkownicy muszą podać jedynie wartość parametru Liczba przesyłek i kliknąć „OBLICZ”. Pozostałe wartości są wstawiane domyślnie lub obliczane automatycznie.
Zastrzeżenie: Wszystkie wartości wyliczone za pomocą kalkulatora są przybliżone i służą wyłącznie do planowania.
Number of Shipments
Events per Shipment (default 5)
Daily Payload Volume (events per day)
Note: Displayed values are approximations and may not reflect exact usage metrics.
