Fedex Logo

UTWÓRZ
ELEMENT WEBHOOK ZARZĄDZAJ ELEMENTAMI WEBHOOK

Jak działa usługa Advanced Integrated Visibility

Element webhook Advanced Integrated Visibility umożliwia systemowi FedEx wysyłanie w czasie zbliżonym do rzeczywistego zabezpieczonych aktualizacji danych monitorowania na określony adres URL. Te aktualizacje dotyczą przesyłek powiązanych z co najmniej jednym numerem konta FedEx. Aby można było używać tej funkcji, musisz utworzyć projekt elementu webhook Advanced Integrated Visibility.

Jak uzyskać dostęp do strony Advanced Integrated Visibility

Dostęp do konfiguracji usługi Advanced Integrated Visibility możesz uzyskać na dwa sposoby:

Opcja 1. Przy użyciu strony Moje projekty

    1. W lewym panelu nawigacyjnym wybierz pozycję Moje projekty.

    2. Wybierz kartę Elementy webhook.

    3. Wybierz opcję +UTWÓRZ PROJEKT ELEMENTU WEBHOOK.

Opcja 2. Przy użyciu strony Katalog interfejsów API

    1. Z lewego panelu nawigacyjnego otwórz stronę Katalog interfejsów API.

    2. Wyszukaj pozycję Advanced Integrated Visibility.

    3. Użyj filtru ELEMENT WEBHOOK, aby znaleźć właściwą kartę.

    4. Na karcie:

  •  Kliknij opcję Przegląd, kliknij przycisk Dokumentacja, a następnie wybierz opcję +UTWÓRZ PROJEKT ELEMENTU WEBHOOK.
  •  Ewentualnie wybierz opcję DOKUMENTY i kliknij polecenie +UTWÓRZ PROJEKT ELEMENTU WEBHOOK.

 

Krok 1. Wybieranie 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.

 

Następnie jako typ subskrypcji wybierz opcję Subskrypcja Advanced Integrated Visibility oparta na numerze przesyłki.

Tworzenie subskrypcji Advanced Integrated Visibility opartej na numerze przesyłki

Możesz skonfigurować subskrypcję Advanced Integrated Visibility opartą na numerze przesyłki, aby otrzymywać w czasie zbliżonym do rzeczywistego zabezpieczone aktualizacje danych monitorowania powiązanych z co najmniej jednym numerem monitorowania przesyłki FedEx. Te aktualizacje są wysyłane na podany docelowy adres URL.

 

Kroki procedury tworzenia subskrypcji

Procedura obejmuje cztery główne kroki:

    1. Skonfiguruj projekt

    2. Wprowadź szczegóły projektu

    3. Potwierdź szczegóły i zaakceptuj warunki

    4. Dodaj numery przesyłek

 

Instrukcje krok po kroku

   1. Na stronie Konfiguruj element webhook:

         Sprawdź numer konta rozliczeniowego.

         Pojawi się domyślny numer konta rozliczeniowego organizacji.

         Aby go zmienić:

  •  Kliknij opcję DODAJ KONTO ROZLICZENIOWE DO ORGANIZACJI (jeśli masz tylko jedno konto).
  •  Kliknij opcję WYBIERZ INNE KONTO ROZLICZENIOWE (jeśli masz więcej kont).

 

Uwaga: Aby uzyskać informacje o cenach, przejdź na stronę Omówienie usługi Advanced Integrated Visibility.

 

2. Wybierz funkcje

  •  Wybierz funkcje, których potrzebujesz.
  •  Kliknij przycisk Dalej, aby kontynuować.

Wskazówka: Aby dowiedzieć się więcej o konkretnej funkcji, kliknij ikonę pomocy (?) obok niej.

Opisy funkcji

Nazwa pola Opis
Potwierdzenie doręczenia Potwierdza pomyślne doręczenie przesyłki. Obejmuje:
  • Zdjęcie potwierdzające doręczenie (PPODA): 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:
  • Spodziewana data doręczenia (EDD)
  • Okno czasowe dla spodziewanego terminu 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

 

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).

3. Na stronie Potwierdź szczegóły:

  •  Sprawdź szczegóły projektu elementu webhook.
  •  Przeczytaj oraz zaakceptuj warunki i postanowienia.
  •  Kliknij opcję Utwórz, aby sfinalizować konfigurację projektu elementu webhook.

4. Po pomyślnym przesłaniu wniosku:

  •  Nowy projekt elementu webhook zostanie utworzony przez FedEx.
  •  Otrzymasz klucze produkcyjne do interfejsu API subskrypcji Advanced Integrated Visibility opartej na numerze przesyłki.
  •  Możesz użyć tego interfejsu API w celu powiązania numerów przesyłek ze swoim projektem.

Aby dowiedzieć się więcej, przejdź na stronę dokumentacji interfejsu API subskrypcji Advanced Integrated Visibility opartej na numerze przesyłki.

Jak dodać numer przesyłki do elementu webhook

Aby dodać numer przesyłki do subskrypcji elementu webhook za pomocą interfejsu API subskrypcji Advanced Integrated Visibility opartej na numerze przesyłki, wykonaj następujące czynności:

 

Procedura krok po kroku

1. Tworzenie projektu subskrypcji

· Wykonaj kroki z poprzedniej sekcji lub zapoznaj się z przewodnikiem po pierwszych krokach.

2. 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.

3. 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

  •  Nazwa elementu webhook musi być unikalna.
  •  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.
CLOSE

Response

Copy