API Console

Try the Connectivity Management API

There are four ways to work with the Connectivity Management API:

  1. Try the API Console with simulator data: Use the simulator credentials shown below with the “Try it out!” buttons on this page to get a feel for the API requests and responses. Click here to sign up for a free ThingSpace account and try our your test token.
  2. Try the API Console with your own data: If you already have a Verizon business account or test account with UWS credentials, use those credentials to login from this page and then try the requests and responses with real devices in your account.
  3. Build and test your application with simulator data: Use the simulator credentials shown below to work with a test account while building and testing your own application.
  4. Run your application with your own data: To work with your real account data, your application must obtain ThingSpace tokens for authorization and login with valid UWS credentials for authentication.

This table lists the credentials that you’ll need to use the simulator or your own account, either in the API Console or in your application.

Credential Use the Simulator Use Your Own Account
API Token API Console: Sign in, and then go to Key Management in your Account Settings. Copy the My Test Token value to the clipboard, and then paste it into the Authorization: Bearer field below.
In Your App: The test token does not expire, so it’s easy to use while developing your app.
API Console: Sign in, and then go to Key Management in your Account Settings. Refresh the Token and the copy it to the clipboard. Return to the API Console page and paste it into the Authorization: Bearer field below.
In Your App: Follow the instructions for Obtaining a ThingSpace Token Programmatically.
NOTE: API Tokens are valid for one hour.
VZ-M2M-Token Use any value. Send a POST /session/login request and use the sessionToken value from the response body.
NOTE: Session Tokens expire if they are not used for 20 minutes.
username and password for POST /session/login Use any values. Use the UWS credentials for your Verizon account.
account name TestAccount-1
(Use TestAccount-2 with POST /callbacks/{accountname} requests)
Use the name of your Verizon business account. Account names are usually numeric, and must include any leading zeroes.

Where to Start

Here is a suggested sequence of API requests to get you started:

  1. Paste a vaild API token into the Authorization: Bearer field below. Use the test token to run requests against simulated account data, or a token from your Key Management page to run requests against your Verizon account.
  2. Use POST /session/login to start a new session and get a sessionToken that you’ll use as the VZ-M2M-Token value in all other requests
    Note: This isn’t required when using the simulator, but it’s good practice. You can use any value for the VZ-M2M-Token when using the simulator.
  3. Get a list of devices in your account: POST /devices/actions/list
  4. Activate a device (if you have one ready): POST /devices/actions/activate
  5. Suspend service for an active device: POST /devices/actions/suspend
  6. Restore service for the device: POST /devices/actions/restore
  7. Any other requests that you want to try.
  8. End the session: POST /session/logout
Try It Out!