Introduction
The sandbox environment serves as a secure, isolated testing ground that mimics your production environment. It allows you to simulate interactions with automotive OEMs, energy device manufacturers, and other entities without affecting live data.Base URL
The base URL for the sandbox environment is https://api.sandbox.volteras.com.Key Features
- Isolated testing: the sandbox is entirely separate from the production environment, ensuring that your tests won’t interfere with live data.
- Consent flow: to populate the vehicle list in the sandbox, you’ll need to connect a vehicle via a consent flow.
- Flexible credentials: any credentials are accepted in the Consent Flow within the sandbox environment.
- Sample data: upon completing the Consent Flow, sample vehicles are generated. You can then interact with these vehicles, such as listing them via GET requests or retrieving telemetry data.
Quick guide
1
Generate sandbox application
First, navigate to our Volteras Portal and create a new application specifically for the sandbox environment to obtain your
client_id and client_secret.2
Retrieve token
Utilize the
client_id and client_secret generated for the sandbox to obtain an access token. We adhere to the OAuth 2.0 authorization standard.3
Test token
Validate the access token by making a request to the test endpoint:
https://api.sandbox.volteras.com/v1/oauth2/test-token. Include the token in the HTTP header as Bearer <access-token>.4
Initiate consent flow
Generate a new consent flow via the consent flow endpoint. Any credentials are valid to complete the flow and connect a mocked device in sandbox.
5
Perform API calls
After generating sample vehicles, you can initiate API requests to interact with them, such as listing them or retrieving telemetry data.
Next Steps
- Familiarize yourself with the API Reference for available endpoints in the sandbox environment.
- Review tutorials for complex scenarios and use-cases.