Skip to content

Getting started

Access keys

When your e-shop is set up in Metty, you receive two keys:

keyformatpurposewhere it belongs
publicpk_ + 32 hexadecimal charactersreads — the widget and the Search APImay appear in page HTML
secretsk_ + 64 hexadecimal characterscatalog writes — the Catalog APIserver only, never in a frontend

The public key is visible to anyone who views the page source and grants read access only. The secret key allows writing to the catalog, so it belongs in server configuration or an environment variable.

First steps

  1. Install the widgetone script tag and search works on your e-shop.
  2. Check the catalog — we import products from your feed, or you send them through the API.
  3. Verify search — try GET /search with a few queries from your own range.

Service addresses

serviceaddress
Search APIhttps://search.api.metty.eu
Catalog APIhttps://catalog.api.metty.eu
widgethttps://widget.metty.eu
documentationhttps://docs.metty.eu

The customer preview — the widget shown on your site before it goes live — runs on preview.metty.eu; we send you the link.

Catalog mode

An e-shop is always in one of two modes:

  • feed — we import the catalog from your XML feed. You send nothing, we only need the feed URL.
  • content_api — you send the catalog through the Catalog API.

The modes are not combined and switching between them is done by Metty. The reason is that an older feed snapshot would overwrite newer changes sent through the API.

Where to continue

  • Installing the widget — the fastest route to working search
  • API overview — when you want to drive the catalog from your own system or build your own UI
  • PHP client — a ready-made library instead of your own HTTP calls
  • Examples — working samples of synchronisation and search
  • Errors and limits — error codes, rate limits and the retry strategy

Metty documentation