Setting up your Sandbox Account & API Keys
This guide covers how to create sandbox accounts, switch into them, and get API keys for development.
Sandbox account types
Hint supports two sandbox account types:
| Account type | What it is for | Contains Patient Data |
|---|---|---|
| Partner sandbox | High-level integration settings like webhook configuration, and API key management | No |
| Practice sandbox | Workflow testing from the provider perspective (patients, memberships, charges, and related operations) | Test data only, no live PHI |
Create your sandbox accounts
Hint creates a partner sandbox and one practice sandbox when API Access is enabled, so you start with a working pair.
To add more, go to Admin > Developers > Sandboxes in your live practice:
- Click Add Sandbox Practice
- Click Switch next to any sandbox to administer that specific sandbox account
Most teams only need the partner sandbox and practice sandbox they already have.
When to create multiple practice sandboxes
Create multiple practice sandboxes only if you need to model multiple live practices. Otherwise, a single practice sandbox is usually enough for development and QA.
Team access behavior
When you add a user to your partner account team, that user is automatically added to all sandbox accounts:
- Partner sandboxes
- Practice sandboxes
This gives developers access to the environments they need without granting live practice access by default.
Get your first API keys
Manage every key from your live practice. Go to Admin > Developers > API Keys. The page lists your live API keys and your sandbox API keys in separate panels.
To get API keys for testing:
- Go to Admin > Developers > API Keys
- Find the sandbox panel
- Click New API Key, then copy the key you will use for sandbox calls
Live API keys stay locked until your practice signs the API Access Agreement. See Getting Sandbox and API Access.
Use the sandbox API base URL:
https://api.sandbox.hint.com
After you have your key, continue with Making Requests.
Updated 1 day ago