Správné využívání API

Ve chvíli, kdy připravujete doplněk, je dobré rovnou rozmýšlet, jaká data a v jakých intervalech budete opravdu potřebovat. Mnoho dat se dá získávat efektivně bez nutnosti vše opakovaně stahovat a tím tak zbytečně zatěžovat vaše i naše hw kapacity. Zároveň s tím je dobré mít rozvrženo, jaká data je pro vás důležité pravidelně sledovat a rozlišit ta, u kterých stačí jen kontroly méně často, popř. pomocí webhooků.

Využívejte endpointy Changes

U mnoha endpointů jsou i endpointy pro samotné změny. Není tedy nutné si např. každých 5 minut stahovat objednávky. Stahujete je v mnohem delších intervalech a mezitím využívejte endpointy, které pracují se změnami. Zároveň to můžete spojit i s využíváním webhooků a opět tak místo opakovaných requestů jen hlídat změny a podle nich si potřebná nová data stáhnout.

Používejte access token správně

Při instalaci doplňku jen potvrzujte, že jste si token uložili a potřebná data si žádejte až ve chvíli, kdy instalace v pořádku doběhne a vše bude funkční. Ve chvíli, kdy děláte více kroků najednou a dojde k nějaké chybě při instalaci, narazíte na limit použití tokenů a poté je nutné 30 minut čekat, než bude možné provést instalaci znovu.
Pokud si s instalací nejste jisti, dejte nám vědět a můžeme provést revizi celého instlačního procesu a pomoci vám vše správně spustit.

Nespoléhejte na webhooky

Webhooky sami o sobě pravidelně vše posílají a při selhání pak ještě několikrát zkusí notifikace doručit. Pokud by ale došlo k nějaké chybě a notifikace se k vám nedostaly, je vždy dobré sledovat, zda nemáte nějakou mezeru v získávání dat a případně mít připravenou zálohu ve formě stažení changes

Zpracovávejte requesty ve frontě

Ve chvíli, kdy získáváte formou requestů různá data, myslete prosím i na to, jakým způsobem se dotazujete a následně vše zpracujete. Jak nám, tak i vám v důsledku pomůže, když budou data zpracována v nějaké frontě než když vše pustíte najednou.

Hlídejte si stavové kódy

V rámci API občas může dojít k nějakým chybám, ty jsou pak hlášeny pomocí stavových kódů. Ty které obsahují 5xx, jsou způsobené chybou/neočekávaným chováním na naší straně a ty, u kterých vidíte chybu 4xx, jsou pak na straně vaší – do toho je ale započítáno i překročení limitů API – ty uvádějí chybu 429 Too Many Requests. Je tedy vždy dobré sledovat, zda se vám tyto stavové kódy neobjevují a pokud ano, věnovat jim zvýšenou pozornost.

Cachujte

Základem správného používání a využívání API je práce s daty, která jste si stáhli. I když omezíte stahování kompletních dat a budete spoléhat na changes a webhooky, budou existovat data, která není nutné stahovat x-krát denně a tyto requesty mohou mít delší intervaly.

Pracujte se seznamovými endpointy

Endpointy mají kromě detailů objednávek, produktů atp. i endpointy pro seznamy, kde jsou taktéž základní informace dostupné. Není tedy vždy nutné chodit do detailu objednávek postupně a vše zjišťovat, ale rovnou si vytáhnout data přes seznam objednávek a ušetřit tím několik requestů.

Žádejte o nové funkce

Pokud potřebujete z API získávat nějaké informace a chybí vám potřebný endpoint, popř. hodnota v něm obsažená, dejte nám vědět a pokusíme se jej co nejdříve připravit. Určitě není řešením ve chvíli, kdy nějaká data chybí, zkoušet vše obcházet a vytěžovat více API na jiných místech.

Facebook
Twitter