O produktu
Bidding API je služba Heureky, která poskytuje aktuální údaje z produktového katalogu Heureky. Důležité informace pro efektivní bidování, které jsou vidět na produktovém detailu jsou součástí API.
Cíl
Více jak polovina výkonové kapacity serverů Heureky je spotřebována robotickým procházením webu Heureky. Crawlování webu Heureky chceme omezit a poskytnout náhradu v podobě placeného API s přidanou hodnotou.
Dokumentace API
Vždy aktuální dokumentace k API je na adrese https://api.heureka.cz/bidding_api/v1/apidoc
Dokumentace obsahuje struktury volání a odpovědí s příklady vrácených výsledků. Možné návratové hodnoty jednotlivých atributů jsou viditelné v záložce “Structure”. Stromová struktura je rozbalovací po kliknutí a obsahuje hint nápovědu po najetí myší. Interaktivně je možné provést volání na API po vyplnění Vám přiděleného tokenu do klíče access_key.
Endpointy pro volání API
Heureka.cz katalog https://api.heureka.cz/bidding_api/v1/apidoc
Heureka.sk katalog https://api.heureka.sk/bidding_api/v1/apidoc
Implementace na straně klienta
JSON-RPC je bezstavový protokol pro vzdálené volání procedur (RPC). Pro implementaci API na vaší straně je možno použít dostupné knihovny pro daný programovací jazyk. V
případě jazyka Python se můžete inspirovat ukázkou níže. Ke komunikaci s našimi
API servery vám přidělíme klíč, který v parametrech použijete jako atribut access_key.
https://pypi.org/project/json-rpc/
Cache na straně Heureky
Kvůli zlepšení rychlosti odpovědí jsou na straně Heureky po dobu 1h cachovaná data ceny dopravy a výpis kategorii v metodě category.index.
Limity
Servery jsou hostované mimo cloud a nejsou nafukovací. Minutový limit počtu volání pro každý klíč je 10 000 tak, aby nedocházelo ke špičkovému zatížení clusteru. Budeme rádi,
pokud dokážete volání API plynule rozložit v čase.
Notifikace
V průběhu měsíce vám budeme posílat notifikace o průběžném stavu počtu volání API pro váš klíč.
Fakturace
Zpětně za předchozí měsíc vám budeme posílat generované faktury za počet volání API dle využitého tarifu.
Jak probíhá aktivace API?
Nejprve je potřeba potvrdit smlouvu na objednávku této služby, poté vám bude poskytnut přístup/token, dokumentace a další potřebné informace. Následně stačí implementovat API.
Od kdy bude omezován crawling?
Omezování plánujeme od 1.11.2018. Pokud do tohoto data nestihnete implementovat API, zašlete mi všechny IP adresy a User boty, které využíváte na crawlování, abychom je mohli přidat na Whitelist a neblokovali je.
Toto období, kdy budeme tolerovat crawling a počítat vám volání přes obě varianty bude trvat do ledna 2019. Poté je nutné přejít kompletně na API.
Bude mi chodit notifikace o průběžném stavu volání?
Ano, bude. Do emailu vám bude chodit týdenní report s počtem volání.