Dokumentace API

Přístup a klíče

Každý obchod získá vlastní klíč: ma- následované 32 znaky. Posílejte jej v hlavičce X-Worker-Key (nebo Authorization: Bearer). Klíč funguje pouze pro domény obchodu, které k němu patří; doménu posílejte v X-Shop-Domain.

POST /lookup HTTP/1.1
Host: api.data-enricher.com
X-Worker-Key: ma-…
X-Shop-Domain: yourstore.com
Content-Type: application/json

Každý klíč má měsíční limit požadavků. Odpovědi z mezipaměti se nezapočítávají. O klíč požádejte přes kontaktní stránku.

POST /lookup

Vyhledá produkt podle jeho EAN a vrátí údaje a ověřené fotografie. EAN-8, UPC-A, EAN-13 a GTIN-14 se ověřují včetně kontrolní číslice; UPC-A se převede na EAN-13.

{"ean": "7333377653917", "name": "Husqvarna 550i XP", "refresh": false}

{"result": {
  "ean": "7333377653917", "identified": true, "name": "Husqvarna 550i XP",
  "description": "…", "specs": {"Battery voltage": "36 V"},
  "images": {"in_use": ["https://…"], "product": ["https://…"]},
  "sources": ["https://…"], "cached": false, "credits_used": 0, "search": "free"
}}

Vrací se nejvýše osm fotografií, nejprve snímky produktu při použití, a vždy se ponechá místo alespoň pro tři fotografie samotného produktu, pokud existují. Chyba je v result.error; v takovém případě se nic neukládá, takže to můžete později zkusit znovu.

POST /text

Napíše produktové texty v jednom jazyce: název, krátký a dlouhý popis, meta titulek a meta popis.

{"ean": "7333377653917", "name": "Husqvarna 550i XP", "language": "en", "format": "html"}

language je kód ISO: nl, en, de, fr, es, it, pt, pl, da, sv, no, fi, cs, ro, zh, ja, ru nebo ko. Jiný kód vede k použití angličtiny s upozorněním warning. format je html nebo text.

Kromě hotového popisu description získáte popis po částech: intro_html a sections (vlastnosti, proč si jej vybrat, výhody, nevýhody, obsah balení, časté dotazy, o značce), každou s nadpisem v jazyce textu. Sestavte si vlastní popis s požadovanými částmi a pořadím. details obsahuje vše také jako data: specifikace, vlastnosti, klíčová slova, barvy, materiály a velikosti.

POST /page-text

Texty pro stránku kategorie nebo značky: krátký popis nahoru, dlouhý popis po částech, meta titulek a meta popis s interními odkazy na stránky vašeho obchodu.

{"type": "category", "entity_id": 12, "name": "Chainsaws", "language": "en",
 "path": "Garden > Chainsaws", "subcategories": ["Cordless chainsaws"],
 "brands": ["Husqvarna"], "products": ["Husqvarna 550i XP"],
 "links": [{"type": "subcategory", "title": "Cordless chainsaws", "url": "https://yourstore.com/cordless-chainsaws"}],
 "shop_name": "Your Store"}

Odkazy vedou pouze na URL, které pošlete, na každou nejvýše jednou a nejvýše šest odkazů na text. Pro značku ("type": "brand") pošlete categories místo subcategories a brands; API pak také vyhledá značku na webu.

POST /jobs

Až dvacet kódů EAN najednou, pět se vyhledává současně. Okamžitě dostanete zpět identifikátor job_id .

{"items": [{"ean": "7333377653917", "name": "Husqvarna 550i XP"}, {"ean": "8716637053167"}]}

Průběh sledujte pomocí GET /jobs/{job_id}: status je queued, running nebo done, a results zachovává pořadí vašeho požadavku.

GET /usage

Vaše využití a limity v aktuálním období: požadavky, kredity a tokeny AI.

Chyby

Chyby obsahu, například produkt, který nelze najít, se vracejí se stavem 200 a položkou error ve výsledku.