Sandbox Environment
What it does
Test POTAL API integrations in a sandbox environment without affecting production data or consuming your API quota. Sandbox mode returns realistic mock responses for all endpoints, allowing full integration testing.
How to use it
Enable sandbox mode
Create a test API key (sk_test_ prefix) from Dashboard > API Keys > Create Test Key.
Use test endpoints
All endpoints work the same way — the test key triggers sandbox mode automatically.
Test error handling
Use special test values to trigger specific error responses (e.g., price=0 for validation error).
Switch to production
Replace your test key with a live key (sk_live_) when ready to go live.
Related Features
Secure API key authentication with scope-based permissions
155+ API endpoints with consistent JSON responses
Interactive API docs with code examples in 5 languages
Guided setup wizard for new users with API key generation
Structured error responses with codes, messages, and doc links