Skip to main content

Sandboxes and test keys

A sandbox is an organisation of its own, kept apart from yours, for building and testing an integration. Partners, resellers and customers can have sandboxes; an organisation keeps at most three at once.

Keys and where they reach​

KeyPrefixBelongs toReaches
Test keyzk_test_one of your sandboxesthat sandbox only
Live keyzk_live_your organisationyour organisation only, never a sandbox

Developer Studio refuses a test key without a sandbox and a live key with one, and the gateway checks the same rule each time it resolves a key. A request with a test key reads and writes the sandbox's data, never yours.

What a sandbox holds​

A new sandbox is empty: no vehicles, drivers or devices. Create what you need through the API with a test key. A sandbox has no members, so nobody signs in to it; only its test keys reach it. It is not listed anywhere else in ZAITRACK.

Reset and delete​

Both are in Developer Studio and both ask first.

  • Reset replaces the sandbox with a new, empty one under a new id. The sandbox's working test keys move to it. The old data is no longer reachable from any key; it is not erased.
  • Delete ends the sandbox and revokes its keys.

Going live​

Create a live key (zk_live_…) in Developer Studio and swap it in. The operations, scopes and limits are the same; only the organisation the key reaches changes. Rate limits count per organisation, so a sandbox's traffic does not use your organisation's limits.