loading

Introducing the Voltayze REST API: Seamlessly Integrate EV Analytics into Your Applications

At Voltayze, we understand the importance of accessing detailed, real-time data to gain deeper insights into your electric vehicle’s performance and behavior. That’s why we’re excited to introduce the Voltayze REST API, a powerful tool to integrate EV analytics directly into your applications, dashboards, or backend systems.

What Is the Voltayze REST API

The Voltayze REST API allows developers to retrieve detailed telemetry data about their electric vehicles. Whether you’re building a custom application or analyzing your fleet’s performance, our API makes it easy to fetch and process data. The API provides data in JSON format, making it compatible with a wide range of programming languages and platforms.

Example Response

When you call the API, the result will be returned in a JSON structure like the one below:

json
{
"vin": "XP7YGCEK9PB088547",
"odometer": 25187.635412526,
"rated_range": 142.74999680929,
"battery_level": 47.91378833932,
"address": "44.485103_26.098978",
"display_name": "Canada, 21 Road Street",
"state": "offline",
"start_date": "2024-12-16T12:22:52.588678",
"end_date": null
}

Here’s a quick breakdown of the fields:

  • vin: The unique Vehicle Identification Number for your car.
  • odometer: The total distance covered by the vehicle, in kilometers.
  • rated_range: The estimated range of the vehicle based on battery efficiency.
  • battery_level: The current state of charge, expressed as a percentage.
  • address: The coordinates of the vehicle’s last recorded location.
  • display_name: A human-readable address for the vehicle’s location.
  • state: The current state of the vehicle (e.g., onlineoffline, or charging).
  • start_date: The timestamp when the session started.
  • end_date: The timestamp when the session ended (or null if ongoing).

How to Get Started

 

1. Subscribe to the Voltayze REST API Service

To use the API, you’ll need to subscribe through the Voltayze Dashboard. Once you enable API access, you will be able to see the integration details in your Dashboard:

  • Username (user-name)
  • API Key (api-key)

Both of these credentials are unique to you and must be included in your API requests.

2. Authenticating Requests

Each API request must include the following parameters:

  • user-name: Your registered username on Voltayze.
  • api-key: The unique API key provided during subscription.

For added security, always keep your api_key confidential and avoid sharing it. You can change your key anytime from your Dashboard by redoing the REST API integration.

3. Making a Request

To fetch vehicle data, send a GET request to the Voltayze REST API endpoint:

Endpoint:
The endpoint is visible in your Voltayze Dashboard.

Request Example (using curl):

   $ch = curl_init();
    // Set cURL options for GET request
    curl_setopt($ch, CURLOPT_URL, $apiUrl); // Set the API URL
    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); // Return the response as a string
    curl_setopt($ch, CURLOPT_HTTPHEADER, [
        “user-name: $userName, // Add user-name header
        “api-key: $apiKey, // Add api-key header
    ]);
  // Execute the cURL request
  $response = curl_exec($ch);
 

4. Handling the Response

The API will return the vehicle data in JSON format, as shown earlier. You can then parse this data in your application to display or analyze it further.

Integration Use Cases

The Voltayze REST API can be used in several scenarios, including:

  • Fleet Management: Monitor and manage a fleet of EVs with real-time telemetry data.
  • Custom Dashboards: Build personalized dashboards for tracking battery levels, vehicle locations, or trip data.
  • Data Analytics: Perform in-depth analysis of your vehicle’s efficiency and performance over time.
  • Mobile Applications: Integrate vehicle telemetry into mobile apps for on-the-go insights.

Why Choose Voltayze

  • Secure Access: Each user has a unique API key to ensure secure communication.
  • Detailed Insights: Get comprehensive, real-time data about your EV’s performance and location.
  • Easy Integration: JSON-based responses make it simple to work with our API in any modern programming language.

Start Using the Voltayze REST API Today!

If you’re ready to take your EV analytics to the next level, subscribe to the Voltayze REST API through your dashboard and unlock unparalleled access to your vehicle’s data. For any questions or assistance, our team is here to help you every step of the way.

Let Voltayze power your EV insights! 🚗⚡

Write a Reply or Comment

Your email address will not be published. Required fields are marked *