Developers

SEEGEA Public API

Read-only REST API over the catalog of a shop connected to SEEGEA: products, variants, collections and orders, in one shape whatever the CMS behind them (Shopify, PrestaShop).

Discovery

OpenAPI 3.1 specification : https://www.seegea.com/openapi.json
Authorization server metadata (RFC 8414) : /.well-known/oauth-authorization-server
Protected resource metadata (RFC 9728) : /.well-known/oauth-protected-resource
Base URL : https://www.seegea.com/api/v1

Getting a key

API access is included in the Business plan. From a Business account, open Settings → API and click “Create a key”: it is generated immediately and shown once. No sales form, no manual approval.

A key looks like sgk_<identifiant>.<secret>: the part before the dot is the OAuth client_id, the part after it the client_secret.

See the plans — the API is Business-only; the other plans give access to the grid and to automations.

Scopes

Scope	Description
`catalog:read`	Read products, variants, media and collections.
`orders:read`	Read imported orders (read-only mirror of the CMS orders).
`account:read`	Read the connected shop, its plan and its usage counters.

Authentication

Option 1 — API key as a Bearer token

curl -H "Authorization: Bearer sgk_xxx.yyy" \
  https://www.seegea.com/api/v1/shop

Option 2 — OAuth 2.0 client credentials

curl -X POST https://www.seegea.com/api/oauth/token \
  -u "sgk_xxx:yyy" \
  -d "grant_type=client_credentials" \
  -d "scope=catalog:read"

The response contains an access_token valid for one hour, sent afterwards as a Bearer token.

A 401 carries a WWW-Authenticate header with the resource_metadata parameter (RFC 9728), so an agent can discover the scopes and the token endpoint unaided.

Endpoints

operationId	Method	Path	Scope
`getShop`	GET	/shop	`account:read`
`listProducts`	GET	/products	`catalog:read`
`getProduct`	GET	/products/{productId}	`catalog:read`
`listCollections`	GET	/collections	`catalog:read`
`listOrders`	GET	/orders	`orders:read`

Pagination

List endpoints are cursor-paginated. Follow next_cursor while has_more is true.

curl -H "Authorization: Bearer sgk_xxx.yyy" \
  "https://www.seegea.com/api/v1/products?limit=100&cursor=eyJ0Ijoi..."

Rate limits

120 requests per minute per credential. Every response carries RateLimit-Limit and RateLimit-Remaining; a 429 carries Retry-After.

Command line

The official CLI wraps the API for scripts and agents:

npx @seegea/cli login
npx @seegea/cli shop
npx @seegea/cli products list --limit 50

What the API does not do

It is read-only: writes go through the SEEGEA grid or through automations.
It does not expose the customer email addresses attached to orders.
It never returns products hidden by the plan limit, nor deleted products.

For agents

/llms.txt — site index
/agent-instructions.md — when and how to call SEEGEA
/openapi.json — function-calling definitions