VEYNDO
Handbook
docs/hosted-component-api.mdView source ↗

English source · 3 min

Use Veyndo Commerce as a hosted API

Build your own storefront, merchant tool or agent against https://api.veyndo.ai. Its root and /.well-known/veyndo return the API profile in JSON. The native storefront and Studio are available on their existing addresses.

Make the first request

Read the catalog of the public Lumen demo. Use its shop ID in x-tenant. Choose a sales channel explicitly with sw-sales-channel-id if you need a channel other than the shop default.

curl -fsS https://api.veyndo.ai/.well-known/veyndo
curl -fsS https://api.veyndo.ai/store-api/product \
  -H 'x-tenant: lumen-story-lab-15-o-98aa4751fa' \
  -H 'Content-Type: application/json' \
  --data '{"limit":3}'

Use the same shop ID for its typed JavaScript and TypeScript clients. Use an existing shop or create one at Veyndo Start. To call merchant operations, create a scoped key in Developer → API & integrations and set it as a bearer credential in your backend.

Job Entry point Authority
Storefront language, currency and category navigation /store-api/context and /store-api/navigation Explicit shop and sales channel
Catalog, availability and cart /store-api/… Explicit shop, channel policy and cart token for cart operations
Buyer registration, sign-in, profile and orders /store-api/account/… Explicit shop and a current buyer token for signed-in calls
Merchant HTTP operations and apps /api/… The operation's required scopes on a key for that shop
MCP discovery and operations POST /mcp Shop selection and the caller's current scopes
UCP discovery /.well-known/ucp Explicit shop and eligible sales channel

From a custom browser frontend, call Veyndo through your own backend or same-origin proxy. Keep integration keys and privileged service credentials on the server. With SDK 0.4.18, shop.account.token handles registration, sign-in, password changes and sign-out. Sign-in returns the existing cart with a new cart token. Store that token and the buyer token in your own backend session. Backend sign-in recipe.

The Northflank API origin uses the running Core. Core routes to connected services using the shop's existing configuration. Individual service repositories also publish their own contracts and deployment instructions. Use their service origins and credentials only when operating those services independently. Component map · Service repositories and contracts.

For a custom checkout, use the review, confirm and recover recipe with the SDK checkout client. Load country and region choices before submitting the delivery address. The same cart supports checkout documents and acknowledgement and coupons and currency changes.

Build your storefront navigation

With SDK 0.4.20, catalog.context() returns the resolved locale and the shop's available locales and currencies. catalog.navigation() returns the localized categories visible in the selected sales channel. Pass a category ID to catalog.list({ categoryId }) to load the products for that part of the menu. All three reads use the same shop scope. JavaScript example.

Run your own API-only deployment

Set HTTP_PROFILE=api-only on the Core serving process. Keep the existing migration, database and worker setup. On a new instance, run the normal migration job before starting the server. This profile serves HTTP, MCP and UCP on every hostname that the deployment admits. Requests for native pages, checkout HTML and frontend bundles return a JSON 404. Checkout integrations can use their own interface and the existing cart and checkout APIs.

The shared deployment runs in the default combined profile. When SHOP_DOMAIN_SUFFIX is configured, its exact api.<suffix> hostname uses the API-only profile. Public discovery and health are available on that host. Store API, MCP and UCP requests identify a shop explicitly. Shop-scoped media URLs generated by Core also work with their embedded shop reference.