Best practices

Při tvorbě napojení se snažte používat webhooky místo pravidelného volání API v krátkých časových intervalech. Vaše napojení může být rychlejší a nedochází tak k vytěžování našich serverů.

Položky není nutné stahovat po jedné, využívejte stránkování.

Položky není nutné stahovat vždy všechny, využívejte parametry které konkrétní endpoint API nabízí. Jedná se hlavně o parametr změněno od data, což vrátí položky změněné od konkrétního času.

Sekce jako jsou Provozovatel eshopu, Jazyky, Ceníky, Dostupnosti, Štítky, Nastavení eshopu, Skupiny zákazníků, Stavy objednávek není třeba stahovat pravidelně, využívejte webhooky a cache na svojí straně napojení.

Produkty

• Seznam (GET)

  • Produkty
    • Pokud potřebujete využívat data o produktu, například při založení nové objednávky, doporučujeme provádět stažení na základě ID produktu. Kód produktu není povinný údaj a někteří klienti jej nemusí mít vyplněný.
    • Produkty není nutné stahovat každý zvlášt. Využívejte stránkování.
  • Varianty
    • Varianty je možné posílat v jednom požadavku, není nutné každou variantu posílat zvlášť.
    • Pokud chcete stahovat parametry jednotlivých produktů (variant), není nutné je stahovat samostatně. Lze použít /products/parameters, ve kterém je informace o všech produktech a variantách.

• Aktualizace (PUT)

  • Produkty
    • Pokud potřebujete produkty aktualizovat, aktualizujte pouze ta data která se změnila. Pokud budete například vkládat pouze překlady, nemusíte k tomu posílat váhu, zda-li má být produkt vložitelný do košíku, atd.

Objednávky

• Seznam (GET)
  • Pokud potřebujete mít ve svém doplňku tlačítko na stahování aktuálních objednávek, myslete nejdříve na webhooky. Pokud dané tlačítko musí být skutečně uvedeno, doporučujeme jej nastavit tak, aby nebylo možné používat opakovaně během pár sekund. Použití musí být podmíněno minimálně vždy tak, aby se dalo aktivovat až po dokončení předchozího stahování + například nějaký interval.
  • Objednávky není nutné stahovat po jedné. Využívejte stránkování.
  • Objednávky není vždy nutné stahovat všechny a z celé historie eshopu. Používejte parametry v URL adrese tak, abyste minimalizovali nároky na odpověď.

Doplňky - Best practices

Pokud jste partnerská agentura, která vytváří doplňky do Upgates, Best practices pro doplňky najdete v naší sekci pro vývojáře