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 partner dashboard.

Partner (Remote Service Provider)

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 disclosed through an API called the Partner API.

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

•  Customers
  The recipients of remote services. Also referred to as 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
  The customer creates a ticket when the customer wants to make a request for a remote diagnostic service.
•  Vehicles
  Vehicles describes a car that can be connected to the Jifeline network with a VCI.

The full documentation of the Partner API can be found here. openOBD sessions are part of this Partner API and can be programmatically listed or interrupted. The creation of openOBD sessions is done through its own openOBD endpoint (grpc.openobd.com). This endpoint uses a different technology called gRPC and is also used to control the active openOBD sessions.

Ticket

Remote diagnostic services can be requested by creating a ticket. A freshly created ticket will appear as a pending ticket in the Partner Portal of an RSS. For example, a ticket can be created to request initialization of trailer module software. This ticket can be handled by an operator that uses a physical diagnostic tool on the other end of the connection. But it is also possible to access the trailer module directly from software. Using the information retrieved from the ticket, an openOBD session can be created that gives access to the communication bus in the vehicle. Custom client software of the partner can connect through the openOBD session to the trailer module and run an initialization procedure. This way, skipping the use of a physical diagnostic tool. A brief overview of the ticket information is given in the following table.

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

For development purposes, an openOBD session can also be created without a ticket. This can be done on a J-ReX connector that is solely used for development. At the moment of session creation the J-ReX should not be used in a connection or ticket. 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!