Devices Endpoints
Last updated
Last updated
https://devices-api.dimo.zone
Developer Notes
To access the vehicle commands, a token exchange transaction is required to obtain a vehicle JWT to get permission to access the vehicle's commands. Please check prior to using this endpoint.
POST /v1/vehicle/{tokenId}/commands/doors/lock
Sends a vehicle command to lock the doors.
Sends a vehicle command to unlock the doors.
Sends a vehicle command to open the frunk.
Sends a vehicle command to open the trunk.
Retrieves a list of error code queries made for the vehicle identified by the user device ID.
Submits a list of error codes for the vehicle identified by the user device ID. This submission will actively store the error codes provided for the vehicle while returning the full descriptions for evaluation.
Use application/json for raw body parameters.
Submits a clearing signal to DIMO, indicating that the most recently error codes submitted for the vehicle has been cleared.
POST /v1/vehicle/{tokenId}/commands/doors/unlock
POST /v1/vehicle/{tokenId}/commands/frunk/open
POST /v1/vehicle/{tokenId}/commands/trunk/open
The following endpoints defers back to using the Web3 access token given that API users are interacting with user devices under their personal possession. No additional permission is needed.
Vehicle error codes are not actively synced with the DIMO Network, hence a submission of error codes is required to store error code history. This is also a function seen in the DIMO Mobile App:
GET /v1/user/devices/{userDeviceId}/error-codes
POST /v1/user/devices/{userDeviceId}/error-codes
POST /v1/user/devices/{userDeviceId}/error-codes/clear
tokenId*
String
Vehicle token ID, this is the token ID of your vehicle NFT. A prerequisite is to obtain a token that is permitted to access trips data for this specific vehicle.
Authorization*
String
Vehicle JWT in Bearer Authentication format.
tokenId*
String
Vehicle token ID, this is the token ID of your vehicle NFT. A prerequisite is to obtain a token that is permitted to access trips data for this specific vehicle.
Authorization*
String
Vehicle JWT in Bearer Authentication format.
tokenId*
String
Vehicle token ID, this is the token ID of your vehicle NFT. A prerequisite is to obtain a token that is permitted to access trips data for this specific vehicle.
Authorization*
String
Vehicle JWT in Bearer Authentication format.
userDeviceId*
String
For userDeviceId, please refer to the User Device entity under Devices API.
Authorization*
String
Bearer authentication using the access_token generated from the authentication step.
userDeviceId*
String
For userDeviceId, please refer to the User Device entity under Devices API.
Authorization*
String
Bearer authentication using the access_token generated from the authentication step.
queryDeviceErrorCodes*
Object
{ "errorCodes": [ "P0106", "P0279" ] }
userDeviceId*
String
For userDeviceId, please refer to the User Device entity under Devices API.
Authorization*
String
Bearer authentication using the access_token generated from the authentication step.
tokenId*
String
Vehicle token ID, this is the token ID of your vehicle NFT. A prerequisite is to obtain a token that is permitted to access trips data for this specific vehicle.
Authorization*
String
Vehicle JWT in Bearer Authentication format.