Append your redirect URI

Smartcar will provide a URL with the following parameters from the GET /battery/nominal_capacity endpoint:

https://connect.smartcar.com/battery-capacity
?vehicle_id=36ab27d0-fd9d-4455-823a-ce30af709ffc
&client_id=8229df9f-91a0-4ff0-a1ae-a1f38ee24d07
&token=90abecb6-e7ab-4b85-864a-e1c8bf67f2ad
&response_type=vehicle_id
&redirect_uri=
vehicle_id
string
required

The Smartcar vehicle Id.

client_id
string
required

The client_id from the Smartcar Dashboard for your application.

token
string
required

A token to validate the URL was provided from a battery capacity response for your application. The token is valid for 30 days. If a token is no longer valid, the user will be directed to re-auth prior to selecting their capacity.

response_type
string
required

Must be set to vehicle_id.

redirect_uri
string
required

The URI you would like the response sent to after a user exits the flow.

NOTE: this is the only parameter that will not be prepopulated as part of the API response. You must append it in order to launch the flow succesfully and receive confirmation the user has exited the flow.

Response

Success

After the user selects a capacity and hits “Back to Application”, Smartcar will send the following to your redirect URI:

Success
https://example.com/home
?vehicle_id=36ab27d0-fd9d-4455-823a-ce30af709ffc
&selected_capcity=80.9
&reason=battery_capacity

Upon receving a success Smartcar will return selected_capcity as a parameter or you can hit the GET v2.1/battery/capacity endpoint to view the selection in the capacity.nominal field.

Error

If a user selects “I don’t know the battery capacity”, Smartcar will send the following to your redirect URI:

Error
https://example.com/home
?error=battery_capacity_no_selection
&error_description=user did not know battery capacity
&vehicle_id=36ab27d0-fd9d-4455-823a-ce30af709ffc

Flow Example

User selected battery capacity flow

Was this page helpful?