Skip to content
Last updated

Testing the Signable API

The Signable API can run in two modes: test and live.

Use test mode while developing your integration so you can safely explore the API without affecting real data in your account.

How test mode works

Test mode is a read-only version of the API.

  • GET requests behave the same in both modes and return real data.
  • POST, PUT and DELETE requests do not perform any actual changes in test mode.
    Instead, they return a simulated response as if the action had succeeded in live mode.

This lets you develop and validate your integration end-to-end without worrying about creating, modifying, or deleting real information.

Create a test key

To generate a test API key, follow the same steps described in Create your API key.

  • When you reach Step 3, toggle off the “Production key” switch.
  • This will switch the key type and you’ll see “Test key” displayed instead.

Use this key whenever you want to interact with the API in test mode.

Identifying test mode requests

All responses made in test mode include a test field set to true.

For example, here’s the response received when calling DELETE template, with a test API key:

{
  "http": 200,
  "message": "Sample Contract has been removed from your template list.",
  "template_id": "53890528",
  "tempate_fingerprint": "e0b3a9cbd4a6ff2cb57cfca161a39309",
  "tempate_title": "Sample Contract",
  "test": true
}

This template will still be present in the account.

Previous page
Next page