Onboarding Devices

Ignite Signals provides a simple workflow for integration of end-user devices into our service. This process involes several steps. For example a vehicle onboarding may look like this:

• Confirm compatibility of vehicle using vehicle compatibility API
• Authentication with Device OEM services e.g. login to Tesla portal
• Performing neccesary approvals in vehicle to allow access to vehicle from Ignite Signals
• Collection of neccesary consent from end-user to collect data from device
• Communication with Device OEM APIs to scrape data from device at regular intervals

Our provided component libraries allow your teams to perform the steps listed above by simply rendering our VehicleOnboarding component in this case.

Check Compatibility

The first step in onboarding of a device is to confirm that Ignite Signals and your organisation supports the device. We provide a compatbility endpoint for each type of device supported.

When querying for compatibility using these endpoints you will recieve confirmation of support (or not) along with other information that may be useful to display to users or filter vehicles which you wish to support.

For example, our Vehicle Compatibility check endpoint also confirms if this vehicle requires in vehicle consent and retention periods for data from the OEM APIs.

You will need to retain the device_type_id returned here as this will be used to initiate onboarding later.

Onboarding

To initiate the onboarding workflow you first need to retrieve a workflow_token from our Device Registration endpoint, using the device_type_id retrieved earlier.

Once you have retrieved a workflow_token you can render the relevant onboarding component to walk your users through onboarding to Ignite Signals.

For example using the MultiOnboarding component:

<SignalsOnboarding
  :workflow-tokens="[
    'your_workflow_token_1',
    'your_workflow_token_2'
  ]"
  organisation-name="SkyNet"
  organisation-logo="/some-skynet/logo.png"
  @complete="onOnboardingComplete"
  @error="onOnboardingError"
/>

Check Data

Upon completion of the onboarding process you can confirm data is being recieved from the device. Some devices may take some time for data to be collected as OEM APIs take some time for access to data to be approved.