Testing with Postman

Postman is a platform for building and using APIs. It’s what our own engineers use to test our APIs during the development process. To make it easy for your developers to integrate us, we’re sharing our Postman environments and Postman collection.

Find out more about Postman (opens in a new tab)

Collection

1. Download or copy the URL of our Postman collection

Download Volt Postman collection (.json)

Postman Collection URL

https://docs.volt.io/volt-io-postman_collection

2. Import the file, URL or raw text directly into Postman

Go to Postman > File > Import

Paste in the copied URL – or
Drag and drop the .json file you downloaded – or
Paste in the entire contents of the downloaded .json file and press ENTER to import it

Environments

In Postman, an environment is a set of one or more variables that you can reference when sending requests or writing test scripts. We have created separate environments for our sandbox and production servers to help you as you progress with your integration.

1. Copy the code for each environment

To setup each environment, simply copy the corresponding code below.

2. Import it into Postman using the raw text option

Go to Postman > File > Import
Paste in the text you copied and press ENTER to import the environment

Volt Sandbox
Volt Production

{
  "id":"66f5184f-1bb3-48c3-aab9-6e23c37f6107",
  "name":"Volt.io Sandbox",
  "values":[
    {
      "key":"api.url",
      "value":"https://api.sandbox.volt.io",
      "type":"default",
      "enabled":true
    },
    {
      "key":"api.url-verify",
      "value":"https://verify.sandbox.volt.io",
      "type":"default",
      "enabled":true
    },
    {
      "key":"api.client_id",
      "value":"-- Paste your client_id from Fuzebox --",
      "type":"default",
      "enabled":true
    },
    {
      "key":"api.client_secret",
      "value":"-- Paste your client_secret from Fuzebox --",
      "type":"secret",
      "enabled":true
    },
    {
      "key":"api.username",
      "value":"-- Paste your username from Fuzebox --",
      "type":"default",
      "enabled":true
    },
    {
      "key":"api.password",
      "value":"-- Paste your password from Fuzebox --",
      "type":"secret",
      "enabled":true
    },
    {
      "key":"sca.private_key",
      "value":"-- Paste your PRIVATE key incl. the begin and end tags --",
      "type":"secret",
      "enabled":true
    },
    {
      "key":"sca.public_kid",
      "value":"-- Paste your public kid from Fuzebox --",
      "type":"default",
      "enabled":true
    }
  ],
  "_postman_variable_scope":"environment",
  "_postman_exported_at":"2024-06-13T13:30:47.202Z",
  "_postman_exported_using":"Postman/11.2.0"
}

{
  "id":"ecf08e18-8784-4dad-9e3b-598fb67fe029",
  "name":"Volt.io Production",
  "values":[
    {
      "key":"api.url",
      "value":"https://api.volt.io",
      "type":"default",
      "enabled":true
    },
    {
      "key":"api.url-verify",
      "value":"https://verify.volt.io",
      "type":"default",
      "enabled":true
    },
    {
      "key":"api.client_id",
      "value":"-- Paste your client_id from Fuzebox --",
      "type":"default",
      "enabled":true
    },
    {
      "key":"api.client_secret",
      "value":"-- Paste your client_secret from Fuzebox --",
      "type":"secret",
      "enabled":true
    },
    {
      "key":"api.username",
      "value":"-- Paste your username from Fuzebox --",
      "type":"default",
      "enabled":true
    },
    {
      "key":"api.password",
      "value":"-- Paste your password from Fuzebox --",
      "type":"secret",
      "enabled":true
    }
  ],
  "_postman_variable_scope":"environment",
  "_postman_exported_at":"2023-06-10T17:18:08.178Z",
  "_postman_exported_using":"Postman/10.14.2"
}