Jak k webhooku přidat sledovací číslo
Chcete-li přidat sledovací číslo do svého předplatného webhooku pomocí rozhraní API pro předplatné Advanced Integrated Visibility podle sledovacího čísla, postupujte podle následujících kroků:
- Vytvořte projekt předplatného Advanced Integrated Visibility podle sledovacího čísla podle kroků uvedených v předchozí části nebo podle kroků v Průvodci Začínáme.
- Pro zahájení volání rozhraní API pro předplatné služby Advanced Integrated Visibility podle sledovacího čísla potřebujete OAuth token. Chcete-li vygenerovat token OAUTH, použijte rozhraní API pro autorizaci. Podrobný postup pro vygenerování tokenu OAUTH naleznete v dokumentaci k rozhraní API pro autorizaci v katalogu rozhraní API.
- Klikněte na možnost Podrobnosti o projektu v levém navigačním menu. 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.
Jakmile přejdete na dokumentaci API pro předplatné služby Advanced Integrated Visibility podle sledovacího čísla, najdete tři koncové body:
Koncový bod přidružení sledovacích čísel
- Tento koncový bod slouží k přidání nebo odebrání sledovacích čísel k danému předplatnému webhooku. Další podrobnosti naleznete v dokumentaci rozhraní API pro předplatné Advanced Integrated Visibility podle sledovacího čísla.
- Přidání nebo odebrání sledovacích čísel je asynchronní úloha. ID úlohy je odesláno jako odpověď na přidání nebo odebrání volání rozhraní API pro přidružení sledovacích čísel.
Koncový bod sledovacího čísla podrobností o úloze
Tento koncový bod poskytuje podrobnosti o daném ID úlohy, například kolik ze všech odeslaných sledovacích čísel bylo úspěšně přidáno k danému předplatnému webhooku nebo kolik se jich stále zpracovává.
Koncový bod sledovacího čísla stavu úlohy
Tento koncový bod vám umožní získat aktuální přehled všech zpracovávaných úloh.
- Pomocí tokenu AUTH vygenerovaného v kroku 2 a koncového bodu přidružení sledovacích čísel přidejte sledovací čísla do předplatného webhooku.
Pravidla ověřování:
- Název webhooku musí být jedinečný.
- Cílová adresa URL webhooků musí být ve standardizovaném syntaktickém formátu.
- Všechna povinná pole pro vytvoření webhooku nesmí být prázdná.
- Pro vytvoření webhooku musí být přidruženo alespoň jedno dostupné číslo účtu FedEx pro zasílání.
- V případě úspěšného ověření:
- Po úspěšném vytvoření webhooku zákazník obdrží potvrzovací zprávu.
Ukázka potvrzovací zprávy: Webhook <<název_webhooku>> byl úspěšně vytvořen. Změny se mohou projevit až po 10 minutách.
- Po úspěšném vytvoření webhooku zákazník obdrží potvrzovací zprávu.
- V případě neúspěšného ověření:
- Pokud společnost FedEx obdrží jinou odpověď než 200 (OK) nebo 202 (Přijato), bude ověření cílové adresy URL webhooku považováno za neúspěšné.
Response