Skip to content

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 Remove 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
  • Connectors
  • Products
  • Providers
  • Tickets (pending, in progress, outsourced, closed, etc.)
  • Vehicles

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

A Jifeline Partner can request a remote diagnostic service by creating a ticket. 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. An openOBD session can be started using the information retrieved from a ticket. A brief overview of this information is shown in the table below.

Attribute Description
id Ticket identifier (e.g: 2f500382-0f8e-4298-83ee-e205a6a419df).
created_at Date and time of created (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).