Skip to content
SeekGist
Language: العربية
Menu

Get started

Create a store, get your keys, send products and run your first search.

What you need

  • A SeekGist account. Sign up in the dashboard at /app. Every new store starts with a free trial.
  • Your store's products, from a store platform (OpenCart, WooCommerce, Shopify, Salla, Zid, Magento) or from your own system.

The dashboard has an onboarding wizard: pick your platform, install the connector, build the first index, run the first search. If you use a platform, follow its quick start instead of the steps below. The steps below are for your own code.

1. Get your keys

Open API keys in the dashboard. You get two kinds of keys:

KeyStarts withUse it forWhere it may live
Public keysg_pub_suggest, search, recommend, clicks, eventsthe browser, your theme, the widget
Secret keysg_sec_products, synonyms, rules, translation, analytics, webhooksyour server only

2. Send your products

Send products in batches of up to 1,000 with your secret key. Text fields are maps of language to text, so one product can carry English and Arabic names.

curl -X POST https://api.seekgist.com/v1/products/batch \
  -H "Authorization: Bearer $SEEKGIST_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: first-import-001" \
  -d '{
    "upsert": [{
      "id": "42",
      "name": {"en": "Women's Satin Evening Dress, Red, size M", "ar": "فستان سهرة نسائي من الساتان، أحمر، مقاس M"},
      "brand": "Example Brand",
      "price": "89.00",
      "currency": "USD",
      "in_stock": true,
      "url": "https://shop.example/p/42",
      "categories": [{"id": "20", "path": [{"en": "Women", "ar": "نسائي"}, {"en": "Dresses", "ar": "فساتين"}]}],
      "attributes": {"Color": "Red", "Size": "M"}
    }]
  }'

The example product is made up. The answer tells you how many products were added, unchanged or deleted. Sending the same product again with no change does nothing and costs nothing.

Use your public key. Suggestions while typing come from /v1/suggest. They are never billed.

curl "https://api.seekgist.com/v1/suggest?q=dre" \
  -H "Authorization: Bearer $SEEKGIST_PUBLIC_KEY"

A full search (when the shopper presses Enter) comes from /v1/search:

curl --get "https://api.seekgist.com/v1/search" \
  --data-urlencode "q=فستان سهرة تحت 100" \
  -H "Authorization: Bearer $SEEKGIST_PUBLIC_KEY"

The answer has ids (product ids in rank order), hits (product cards), facets, and query, which shows what SeekGist understood: for this request, an evening dress and a price limit of 100.

4. Send clicks

When a shopper clicks a result, send the search_id from the search answer back. Clicks power analytics and better ranking.

curl -X POST https://api.seekgist.com/v1/click \
  -H "Authorization: Bearer $SEEKGIST_PUBLIC_KEY" \
  -H "Content-Type: application/json" \
  -d '{"search_id": "<from the search answer>", "product_id": "42", "position": 1}'

Next steps