Guided Onboarding enables your users to onboard their device themselves through a web-based UI. Allowing us to interact directly with your users, greatly minimising the integration effort.

Without Guided Onboarding, the process may be slightly different depending on the type of Entity you are trying to onboard. This presents additional challenges when implementing the process within your own app.

⚠ Limited Availability Currently, Guided Onboarding is only publicly available for Entities of type EV, of certain manufacturers.

​
What is a Guided Onboarding Session?

Instead of creating an Onboarding Request directly, you can create a Guided Onboarding Session. One session can be used to onboard exactly one device.

Each session can be accessed through a unique URL containing a secure access code. You can share it with your users directly, or redirect them to it from your own application.

​
Creating a session

To create Guided Onboarding Sessions, we’re using the Post /guided-onboarding endpoint.

​
Parameters

companyNamerequired

Used to display your company name within the Guided Onboarding interface.

tenantIdrequired (defaults to the requester’s Tenant)

Entities always have to be linked with a Tenant (organisation). In case you’ve not specified a Tenant ID, we’ll attempt to determine the Tenant based on the user or client making the request. If we can’t, and no Tenant ID has been provided, the request will fail.

collectiveIdoptional

If set, the Entity will become part of the specified collective after it has been created.

Pre-specify the Vehicle Manufacturer & VIN

In case you already know the VIN and manufacturer of the vehicle you want to onboard, you can pre-specify them. Your user won’t be able to modify these.

vinoptional (required in combination with “Manufacturer”)

Vehicle Identification Numbers are used to identify vehicles across all brands.

manufactureroptional (required in combination with “VIN”)

Used to specify the manufacturer (for example: “Audi”) of the vehicle you want to connect with.

Access the full list of available parameters through the API References.

​
Example Request

Creating a Guided Onboarding Session can be as simple as specifying your companyName.

curl --request POST \
     --url https://platform.realto.io/api/v1/guided-onboarding \
     # Headers Omitted
     --data '
{
  "companyName": "re.alto energy"
}
'

​
Example Response

{
  "id": "3fa85f64-5717-4562-[...]",
  "url": "https://go.realto.io/[...]"
}

Was this page helpful?