The Signable API operates in two modes: test and live. Use test mode while developing your integration to explore the API without affecting real data in your account.
Ensure you have:
- Completed the Authentication guide
- Access to the Signable web app to create API keys
Test mode is a read-only simulation of the API.
| Request type | Behaviour in test mode |
|---|---|
| GET | Returns real data from your account |
| POST, PUT, DELETE | Returns a simulated success response without performing any changes |
This allows you to develop and validate your integration without creating, modifying, or deleting real data.
To generate a test API key:
- Follow the steps in Create your API key
- At step 3, toggle off the Production key switch
- Confirm the key type displays Test key
Use this key for all requests during development.
All responses made with a test key include a test field set to true.
The following example shows the response from DELETE template using a test key:
{
"http": 200,
"message": "Sample Contract has been removed from your template list.",
"template_id": "53890528",
"template_fingerprint": "e0b3a9cbd4a6ff2cb57cfca161a39309",
"template_title": "Sample Contract",
"test": true
}The test: true field indicates this was a simulated response. The template remains unchanged in your account.
- Authentication — Create API keys and authenticate requests
- Send your first envelope — Test your integration by sending an envelope