Přehled
Webhook Advanced Integrated Visibility umožňuje společnosti FedEx odesílat údaje o sledování zásilek v téměř reálném čase a zabezpečeně na zadanou cílovou URL adresu pro zásilky spojené s jedním nebo více čísly zákaznických účtů FedEx. Pro přístup k této funkci si můžete vytvořit projekt webhooků prostřednictvím portálu FedEx Developer Portal.
Navigační cesty
Na stránku pro vytváření webhooků se můžete dostat jedním z následujících způsobů:
1. Přes Moje projekty:
- Levý navigační panel → karta Webhooky → +VYTVOŘIT PROJEKT webhooku
2. Prostřednictvím katalogu API:
Levý navigační panel → Katalog API
Vyhledat nebo filtrovat podle služby Advanced Integrated Visibility
Vyberte:
- Přehled → Klikněte na možnost Dokumentace → V konzoli Sandbox klikněte na možnost +VYTVOŘIT PROJEKT
- Dokumenty → Klikněte na možnost +VYTVOŘIT webhook
Kroky vytvoření webhooku
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.
Poznámka: V současnosti není řešení FedEx Advanced Integrated Visibility webhook dostupné pro tuto možnost. Pokud jako člen programu FedEx Compatible chcete získat přístup k rozhraní API Basic Integrated Visibility nebo jiným řešením integrace FedEx, obraťte se na svého správce programu. Pokud nevíte, kdo je správcem vašeho kanálu, obraťte se na správce vaší společnosti.
Poté vyberte jako typ předplatného možnost Předplatné služby Advanced Integrated Visibility podle čísla účtu.
Vytvoření předplatného Advanced Integrated Visibility podle čísla zákaznického účtu
Proces vytváření zahrnuje čtyři klíčové kroky:
Krok 1: Aktivace předplatného služby Advanced Integrated Visibility podle čísla účtu
Tento krok je řízen správcem společnosti FedEx nebo zástupcem společnosti FedEx na žádost externích zákazníků.
- Dokument MNDA: Správce společnosti FedEx nebo zástupce společnosti FedEx získá vzájemnou smlouvu o mlčenlivosti (MNDA) spolu s hromadným seznamem čísel zákaznických účtů první strany / odesílatele.
Poznámka: Při tomto nahrávání jsou povolena duplicitní čísla účtů, která jsou přiřazena k jiným organizacím.
- V příslušných případech bude na úrovni organizace povolena funkce Vlastní ceny.
Poznámka: Tato funkce není součástí July Experience.
Krok 2: + Vytvořit projekt
Na stránce Vybrat produkt(y):
1. Klikněte na Advanced Integrated Visibility – číslo zákaznického účtu a poté klikněte na Další.
2. Vyberte fakturační účty, přijměte platební podmínky a klikněte na Další.
Je nutné přidat alespoň jeden fakturační účet.
3. Na stránce Potvrdit údaje:
- Zkontrolujte informace o projektu.
- Přijměte Smluvní podmínky.
- Pokud platí Vlastní ceny, související dokument se zobrazí automaticky.
4. Při úspěšném vytvoření se zobrazí potvrzovací zpráva:
„Produkt jste úspěšně přidali do složky ‚Můj projekt‘.“
5. Přehled projektu – Proces aktivace klíče API
- Na stránce Přehled projektu , na kartě Klíče API v sekci Rozhraní API , se produkční stav předplatného zpočátku zobrazí jako „Deaktivováno“.
- Správce společnosti FedEx nebo její zástupce produkt na požádání aktivuje.
- Po povolení bude karta Produkční klíč přístupná a produkční stav se aktualizuje na „Čeká se na potvrzení“.
- Po konečné aktivaci správcem nebo zástupcem společnosti FedEx se produkční stav projeví jako „Povoleno“.
Krok 3: Přehled projektu – Konfigurace webhooku
1. Přejděte na stránku Přehled projektu .
2. Vyberte kartu Webhooky.
3. Kliknutím na tlačítko + Konfigurovat webhooky zahájíte konfiguraci webhooku. Budete přesměrováni na kartu Webhooky.
Popisy funkcí
| Název pole | Popis |
|---|---|
| Potvrzení o doručení | Potvrzuje úspěšné doručení zásilky. Zahrnuje:
|
| Předpokládané doručení | Pomáhá příjemcům plánovat tím, že:
|
| Události sledování | Umožňuje výběr jedné nebo více kategorií událostí pro příjem oznámení:
|
| Filtrování podle události | Filtruje odpovědi webhooku tak, aby zahrnovaly:
|
2. 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:
|
| Token zabezpečení | Sdílený tajný klíč používaný k ověřování a validaci odpovědí webhooků prostřednictvím HMAC. Požadavky:
|
| 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ů:
|
| 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). |
Krok 3: Výběr účtů pro zasílání
Na stránce Výběr účtů pro zasílání:
- Vyberte jedno nebo více čísel zákaznických účtů FedEx, která přiřadíte ke svému projektu webhooku.
Důležité poznámky:
- Zobrazí se pouze účty , které ještě nejsou přiřazeny k jiným webhookům.
- Abyste mohli pokračovat, musíte přiřadit alespoň jeden účet .
- Prostřednictvím webhookového rozhraní lze přidat maximálně 100 účtů.
- Chcete-li propojit více než 100 účtů, použijte rozhraní API webhooků.
Obraťte se na zákaznickou podporu nebo helpdesk společnosti FedEx a požádejte o přístup k rozhraní API.
Krok 4: Potvrdit údaje a vytvořit
Na stránce Potvrdit údaje:
1. Zkontrolujte všechny údaje, které jste zadali pro webhookový projekt.
2. Zaškrtněte políčko k přijetí smluvních podmínek.
3. Klikněte na Vytvořit a dokončete nastavení webhooku.
Po úspěšném odeslání bude webhook vytvořen se systémem vygenerovaným ID předplatného a bude nastaven do stavu Aktivní.
Pravidla ověřování
Obecné požadavky:
- Název webhooku musí být jedinečný.
- Cílová URL musí odpovídat standardizovanému syntaktickému formátu (zabezpečené HTTPS, bez domény fedex.com nebo jejích subdomén).
- Všechna povinná pole musí být vyplněna – žádné povinné pole nesmí zůstat prázdné.
- K webhooku musí být přiřazeno alespoň jedno platné číslo zákaznického účtu FedEx.
Úspěšné ověření:
Pokud se webhook podaří vytvořit, zákazník obdrží potvrzovací zprávu:
<<Webhook name>> byl úspěšně vytvořen. Změny se mohou projevit až po 10 minutách.
Neúspěšné ověření:
Pokud společnost FedEx obdrží od cílové adresy URL jinou odpověď než HTTP 200 (OK) nebo 202 (Přijato), bude ověření webhooku považováno za neúspěšné.
