Dashboard vs API
Dashboard vs API
Clearway exposes multiple surfaces. Use the right host and credential for each job.
Decision table
| Surface | Host | Credential | Use when |
|---|---|---|---|
| Merchant HTTP API | {docsEnv.apiHost} | clwy_* API key | Server integrations, automation, CRM sync |
| Dashboard UI | {docsEnv.dashboardUrl} | Clerk session | Human operators, configuration, key management |
| API Sandbox Arena | Dashboard session → GCF | Clerk session (not API key on api-*) | Interactive raw-call testing inside the dashboard |
| Widget checkout | Your server proxy → {docsEnv.apiHost} | API key in server env only | Browser checkout — key never in the browser |
| Payer checkout pages | {docsEnv.paySiteUrl} | Stripe session (payer) | End customer pays — not for merchant API keys |
Merchant HTTP API (api-*)
New integrations call:
Code
Authenticate with Authorization: Bearer {docsEnv.keyPrefixExample} or x-clearway-api-key.
Do not call legacy gcf-* hosts for new merchant integrations. The platform is migrating merchant traffic to api-* with edge allowlists.
Dashboard-only operations
Some operations appear in the API Reference with x-clearway-status: dashboard-only. They are documented for completeness but return 403 when called with an API key on {docsEnv.apiHost}.
Examples include advanced analytics entitlement probes and reserved operator scopes. Use the dashboard UI or session-backed routes for those workflows.
API Sandbox Arena vs merchant API
| Arena (dashboard) | Merchant API (api-*) | |
|---|---|---|
| Auth | Signed-in dashboard user | API key |
| Purpose | Try catalog operations interactively | Production integrations |
| Rate limits | Arena execute bucket (20/min) | 60 requests / 60 seconds per operation — see Rate limits |
Widget proxy (required for browser checkout)
The payment widget never calls {docsEnv.apiHost} from the shopper's browser. Your server holds the API key and forwards requests. See Checkout integration.
Next steps
- Getting started — first
api-*call - Checkout integration — widget + proxy
- Merchant getting started — dashboard-first flows