Úvod
Předplatné sledovacího čísla Advanced Integrated Visibility je určené pro předplatitele služby Advanced Integrated Visibility, kteří chtějí spravovat své sledovací číslo podle projektů webhooků a provádět operace související s projekty, jako je přidávání nových sledovacích čísel, úprava nebo zobrazení detailů úloh s využitím koncových bodů rozhraní API.
Poznámka:
- Pro svůj projekt Advanced Integrated Visibility musíte mít oprávnění správce nebo přispěvatele
- Pro více informací o službě Advanced Integrated Visibility a jejích funkcích navštivte stránku dokumentace Advanced Integrated Visibility.
Výhody služby předplatného sledovacího čísla Advanced Integrated Visibility
Výhody služby předplatného sledovacího čísla Advanced Integrated Visibility jsou:
- Pomocí API koncových bodů můžete snadno aktualizovat a spravovat sledovací čísla svého projektu Advanced Integrated Visibility.
- Toto rozhraní API vám umožňuje přiřadit k vašemu projektu více sledovacích čísel v rámci jedné API transakce, místo abyste přiřazovali každé sledovací číslo jednotlivě.
- API požadavky můžete odesílat za sebou a prohlížet si záznamy o jejich úspěších či chybách.
Jak funguje služba předplatného sledovacího čísla Advanced Integrated Visibility
K správě vašeho projektu Advanced Integrated Visibility použijte níže uvedené koncové body:
K tomuto rozhraní API lze přistupovat pouze prostřednictvím přehledu projektu, jak je znázorněno na výše uvedeném snímku obrazovky.
Přiřazení sledovacího čísla
Tento koncový bod použijte ke spuštění asynchronní úlohy, která přiřadí jedno nebo více sledovacích čísel ke konkrétnímu projektu Advanced Integrated Visibility.
Požadované vstupní údaje pro tento požadavek jsou:
- Akce – Určete, jaká akce má být provedena při odeslání požadavku. Příklad: ADD
- Podrobnosti o sledovacím čísle – Zadejte sledovací číslo
V rámci jednoho požadavku můžete přiřadit maximálně 1 000 sledovacích čísel. Úspěšná odpověď na tento požadavek vrátí jobID, aktuální stav úlohy a časová razítka vytvoření a dokončení úlohy. Toto jobId lze později použít ke zjištění stavu asynchronní úlohy.
Stav úlohy podle sledovacího čísla
Použijte tento koncový bod ke zjištění stavu asynchronní úlohy (jednoho nebo více po sobě jdoucích požadavků ve frontě) nebo stavu všech odeslaných úloh.
Požadované vstupní údaje pro tento požadavek jsou:
- ID úlohy – Zadejte ID úlohy, pro kterou chcete získat stav.
Poznámka: Zadání ID úlohy není pro tento koncový bod povinné. Pokud nezadáte ID úlohy, zobrazí se stav všech odeslaných úloh.
Úspěšná odpověď na tento požadavek vrátí jobID, aktuální stav úlohy a časová razítka vytvoření a dokončení úlohy. Odpověď zobrazí aktuální stav úloh. Odpověď navíc obsahuje i hlášení o úspěchu, chyby nebo varování, která si uživatelé mohou prohlédnout a podle potřeby použít k diagnostice problému.
- Pokud je stav úlohy zobrazen jako DOKONČENO, znamená to, že všechna sledovací čísla byla úspěšně ověřena a zpracována.
- Stav DOKONČENO znamená, že sledovací čísla byla úspěšně ověřena a zpracována. Tento stav neznamená, že všechna sledovací čísla byla úspěšně začleněna do projektu Advanced Integrated Visibility.
- Pokud se pokusíte přiřadit více sledovacích čísel a některá z nich se přiřadí úspěšně, zatímco ostatní se nepodaří přiřadit, bude stav úlohy i přesto aktualizován na stav DOKONČENO. Pro potvrzení stavu každého sledovacího čísla v požadavku na přiřazení je nutné stáhnout hromadnou zprávu (batch report).
- Pokud je stav úlohy zobrazen jako NEÚSPĚŠNÝ, znamená to, že z různých důvodů či kvůli závažným chybám nebyl požadavek zpracován a uživatel jej musí opakovat.
Poznámka:
Níže jsou uvedeny stavy a jejich odpovídající popisy:
| STAV ÚLOHY | POPIS |
|---|---|
ODESLÁNO |
Úloha je do systému odeslána po úspěšném provedení základních kontrol a následně zpracována asynchronně. |
PŘIJATO |
Úloha je přijata a čeká ve frontě na zpracování. |
NEPŘIJATO |
Úloha nebyla přijata kvůli interní chybě nebo nedostupnosti systému a uživatel ji musí znovu odeslat. |
VE FRONTĚ |
Úloha je zařazena do fronty ke zpracování a zpracování může začít kdykoli. |
PROBÍHÁ |
Úloha byla zahájena a je ve stavu probíhajícího zpracování. |
DOKONČENO |
Úloha byla dokončena a uživatel si může stáhnout importní zprávu nebo exportní soubor. |
NEÚSPĚŠNÝ |
Úloha byla neúspěšná z několika důvodů a musí být uživatelem opakována. |
Detaily úlohy podle sledovacího čísla
Použijte tento koncový bod ke stažení JSON zprávy pro asynchronní úlohu ve stavu DOKONČENO.
Požadované vstupní údaje pro tento požadavek jsou:
- ID úlohy – Zadejte ID úlohy, pro kterou chcete získat stav.
Poznámka:
- Pro tento koncový bod je zadání ID úlohy povinné.
- Report lze stáhnout pouze pro jednu asynchronní úlohu najednou.
- Pokud úloha není ve stavu DOKONČENO a pokusíte se stáhnout zprávu, zobrazí se chybová zpráva.
Úspěšná odpověď na tento požadavek vám poskytne zprávu o úloze ve formátu JSON.
Obchodní pravidla
- V jednom požadavku lze k projektu Advanced Integrated Visibility přiřadit maximálně 1 000 sledovacích čísel zásilek.
- K danému projektu Advanced Integrated Visibility můžete přiřadit neomezený počet sledovacích čísel.
- Všechna přiřazená sledovací čísla budou z projektu Advanced Integrated Visibility odpojena po 40 dnech.
- Stav a podrobnosti ke všem vytvořeným ID úloh nebudou pro daný projekt Advanced Integrated Visibility dostupné po uplynutí 90 dnů.
- Zabezpečené informace o sledování, jako je adresa příjemce nebo podpis příjemce, nebudou dostupné prostřednictvím služby předplatného sledovacího čísla Advanced Integrated Visibility.
