Fedex Logo

VYTVOŘIT
WEBHOOK SPRAVOVAT WEBHOOKY

Jak funguje služba Advanced Integrated Visibility

Přehled webhooku Advanced Integrated Visibility

Webhook Advanced Integrated Visibility umožňuje společnosti FedEx bezpečně odesílat údaje o sledování zásilek v téměř reálném čase na zadanou cílovou URL adresu pro zásilky spojené s určeným číslem/čísly účtu FedEx.

Chcete-li tuto funkci využívat, musí správce FedEx nebo správce DI vytvořit webhookový projekt Advanced Integrated Visibility.

 

Navigační možnosti

Na stránku Advanced Integrated Visibility Webhooks se můžete dostat dvěma způsoby:

Možnost 1: Přes Moje projekty

  •  Z navigačního panelu na levé straně přejděte do části Moje projekty.
  •  Klikněte na záložku Webhooky.

Možnost 2: Prostřednictvím katalogu API

  •  Přejděte do katalogu API z levého navigačního panelu.
  •  Použijte vyhledávací pole k vyhledání nástroje Advanced Integrated Visibility nebo jej vyberte v části FILTRY .
  •  Na kartě Webhook si vyberte jednu z následujících možností:
  •  Klikněte na Dokumenty → poté klikněte na + Spravovat webhooky

Zobrazení projektu předplatného Advanced Integrated Visibility podle sledovacího čísla

1. Přístup a nastavení FedEx Personal

  •  Proces nastavení zahájí správce společnosti FedEx nebo zástupce společnosti FedEx.
  •  Profil organizace vytváří pověřený správce jménem zákazníků CSP.
  •  Správce jménem zákazníka přidá na úrovni organizace číslo způsobilého fakturačního účtu vedeného v USA.
  •  Správce provádějící toto nastavení musí mít příslušná oprávnění ke správě konfigurací na úrovni organizace.

2. Zobrazení pracovního postupu pro předplatné podle sledovacího čísla

2.1 Zobrazit předplatné

  •  Jakmile správce nebo zástupce společnosti FedEx vytvoří projekt, mohou si uživatelé na svém ovládacím panelu zobrazit související projekt předplatného Advanced Integrated Visibility podle sledovacího čísla.

2. Zobrazit funkce

  •  Uživatelé si mohou prohlédnout dostupné funkce spojené s projektem předplatného pro lepší pochopení a využití.

Popisy funkcí

Název pole Popis
Potvrzení o doručení Potvrzuje úspěšné doručení zásilky. Zahrnuje:
  • Potvrzení o doručení zásilky ve formě fotografie (PPODA): Poskytuje fotografii zobrazující přesné místo doručení.
  • Podepsané potvrzení o doručení (SPOD): Poskytuje snímek podpisu příjemce, jeho jméno, datum, čas a místo doručení.
Předpokládané doručení Pomáhá příjemcům plánovat tím, že:
  • Předpokládané datum doručení (EDD)
  • Odhadovaná doba doručení (EDTW)
Události sledování Umožňuje výběr jedné nebo více kategorií událostí pro příjem oznámení:
  • Odeslat
  • V přepravě
  • Doručení
  • Výjimky

 

Na stránce Podrobnosti se zobrazí následující informace:

Název pole Popis
Název projektu webhooku Jedinečný, neprázdný název pro váš webhookový projekt. Navrhovaný název se vyplní automaticky, lze jej však upravit. Tento název se nesmí opakovat v žádném jiném webhooku.
Adresa URL místa určení Zabezpečený HTTPS koncový bod, na který bude společnost FedEx odesílat údaje o sledování zásilek.
Požadavky:
  • Musí být platný a funkční
  • Musí dodržovat standardizovanou syntaxi
  • Nesmí zahrnovat doménu fedex.com ani žádnou z jejích subdomén
  • Lze znovu použít napříč více webhooky
Více informací naleznete v části Obchodní pravidla a osvědčené postupy.
Token zabezpečení Sdílený tajný klíč používaný k ověřování a validaci odpovědí webhooků prostřednictvím HMAC.
Požadavky:
  • 26–100 znaků
  • Musí obsahovat alespoň 1 velké písmeno, 1 malé písmeno a 1 číslici.
  • Lze znovu použít napříč více webhooky
Jazyk datového obsahu (země) V rozevíracím seznamu vyberte preferovaný jazyk pro překlad dat sledování.
Typ sledování Vyberte způsob doručení sledovacích údajů:
  • Podrobné sledování – Úplná historie událostí
  • Sledování specifických událostí – Pouze nejnovější událost
E-mailová adresa Zadejte platnou e-mailovou adresu, na kterou chcete dostávat oznámení.
Jazyk e-mailu (země) Vyberte preferovaný jazyk pro e‑mailová oznámení.

Poznámka: Podporovány jsou pouze americké jazykové varianty (např. en-US, es-US).

 

Proces krok za krokem

4. Vytvořte projekt předplatného

  •  Postupujte podle kroků z předchozího oddílu nebo se podívejte do Průvodce Začínáme.

5. Vygenerujte token OAuth

  •  K volání rozhraní API potřebujete token OAuth.
  •  K vygenerování tokenu použijte Autorizační API .
  •  Podrobné kroky najdete v dokumentaci k autorizačnímu API v katalogu API.

6. Přejděte na dokumentaci API

  •  V levé navigační nabídce klikněte na Podrobnosti o projektu.
  •  Na kartě Produkční klíče sjeďte dolů a najděte dokumentaci rozhraní API pro předplatné Advanced Integrated Visibility podle sledovacího čísla.

 

Přehled koncových bodů API

Koncový bod Účel
Přidružení sledovacího čísla Přidejte nebo odeberte sledovací čísla z předplatného webhooku. Jedná se o asynchronní úlohu. V odpovědi se vrátí ID úlohy.
Detaily úlohy podle sledovacího čísla Poskytuje podrobnosti o konkrétním ID úlohy, například kolik sledovacích čísel bylo úspěšně přidáno nebo se stále zpracovává.
Stav úlohy podle sledovacího čísla Vrací souhrn všech aktuálně zpracovávaných úloh.

 

Použijte token OAuth z 2. kroku s koncovým bodem pro přiřazení sledovacích čísel a přidejte sledovací čísla do svého webhooku.

Pravidla ověřování

  •  Názvy webhooků musí být jedinečné.
  •  Cílová adresa URL musí odpovídat standardnímu syntaktickému formátu.
  •  Musí být vyplněna všechna povinná pole.
  •  Musí být přidruženo alespoň jedno platné číslo zákaznického účtu FedEx pro odesílání.

Výsledky ověření

Stav Podrobnosti
Úspěšné Zobrazí se potvrzovací zpráva:
„<> bylo úspěšně vytvořeno.“ Změny se mohou projevit až po 10 minutách.“
Neúspěšné Pokud společnost FedEx obdrží jinou odpověď než 200 (OK) nebo 202 (Přijato), je ověření cílové adresy URL webhooku považováno za neúspěšné.
CLOSE

Response

Copy