Skip to content

API — prehľad

Metty poskytuje dve verejné API. Každé beží na vlastnom hostname a používa vlastný typ kľúča:

APIhostnameúčelautentifikácia
Search APIhttps://search.api.metty.euvyhľadávanie a našepkávanie pre vlastné UIpk_ v query parametri key
Catalog APIhttps://catalog.api.metty.eusynchronizácia katalógu bez feedusk_ v hlavičke Authorization

Ak používate widget, nevoláte ani jedno z nich — widget si komunikáciu rieši sám.

Kľúče

kľúčtvarendpointyprenos
verejnýpk_ + 32 hexadecimálnych znakovSearch APIquery parameter key
secretsk_ + 64 hexadecimálnych znakovCatalog APIhlavička Authorization: Bearer <SECRET_API_KEY>

Verejný kľúč je určený na čítanie a môže byť súčasťou zdrojového kódu stránky. Secret kľúč povoľuje zápis do katalógu, a preto nepatrí do frontendu — jeho miestom je serverová konfigurácia, ideálne premenná prostredia.

Hlavičku Authorization nelogujeme. Požiadavku cez nešifrované HTTP endpoint odmietne a nepresmeruje ju, pretože kľúč už v tom momente odišiel po sieti.

Režim katalógu

E-shop je vždy v jednom z dvoch režimov: feed (katalóg importujeme z XML) alebo content_api (katalóg posielate cez API). Režimy sa nekombinujú — starší feed snapshot by prepísal novšie zmeny odoslané cez API.

Zápis do e-shopu v režime feed vráti 409 catalog_mode_conflict; prepnutie režimu vykonáva Metty. Čítanie touto poistkou neprechádza: export katalógu aj Search API fungujú v oboch režimoch.

Prehľad endpointov

operáciaendpoint
vyhľadávanieGET /search
našepkávanieGET /suggest
zápis katalóguPUT / PATCH / DELETE /catalog/products
bezpečný full snapshotPOST /catalog/syncs
export katalóguGET /catalog/products

Čo API zámerne neobsahuje

Kampane a pinning výsledkov, analytiku, personalizáciu, geografický ranking, vnorené objekty a objekty typu category, brand či article.

Ak pošlete parameter, ktorý by ovplyvnil výsledok a nedokážeme ho obslúžiť, vrátime chybu s jeho názvom. Filter, ktorý by sa ticho neaplikoval, považujeme za horší výsledok než explicitnú chybu.

Dokumentácia Metty