1. Welcome
  2. Quick Start

Make sure you have gone through brief introduction to the Connect UI and Unified APIs before this section.

🎬 Virtual Onboarding

🔧 Sandbox Access

Get your developer keys and start using sandbox mode

In case you don’t already have your app-id and secret, reach out to us on mail to get one issued. You’ll need to include these credentials with all API calls.

Here’s a sample of how app-id and secret will look like:

{
  "app-id": "40a67cba-545f-495e-bade-73df342a80cd",
  "secret": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiI0MGE2N2NiYS01NDVmLTQ5NWUtYmFkZS03M2RmMzQyYTgwY2QiLCJpYXQiOjE1MTYyMzkwMjJ9.zyNHt_rNlcN0NlCkvTYHH0RYKaBn9I9lpFeYc85HXA0"
}

Once you have the API keys with you, you can start using the APIs in sandbox mode right away, no action is needed from your side.

Sandbox mode will allow you to connect real vehicles, and use our APIs to get their data to test out the end-to-end flow.

To use the sandbox mode, use the following link to connect a vehicle:

https://us.telematica.so/connect?
  app=<app_id>&
  user=<foo_bar>&
  region=<US,EU or IN>

For more information on the above URL, see Consent UI and custom query parameters

When you are ready to take Telematica APIs to production, move on to step 2 below ↓


📱 Production access (<10 mins)

Create a POST callback endpoint in your backend

When a user connects a vehicle to your application, Telematica will send vehicle-id of authorized vehicles(s) through a POST webhook call to your backend. You can store these vehicleIds’ in your database and pair them with users in your app.

This guide will walk you through all the steps required from your end to make a callback endpoint:

More about user consent

User data is accessible for your app via Telematica’s EV APIs only after explicit permission grant by user in form of OEM app credentials. This is a one-time process from user’s end, and they are entitled to opt out of data-sharing agreement as per their wish.

Embed a web-view in your mobile app, pointing at the following URL:

https://us.telematica.so/connect?
  app=<app_id>&
  user=<user_id_in_your_db>&
  region=<region>

where region is one of US, EU or IN.

You can customize the page for each instance using supported query parameters found in the following page:

Consent UI Guide

Consent UI enable your users to securely provide consent to their EV data to you. You can use the following information to build a customized url and redirect your customer to it.

Skipping pages

This flow is fully customizable as per your app’s requirements. You can also choose to skip directly to the OEM login screen if

  1. You know the brand of vehicle beforehand and
  2. You have already taken user’s consent in your own app (includes accepting Telematica’s privacy policy)

Access vehicle data through our Vehicle APIs

Once the user has granted consent for your app to access their vehicle data, you can use Vehicle Data APIs to fetch vehicle data from your backend.