Skip to main content

Sandbox

Zentake provides a sandbox environment for testing your integration without touching production data. It's a fully separate copy of the API, same endpoints, same request/response shapes, with its own credentials, its own data, and lower limits.

Isolation

Sandbox data is completely separate from production. Patients, forms, packets, and responses you create in sandbox never appear in production, and vice versa.

Getting sandbox credentials

  1. Navigate to Settings > API Credentials in your Zentake dashboard.
  2. Toggle to the Sandbox environment.
  3. Copy the sandbox X-API-KEY and X-API-SECRET.
  4. Use these credentials for testing, the sandbox X-API-KEY is different from your production X-API-KEY, so mixing them up fails authentication rather than silently hitting the wrong environment.

See Authentication for the header names and a working curl example.

What's different in sandbox

  • Messages are still real. SMS and email sends in sandbox are actually sent, so you can test the patient-facing flow end to end, just within the sandbox's daily message caps (below).
  • Data caps. Sandbox limits you to a maximum of 100 patients and 20 forms, so it's meant for integration testing, not load testing or bulk data migration rehearsals.
  • Rate and usage limits are fixed and lower than production. See the table below, or the full Rate limits page.
LimitSandbox
Requests60/minute, 500/day
SMS5/day
Emails10/day
Patients100 max
Forms20 max

Identifying which environment you're in

Every API response includes a header identifying the environment it was served from:

X-Zentake-Environment: sandbox | production

This is useful as a runtime assertion in your integration, e.g., failing loudly if a job that's supposed to run against sandbox ever sees X-Zentake-Environment: production. See Environments for the full sandbox vs. production comparison.