Fedex Logo

VYTVOŘIT
WEBHOOK SPRAVOVAT WEBHOOKY

Jak funguje služba Advanced Integrated Visibility

Webhook služby Advanced Integrated Visibility umožňuje společnosti FedEx odesílat zabezpečené aktualizace o sledování zásilek v téměř reálném čase na konkrétní URL adresu. Tyto aktualizace se týkají zásilek propojených s jedním nebo více čísly zákaznických účtů FedEx. Chcete-li tuto funkci používat, musíte vytvořit webhookový projekt Advanced Integrated Visibility.

Jak se dostat na stránku Advanced Integrated Visibility

Nastavení služby Advanced Integrated Visibility můžete otevřít dvěma způsoby:

Možnost 1: Přes Moje projekty

    1. Přejděte na Moje projekty v levém navigačním panelu.

    2. Klikněte na kartu Webhooky .

    3. Vyberte možnost +Vytvořit projekt WEBHOOK.

Možnost 2: Přes API katalog

    1. Otevřete Katalog rozhraní API z levého navigačního panelu.

    2. Vyhledejte službu Advanced Integrated Visibility.

    3. Použijte filtr WEBHOOK k nalezení správné karty.

    4. Na kartě:

  •  Klikněte na Přehled, poté na tlačítko Dokumenty a vyberte možnost + VYTVOŘIT WEBHOOKOVÝ PROJEKT.
  •  Nebo přejděte do DOKUMENTY a klikněte na + VYTVOŘIT WEBHOOKOVÝ PROJEKT.

 

Krok 1: Vyberte typ společnosti

Klikněte na +VYTVOŘIT PROJEKT a z rozbalovací nabídky vyberte typ společnosti:

    1. Odesílá zásilky se společností FedEx a potřebuje integrovat webhook společnosti FedEx do svého systému.

    2. Prodává nebo poskytuje softwarové řešení využívající data společnosti FedEx a nemá certifikaci poskytovatele kompaktního řešení FedEx.

    3. Má certifikaci poskytovatele kompaktního řešení FedEx.

 

Poté vyberte jako typ předplatného možnost Předplatné služby Advanced Integrated Visibility podle sledovacího čísla.

Vytvořit předplatné služby Advanced Integrated Visibility podle sledovacího čísla

Můžete si nastavit předplatné služby Advanced Integrated Visibility podle sledovacího čísla a získat bezpečné, téměř okamžité aktualizace sledování pro jedno nebo více sledovacích čísel FedEx. Tyto aktualizace se odesílají na vámi zadanou URL adresu místa určení.

 

Postup při vytváření předplatného

Proces zahrnuje čtyři hlavní kroky:

    1. Konfigurace projektu

    2. Zadání údajů projektu

    3. Potvrdit podrobnosti a přijmout podmínky

    4. Přidat sledovací čísla

 

Podrobný návod

    1. Na stránce Konfigurace webhooku:

         Zkontrolujte číslo fakturačního účtu

         Zobrazí se výchozí číslo fakturačního účtu vaší organizace.

         Chcete-li jej změnit:

  •  Klikněte na PŘIDAT FAKTURAČNÍ ÚČET DO VAŠÍ ORGANIZACE (máte-li pouze jeden zákaznický účet), nebo
  •  Klikněte na VYBRAT JINÝ FAKTURAČNÍ ÚČET (máte-li více účtů).

 

Poznámka: Podrobnosti o cenách najdete na stránce Přehled služby Advanced Integrated Visibility .

 

2. Výběr funkcí

  •  Vyberte funkce, které potřebujete.
  •  Pokračujte kliknutím na Další .

Tip: Chcete‑li se o jednotlivých funkcích dozvědět více, klikněte na ikonu nápovědy (?) vedle příslušné funkce.

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 Zadat údaje zadejte 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).

3. Na stránce Potvrdit údaje:

  •   Zkontrolujte údaje o svém webhookovém projektu.
  •  Zkontrolujte a přijměte smluvní podmínky.
  •  Kliknutím na tlačítko Vytvořit dokončete nastavení webhookového projektu .

4. Po úspěšném odeslání žádosti:

  •  FedEx vytvoří nový webhookový projekt .
  •  Obdržíte produkční klíče pro rozhraní API předplatného služby Advanced Integrated Visibility podle sledovacího čísla.
  •  Pomocí tohoto rozhraní API můžete k projektu přidružit sledovací čísla.

Další informace najdete na stránce dokumentace k rozhraní API pro předplatné služby Advanced Integrated Visibility podle sledovacího čísla.

Jak přidat sledovací číslo k webhooku

Chcete-li přidat sledovací číslo do svého předplatného webhooku pomocí rozhraní API pro předplatné Advanced Integrated Visibility sledovacího čísla, postupujte podle těchto kroků:

 

Proces krok za krokem

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

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

3. 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ázev webhooku musí být jedinečný.
  •  Cílová URL adresa 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