Powered by Redocly

Jifeline Customer Portal API (0.1)

Download OpenAPI specification:Download

This API offers a way to interact with Customer resources like retrieving connectors, selecting vehicles and creating tickets.

Connectors

Connectors are remote diagnose devices that can be plugged into the OBD port of a vehicle

Options

Enable CORS by returning correct headers

SecurityNone
Responses
200

Enable CORS by returning correct headers

options/v1/connectors

Get the connectors

Get the connectors linked to the logged in user.

SecurityOAuth2 or JifelineAuthorizer
Request
query Parameters
offset
integer >= 0

The number of items to skip before starting to collect the result set.

limit
integer [ 0 .. 200 ]

The maximum number of items to return, the maximum numers of items to return is set to 200.

Example: limit=20
Responses
200

Connectors

400

Returned when a client sends a bad request

401

Returned when a request is performed without or with an incorrect OIDC token

403

Returned when a client requests a resource it's not authorized for.

500

Returned when an error occurs on the server

get/v1/connectors
Response samples
application/json
{
  • "result": [
    ],
  • "total": 234,
  • "offset": 200,
  • "limit": 20
}

Options

Enable CORS by returning correct headers

SecurityNone
Request
path Parameters
connectorId
required
integer

ID of the connector

Responses
200

Enable CORS by returning correct headers

options/v1/connectors/{connectorId}

Get a single connector

Get a single connector by providing a connector ID

SecurityOAuth2 or JifelineAuthorizer
Request
path Parameters
connectorId
required
integer

ID of the connector

Responses
200

Connector

400

Returned when a client sends a bad request

401

Returned when a request is performed without or with an incorrect OIDC token

403

Returned when a client requests a resource it's not authorized for.

404

Returned when a client requests an resource that is not found

500

Returned when an error occurs on the server

get/v1/connectors/{connectorId}
Response samples
application/json
{
  • "id": 910329423,
  • "uuid": "5f3d760d-ade2-4a19-aea4-36e097678ae3",
  • "is_online": true,
  • "has_wifi": true,
  • "software_version": 2,
  • "hardware_version": 0,
  • "supports_doip": true,
  • "vehicle_path_string": "AUDI#100#100 - (44, 44Q, C3)#1.8 Quattro 65KW SH",
  • "vin_number": "VF1CN04054456164",
  • "product_description": "Tow Bar Coding (Aftermarket Equipment)"
}

Options

Enable CORS by returning correct headers

SecurityNone
Request
path Parameters
connectorUUID
required
string <uuid>

UUID of the connector

Responses
200

Enable CORS by returning correct headers

options/v2/connectors/{connectorUUID}

Get a single connector

Get a single connector by providing a connector UUID

SecurityOAuth2 or JifelineAuthorizer
Request
path Parameters
connectorUUID
required
string <uuid>

UUID of the connector

Responses
200

Connector

400

Returned when a client sends a bad request

401

Returned when a request is performed without or with an incorrect OIDC token

403

Returned when a client requests a resource it's not authorized for.

404

Returned when a client requests an resource that is not found

500

Returned when an error occurs on the server

get/v2/connectors/{connectorUUID}
Response samples
application/json
{
  • "id": 910329423,
  • "uuid": "5f3d760d-ade2-4a19-aea4-36e097678ae3",
  • "is_online": true,
  • "has_wifi": true,
  • "software_version": 2,
  • "hardware_version": 0,
  • "supports_doip": true,
  • "vehicle_path_string": "AUDI#100#100 - (44, 44Q, C3)#1.8 Quattro 65KW SH",
  • "vin_number": "VF1CN04054456164",
  • "product_description": "Tow Bar Coding (Aftermarket Equipment)"
}

Options

Enable CORS by returning correct headers

SecurityNone
Request
path Parameters
connectorId
required
string

ID of the connector.

Responses
200

Enable CORS by returning correct headers

options/v1/connectors/{connectorId}/active-ticket

Get the active ticket on a connector

Get the active ticket on a connector

SecurityOAuth2 or JifelineAuthorizer
Request
path Parameters
connectorId
required
string

ID of the connector.

Responses
200

Ticket

400

Returned when a client sends a bad request

401

Returned when a request is performed without or with an incorrect OIDC token

403

Returned when a client requests a resource it's not authorized for.

404

Returned when a client requests an resource that is not found

500

Returned when an error occurs on the server

get/v1/connectors/{connectorId}/active-ticket
Response samples
application/json
{
  • "id": "3",
  • "uuid": "abcb2f39-7620-401a-8dab-ec2f6075ed8a",
  • "vin": "JFL91010104591010",
  • "vinNumber": "JFL91010104591010",
  • "vehicle_model_id": 23423,
  • "vehicle_model_variant_id": 23423,
  • "product_ids": [
    ],
  • "chat_id": "2349283_416e4c77-4fc0-40ca-b5a5-95a12c4e84e8",
  • "connector_id": 990001234,
  • "state": 1
}
➔ Next to Connectors