The API is included in the plan. The account owner creates keys in the developer settings. For a test account, email hello@storebay.co.uk.

Developers

Sandbox

A separate test account with identical isolation and events, set up by StoreBay on request.

Note

A test account behaves like a live one: same isolation, same events. It is a separate operator with its own data and its own keys.

A test account is part of the plan, and there is no parallel schema: a test operator is modelled as operators.environment = 'test', with identical row-level-security isolation to a live one. StoreBay sets a test account up for you on request: email hello@storebay.co.uk. This page covers the sandbox model: what a test account is and how environments bind to your credentials.

The environment model

EnvironmentCredentialBacking
Livesb_live_…operators.environment = 'live'
Test (sandbox)sb_test_…operators.environment = 'test'
  • The switch is the credential — a sb_test_… key resolves to the test operator, a sb_live_… key resolves to live. The base URL never changes: https://api.storebay.co.uk/v1.
  • Test webhook endpoints and test API keys are managed exactly like their live counterparts.
  • A key's prefix must agree with its own environment (a sb_test_…-prefixed credential can never resolve to a live operator, or vice versa) — the resolver refuses the mismatch outright, so a copy-paste error fails closed, not open.

Managing your sandbox

  • StoreBay sets up a test account for you on request: email hello@storebay.co.uk. It comes with its own API keys.
  • Test webhook endpoints: register them as described in Webhooks, against a sb_test_…-owned endpoint.

On this page