Developer Journey
Last updated
Last updated
Before jumping in to code, we highly recommend you checking out the DIMO Developer Journey to determine how you should build your application:
Here, we outline the onboarding steps that developers may need to go through before building.
Download the DIMO Mobile App to see what owners of those 100k cars are experiencing - at least try to connect your car (might not be supported).
Join our Discord community for:
Access to 1st hand developer news (#built-on-dimo)
Interact with developer resource
Monthly Town Hall meetings
Read up on a few more resources:
Getting a Developer License is the first step to building your app using the DIMO API. With a Developer License, you are registered as a DIMO Developer and will be able to take advantage of the DIMO Permission layer model. A successfully minted Developer License will enable you to get the following API credentials:
Developer License clientId (0x Public key)
A self-defined domain
An enabled-signer privateKey (Private API key)
With the combination of these 3 credentials, you will be able to interact with the DIMO Auth Server to get an API access_token.
Before you start to build your app via Wallet-Based Authentication, you'll need to have DIMO-connected vehicles share permissions with you via the Developer License clientId - is acts as your developer identity in the DIMO App Store.
DIMO Check-in
For developers that wish to build an app using the Code Exchange Authentication, you are saving time by reusing the wallet integration and user management on DIMO, but do note that your application is locked in with a single logged-in user that is an existing DIMO user.
As of now, there are two ways for a vehicle to share permissions with a Developer:
Using the DIMO Mobile App
In the DIMO Mobile App, simply go to Vehicle settings > Permission sharing > + > Enter the ENS or 0x address of the Developer License > Select the permissions to share
Interacting with the DIMO Vehicle smart contract directly
DIMO provides a setPrivileges function on the vehicle contract that takes in an array of tuples which invokes a series of setPrivilege function calls grouped in a single transaction. Note that this method will require a wallet integration on your application.
An example of the input would be:
Requesting privileges sharing for a vehicle with a tokenId of 9527
Requesting privileges 1 through 4
Privileges will be granted to 0xA Developer License address
Permission expires on 1713510000 (unix timestamp in seconds)
Once you have the vehicle permissions, you have gained the access to interact with the Token Exchange API to obtain privilege tokens for DIMO-connected vehicles.
Telemetry provides all the sensor signals returned by the DIMO-connected vehicles. The GraphQL implementation provides developers with self-defined queries to avoid over-fetching, aliases to simplify data formatting, and the ability to decouple queries for different signals.
Developer Notes
An example of Telemetry usage would be an app that displays different sensor data. While speed might be something that you wish to display at a higher frequency (refreshes every 10 seconds), powertrainTransmissionTravelledDistance (odometer) reading can be displayed at a lower frequency (refreshes every 6 hours). By using query aliases, you can easily define powertrainTransmissionTravelledDistance as odometer so the API returns the data in the parameter name of your choice.
These benefits of the API allows you to set up different querying cadences and aliases to save you time and resources. Check out Vehicle Usage Report for an implementation of the Telemetry API.
Trips is an abstraction determined by the DIMO Protocol based on the vehicle's driving data. It establishes a trip from start to end, which is recorded with location data (lat, lng).
Developer Notes
Check out Trips Sandbox for an implementation of the Trips API.
For VIN and other vehicle credentials, check out the Attestation API.
For Streamr, check out the DIMO Streamr integration.
