Quickstart

Shop live and sellable in five calls.

​

1 · Get an API token

In the Alyte console: API keys → Mint, preset full (merchant:read + merchant:write + merchant:admin — this quickstart creates a shop and links a PSP, which need merchant:admin). The token is shown once — keep it server-side; never ship it to a browser.

​

2 · Install the SDK

npm install @alytegen/sdk   # zero dependencies, Node ≥ 18

Source, the quickstart and runnable examples are public at github.com/Alytegen/alyte-sdk. (Or call the REST API directly — the SDK is a thin typed client over it.)

​

3 · Onboard

import { AlyteMerchant } from '@alytegen/sdk';

const alyte = new AlyteMerchant({ baseUrl: ALYTE_URL, token: process.env.ALYTE_API_TOKEN });

// Your shop — your settlement identity. Money lands on YOUR PSP, never Alyte's.
const { merchant } = await alyte.createShop({ name: 'Nova Live', geo: 'DE', currency: 'EUR' });

// Your own Stripe. The secret key is vaulted immediately — only an opaque
// reference is ever stored or returned. The publishable key powers the
// buyer card-capture iframe.
await alyte.linkPsp(merchant.id, {
  psp: { id: 'stripe', name: 'Stripe' },
  isDefault: true,
  secret: process.env.MY_STRIPE_SECRET_KEY,
  publishableKey: process.env.MY_STRIPE_PUBLISHABLE_KEY,
});

// Inventory. priceMinor is integer cents: 4900 = €49.00. Floats are refused.
const { event } = await alyte.createEvent({
  merchantId: merchant.id, title: 'Nova Live — Warsaw', startsAt: '2026-11-04T19:00:00Z',
});
const { tier } = await alyte.createTier({
  eventId: event.id, title: 'General admission',
  priceMinor: 4900, currency: 'EUR', kind: 'general', availableCount: 500,
});

Scheduling a drop at creation. POST /v1/integration/tiers accepts the tier restrictions — onSaleStart, onSaleEnd, maxQtyPerPurchase, sellable, allowedGeos, allowedSchemes — and saves them in the same write as the tier, so a tier created with a future onSaleStart is never on sale early. Unknown fields are refused with 400 and the offending names in details.fields, so a typo can’t silently drop a restriction.

@alytegen/sdk 0.4.0 includes these fields in createTier. Set scheduling and restrictions in that initial call so the tier is never briefly sellable:

const { tier: scheduledTier } = await alyte.createTier({
  eventId: event.id, title: 'Scheduled admission', kind: 'general',
  priceMinor: 4900, currency: 'EUR', availableCount: 500,
  onSaleStart: '2026-11-01T09:00:00Z', maxQtyPerPurchase: 2,
});

To confirm a scheduled tier, read it back with GET /v1/integration/catalog: its onSaleStart is set and discovery reports it not_yet_on_sale. The self-test’s catalog_sellable check counts tiers that are buyable now; it does not list individual upcoming tiers.

​

4 · Send a buyer to authorize their agent

If your users are already signed in with your auth, carry their identity into Alyte. Creating spending authority still requires buyer verification unless you use the separately enabled contracted attestation flow:

const s = await alyte.buyerSessions.mint({ merchantId: merchant.id, email: user.email });
res.redirect(ALYTE_URL + s.redeemPath);   // single-use link, 15-minute TTL

They land on the shop’s authorize page: pick or bring an agent, set a spending cap. Alyte enforces that cap server-side on every purchase the agent attempts.

​

5 · Watch the money arrive

Payments settle on your PSP. Alyte gives you the audit trail:

const { payments } = await alyte.listPayments();

That’s the whole loop. For agent-side integration (discover → quote → hold → confirm), see the API reference — the same flow the AlyteAgent client wraps.