Every Edpire org comes with a sandbox environment — a fully isolated instance of the API pre-loaded with sample data. Build and debug your integration without risk to production learner records.
How it works
Sandbox and production share the same API surface. The only difference is the API key prefix:
| Key prefix | Environment | Database |
|---|
edp_live_... | Production | Your org’s live data |
edp_test_... | Sandbox | Isolated, pre-seeded test data |
Get a sandbox key
- Go to app.edpire.com → Settings → Sandbox
- Click Create sandbox key
- Name it and select the scopes you need
- Copy the key — shown once, just like production keys
You can have up to 3 sandbox keys per org. Use separate keys for different environments (local dev, CI, staging).
Pre-seeded sample data
Your sandbox is pre-populated the first time you create a sandbox key:
| Resource | Details |
|---|
| 2 sample assessments | One multiple-choice quiz, one open-response exercise — both published with share codes |
| 1 sample collection | Contains both assessments, in order |
| 3 sample submissions | For learner_ref: "test-learner-1", across both assessments with varied scores |
curl https://app.edpire.com/api/v1/learners/test-learner-1/results \
-H "Authorization: Bearer edp_test_<your-sandbox-key>"
Webhook echo viewer
Sandbox webhook events are automatically captured in a built-in echo viewer — no need to run a local receiver during development.
- Go to Settings → Sandbox → Events
- Make any API call with your sandbox key that triggers an event (e.g., submit an assessment)
- The event appears in the viewer with full payload
You can also register your own webhook endpoint (e.g. via ngrok) against sandbox keys — the echo viewer and your endpoint both receive the same events.
Reset sandbox data
If your sandbox gets messy, reset it to a clean state:
- Go to Settings → Sandbox → Reset data
- Click Reset — all sandbox submissions are wiped and the seeder re-runs
# Or via API (requires write:assessments scope on a sandbox key)
POST https://app.edpire.com/api/v1/sandbox/reset
Authorization: Bearer edp_test_<your-key>
Reset only affects sandbox data. Production data is completely unaffected.
Differences from production
| Feature | Sandbox | Production |
|---|
| Data isolation | Fully isolated DB | Live data |
| Rate limits | More relaxed | 100 req/min |
| Webhook echo | Always on (dashboard viewer) | Register your own endpoint |
| Pre-seeded data | 2 assessments, 3 submissions | Your real content |
| Data reset | On demand | Not available |
Example: switch environments
const client = new EdpireClient({
// Switch between sandbox and production by changing the key only
apiKey: process.env.NODE_ENV === "production"
? process.env.EDPIRE_API_KEY // edp_live_...
: process.env.EDPIRE_API_KEY_TEST, // edp_test_...
})
