Doporučení pro vaše importy (read rozhraní)
Tato doporučení se týkají importů směrem k Vám, tedy READ rozhraní a zobrazování na Vašem webu.
1. Lokální zpracování vs on-the-fly
Různé filtrace nad daty apod. umožňují, abyste s daty pracovali on-the-fly, stejně jako si data můžete stahovat lokálně.
Dovolujeme oba přístupy s tím, že pokud si přejete stahovat opakovaně vždy celý balík dat, tak pro větší objemy inzerátů doporučujeme, abyste si data stáhli lokálně a předešli tak přetěžování. (Zaznamenali jsme klienta, který stahoval v každém požadavku cca 10MB dat!)
U lokálního stahování si před zpracováním dat zkontrolujte, zda-li je soubor dostupný, popř. obsahuje validní data. Ačkoliv se snažíme o co nejlepší dostupnost, byla by škoda, abyste si v takovém případě způsobili nedostupnost dat v lokální aplikaci.
Počty požadavků nejsou momentálně omezeny, jsou však kontrolovány a budeme řešit případné přílišné zatěžování serveru!
2. Práce s foto
Fotografie si buď stahujte lokálně a následně zde používejte Vaše generování pro různé velikosti, popř. si různé velikosti stáhněte přes naše API. NEBO v případě on-the-fly použijte odkazování na náš res.tmimg.cz.
Nedoporučujeme odkazování pouze na naše nezmenšené foto (zaznamenali jsme web, kdy pro 100px náhledy používali foto v plném rozlišení).
3. Používejte různé úrovně detailu
Pokud zpracováváte pouze některá data, zmenšete si objem zpracovaných dat úrovní ?detail=custom:...
(a bez výpisu podagend rovněž zrychlíte i generování).
Pokud naopak chcete celé balíky dat u číselníků, nemusíte postupně stahovat všechny, ale můžete si ulehčit práci úrovní ?detail=full
a stáhnout tak všechna data v jednom kroku
Pokud si např. na Vašem webu potřebujete naopak získat pouze seznam výrobců pro nějaký Váš filtr, můžete používat Filtr v číselnících dle firmy (zaznamenali jsme zcela zbytečné stahování všech dat firmy pouze kvůli tomu, aby si firma načetl seznam značek!)
4. Při použití stránkování používejte ?add-row-count=true
Někteří uživatele zašlou požadavek na ID s kompletním výpisem, lokálně ho spočítají a následně stránkují. Od počtu výsledků je zde ?add-row-count=true
, který vrátí počet všech odpovídajících záznamů.
5. Při synchronizaci využívejte lastModified
Kde to lze, zadáváme položku lastModified
obsahující datum poslední editace (u struktur photo
pak v tagu stamp
). Ukládejte si čas naší poslední editace a položky aktualizujte pouze při změnách!
6. Na kontrolu změn využívejte hooky
Ideální postup pro synchronizaci je takový, že implementujete web-hooky a pro změny používáte tyto. A např. jednou denně (nejlépe v nočních hodinách) pro jistotu zkontrolujete data posledních aktualizací (co kdyby hooky nedorazily). Budete tak mít neustále aktuální data.