Skip to content

Environments ​

Nimobase runs in two environments: Production and Sandbox. You don't pick a host or configure a URL: the environment is a single option on the SDK client.

Production and Sandbox ​

EnvironmentWhat it's for
ProductionThe real environment: your company's data, the one your team uses every day.
SandboxYour test bench: break things without affecting anyone, on separate data.

Whatever happens in Sandbox stays in Sandbox. The two environments' data is completely separated, so a failed test never touches your real information.

How you choose the environment ​

In the SDK the option is sandbox: set it to true and you're on Sandbox; leave it out and you're on Production.

ts
// Production — the default
const client = Nimobase({ secretKey: process.env.NIMOBASE_SECRET_KEY });

// Sandbox
const tests = Nimobase({
  secretKey: process.env.NIMOBASE_SECRET_KEY,
  sandbox: true,
});

There is no URL to configure by hand: the client resolves the destination of whichever environment you chose. The contract version is its own option — version (for example version: 'v1') — and if you leave it out you get the latest published one.

What does NOT change between environments ​

Endpoints, permissions and keys behave the same in both environments: same route, same behavior, same roles. The only thing that changes is where the data goes. An integration that works in Sandbox works in Production without writing a different line.

When to move to production ​

  1. Run your full flow through Sandbox end to end — not just the happy path: also the errors your integration has to handle.
  2. Check your plan's limits in Billing before moving real traffic.
  3. Only then flip the option: remove sandbox: true and your client points at Production.

Keys are created and managed by an OWNER or ADMIN of your company in API Keys.