Nastavení služby webhooku Advanced Integrated Visibility
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 webhookový projekt 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ů:
- Přes Moje projekty: Levý navigační panel → záložka Webhooky → +VYTVOŘIT webhookový PROJEKT
Prostřednictvím katalogu API:
- Levý navigační panel → Katalog API
- Vyhledat nebo filtrovat podle funkce Advanced Integrated Visibility
- Přehled → Klikněte na Dokumentace → V konzoli Sandbox klikněte na +VYTVOŘIT PROJEKT
- Dokumenty → Klikněte na +VYTVOŘIT webhook
Kroky k vytvoření webhooku
Krok 1: Vyberte typ společnosti
Klikněte na +VYTVOŘIT PROJEKT a z rozevíracího seznamu vyberte typ vaší společnosti:
- Odesílá zásilky se společností FedEx a potřebuje integrovat webhook společnosti FedEx do svého systému.
- Prodává nebo poskytuje softwarové řešení využívající data společnosti FedEx a není certifikovaným poskytovatelem kompaktního řešení FedEx.
- 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é Advanced Integrated Visibility podle čísla účtu
Tento proces zahrnuje čtyři hlavní kroky:
- Konfigurovat projekt
- Zadejte údaje o projektu
- Vyberte účty pro zasílání
- Potvrďte údaje a přijměte podmínky
Krok 1: Konfigurace projektu
Na stránce Konfigurace webhooku:
- Číslo fakturačního účtu:
- Zkontrolujte výchozí fakturační účet.
- Chcete-li to změnit:
- Klikněte PŘIDAT FAKTURAČNÍ ÚČET DO VAŠÍ ORGANIZACE (pokud existuje pouze jeden účet), nebo
- Klikněte na VYBRAT JINÝ FAKTURAČNÍ ÚČET (pokud existuje více účtů).
Poznámka: Je nutné mít fakturační účet v USA. Podrobnosti o cenách najdete v Cenovém přehledu služby Advanced Integrated Visibility.
Výběr funkce:
- Vyberte funkce, které chcete povolit, a poté klikněte na Další.
Popisy funkcí
| Název pole | Popis |
|---|---|
| Potvrzení o doručení | Potvrzuje, že zásilka byla úspěšně doručena. Potvrzení o doručení zásilky ve formě fotografie (PPODA): Poskytuje fotografii zachycující přesné místo doručení. Podepsané potvrzení o doručení (SPOD): Poskytuje snímek podpisu příjemce, jeho jména, data doručení, času a místa. |
| Předpokládané doručení | Pomáhá příjemcům plánovat tím, že poskytuje: Předpokládané datum doručení (EDD) Odhadovanou dobu 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 Na cestě Doručení Výjimky při doručení Vlastní možnosti doručení |
| Filtrování podle události | Filtruje odpovědi webhooku a zahrnuje: Importní zásilky Exportní zásilky Zásilky třetích stran |
Na stránce Zadání podrobností zadejte následující údaje:
| 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í obsahovat doménu fedex.com ani její subdomény Lze jej použít pro více webhooků Další podrobnosti najdete v části Obchodní pravidla a osvědčené postupy. |
| Token zabezpečení | Sdílený tajný klíč používaný k ověření 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 použít pro více webhooků |
| Jazyk datového obsahu (země) | V rozevíracím seznamu vyberte preferovaný jazyk pro překlad sledovacích dat. |
| Typ sledování | Zvolte, jak by měla být doručena data sledování: Podrobné sledování – Úplná historie událostí Sledování konkrétní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 si jazyk, ve kterém chcete dostávat 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 Vyberte účet pro odeslání zásilky:
- Vyberte jedno nebo více čísel zákaznických účtů FedEx, která chcete přiřadit ke svému webhookovému projektu.
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 API.
Krok 4: Potvrďte údaje a vytvořte
Na stránce Potvrdit podrobnosti:
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émově generovaný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é URL adresu jinou odpověď než HTTP 200 (OK) nebo 202 (Přijato), bude ověření webhooku považováno za neúspěšné.
