Introduction
When building an integration on top of the Volteras platform, you may only want specific information, or capabilities from the end-user account that will be connected. You can achieve this using thescopes parameter when constructing the account
connect url.
Vehicle Scopes
Scopes available
| Scope | Description |
|---|---|
| vehicle:all | Access to everything |
| vehicle:information | Access to vehicle specifications, options, vin and registration plate |
| vehicle:charging_history | Access to vehicle charging history |
| vehicle:telemetry | Access to location and odometer |
| vehicle:commands | Access to remote commands |
Scoped endpoints
These are vehicle endpoints where scopes are used to determine whether you have access to data, or whether you can perform a remote action.| Endpoint | Scopes available | Required | Effect when scope is not present |
|---|---|---|---|
| /vehicles/[id] | vehicle:information | These fields are excluded: vin, registrationPlate | |
| /vehicles/ | vehicle:information | These fields are excluded: vin, registrationPlate | |
| /vehicles/[id]/options | vehicle:information | Yes | 401 Response |
| /vehicles/[id]/specifications | vehicle:information | Yes | 401 Response |
| /vehicles/[id]/telemetry | vehicle:telemetry | Yes | 401 Response |
| /vehicles/[id]/charging-history | vehicle:charging_history | Yes | 401 Response |
| /vehicles/[id]/charging-history/[id] | vehicle:charging_history | Yes | 401 Response |
| /vehicles/[id]/command-executions/ | vehicle:commands | Yes | 401 Response |