Partner API

The Partner API is a REST API with different endpoints which return JSON data regarding all sorts of resources that are related to the Jifeline dashboard.

Partner / RSS

A Jifeline Partner (or Remote Service Provider, RSS in short) has access to a Partner Dashboard that gives control over all incoming, ongoing and finished remote diagnostic services of that day. This information is also disclosed through an API called the Partner API.

The Partner API can be used to programmatically access resources including, but not limited to:

Customers

Customers are the recipients of remote services. Also referred to the Remote Service Receiver.

Connectors

A connector is a hardware device, VCI that enables you to communicate with a vehicle of the customer. A customer's connector is also known as a 'remote' or a J-ReX.

Products

Products describes the services that can be performed remotely.

Providers

Providers describe organisations that perform services on vehicles. Also refered as Remote Service Provider. You are one of these, but there are others available that could support you in your business.

Tickets

Tickets describe the requests to execute services on a vehicle for your customers.

Vehicles

Vehicles describes a car that can be connected to the Jifeline network with a VCI

Also, openOBD sessions are part of this Partner API and can be programmatically listed or even interrupted. Although this information is available through the Partner API, the creation and management of openOBD sessions is done through its own openOBD endpoint. This endpoint uses gRPC.

Ticket

Remote diagnostic services can be requested by creating a ticket. The newly created ticket will appear as a pending ticket in the Partner Portal of an RSS. It describes the request to execute services on vehicles. For example, a ticket can be created to initialize a trailer module after it has been installed by the car-mechanic. Using the information retrieved from the ticket, an openOBD session can be started. A brief overview of this information is given in the table below.

Attribute	Description
id	Ticket identifier (e.g: 2f500382-0f8e-4298-83ee-e205a6a419df).
created_at	Date and time of creation (e.g: 2019-08-24T14:15:22Z).
connection_id	Identifier of the connection (e.g: 135b8fec-515a-4a7f-9df7-63497bacd2d6).
state	This state provides information about current activity of the ticket. Can be one of:   prepared, pending, in_progress, outsourced, closed, cancelled.
ticket_number	Human-readable ticket number (e.g: 17386048).

Connectors

An openOBD session can also be started without a ticket, which would make it possible to handle Remote diagnostic services outside the Partner dashboard. This session would be started on a connector that is not yet in a connection and has no active ticket. The connector information can be retrieved via the Partner API. A brief overview of this information is given in the table below:

Attribute	Description
id	Connector identifier (e.g: c571e33b-6b12-455a-8388-0c025295564a).
customer_id	Optional customer identifier (e.g: 35e258c1-f707-43d8-acb9-c44c5d84b8db).
name	Numerical identifier/serial number (e.g: 23568).

Warning

Creating an openOBD session on a connector is not meant for production use!