Start here
Credentials
Reference only. Not a decision unless cited in product/DECISIONS.md.
Credentials
AXYN headless integrations use a Stripe-shaped install: two credentials. API and Auth hosts are defaults. Sandbox uses the production API host with a test key.
Required
| Name | Env | Kind | Where |
|---|---|---|---|
| Secret API key | AXYN_API_KEY (axyn_sk_test_... first, axyn_sk_live_... for go-live) | Secret | Server only |
| Publishable checkout key | AXYN_PUBLISHABLE_KEY | Publishable | Browser / BFF OK |
Never put AXYN_API_KEY in a browser bundle. Never install the service role on
your site.
Production defaults (not required install)
| Resource | Default |
|---|---|
| API URL | https://api.axyn.events |
| Auth URL | https://auth.axyn.events |
Bootstrap snippets and SDKs should use these unless an internal local harness explicitly overrides them.
Mint keys
- Open Admin -> Settings -> Developer.
- Create a Test API key first. It is returned once and starts with
axyn_sk_test_. - Store it as
AXYN_API_KEYin your server secret manager. - Use
https://api.axyn.eventsfor catalog, order, and ticket calls. - When live access is enabled for your organization, create a Live API key.
It starts with
axyn_sk_live_. Swap only the secret key, not the host.
Existing live installs may still have legacy axyn_sk_... keys. New self-serve
keys use the explicit test and live prefixes.
Optional overrides (internal local only)
External partner sandbox work should not set API or Auth URL overrides.
Sandbox is https://api.axyn.events plus an axyn_sk_test_... key.
# Internal AXYN local harnesses only:
# AXYN_API_URL=http://localhost:4001
# AXYN_AUTH_URL=http://localhost:54321
Do not invent Auth or API hosts. Do not reuse another partner’s credentials.
Not installable credentials
| Item | Why |
|---|---|
| Buyer JWT | Minted at runtime via Auth (signInAnonymously or magic link / OAuth) |
| Service role | Platform-only; never on a venue site |
| Stripe secret | AXYN creates PaymentIntents; use the publishable key returned by AXYN when confirming in Stripe.js |
| Scanner token | Door devices only |
How the two keys are used
Browser → Auth (default Auth URL + publishable key) → buyer JWT
Your server → API (default API URL + secret key) → catalog
Browser / BFF → API + buyer JWT → orders / pay / tickets
Tenant identity comes from the secret API key lookup. Do not send tenant_id in
JSON bodies as authority.
Security
- Treat
AXYN_API_KEYlike a password: secret manager only, rotate if leaked. - Never log raw keys, buyer JWTs, or scanner tokens.
- Never put the secret key in mobile apps, SPAs, mobile config, or CI logs.
- Do not probe other tenants’ event or order ids — cross-tenant misses look like 404s by design.
- Report suspected key leakage to AXYN support immediately.
Related
- Get started (includes
preview-totalbefore order create) - Authentication
- Testing
- Headless API