Jifeline Partner Websockets API 1.0.0 documentation

Jifeline Partner Websockets API 1.0.0

application/json

Jifeline Partner Websockets API offers real time updates related to data of your Partner Portal.

General Considerations

All messages sent and received via WebSockets are encoded in JSON format.
Recommended reconnection behaviour is to (1) attempt reconnection instantly up to a handful of times if the websocket is dropped randomly during normal operation but (2) after extended downtime, attempt to reconnect no more quickly than once every 5 seconds.

Servers

wss://partner-api-ws-001.prd.jifeline.cloud/wssprd
Server that requires a access token to be send when connecting.

See this Partner API documentation to learn how to get an access token.

Send the access token via the header Authorization: Bearer <your token> or pass it via the ?access_token=<your token> query parameter.

Once the socket is open you can subscribe by sending a specific subscribe request messages.
Security:
HTTP
Scheme: bearer
Bearer format: JWT
Provide an access token.

OAuth2
For more information, see "Exchanging client credentials for an access token: client secret in authorization header" on this page.

Flow:Client credentials
Token URL:https://partner-api-001.prd.jifeline.cloud/oauth2/token
Scopes:

Operations

RECEIVE /
Operation IDsubscribe
Available only on servers:
- prd
Accepts one of the following messages:
- #0Subscribe to connector
  application/json
  Message IDsubscribeToConnector
  Subscribe to receive status updates regarding a connector.
  
  object
  action
  required
  string
  Const:"subscribe-to-connector"
  connector_id
  required
  string
  format: uuid
  The identity of the connector you wish to subscribe to.
  
  Additional properties are allowed.
  object
  title
  Connector status update
  description
  A status update of a subscribed connector.
  object
  action
  string
  The action to which the message is a response.
  
  Const:"subscribe-to-connector"
  object
  connector_id
  string
  format: uuid
  The identity of the connector.
  
  voltage
  number
  format: float
  Voltage measured on the connected vehicle in volts.
  
  vin_number
  string
  17 characters
  Vehicle Identification Number of the connected vehicle.
  
  round_trip_time
  integer
  format: int32>= 0
  The round trip time between the local and remote connector in milliseconds.
  
  Additional properties are allowed.
  Additional properties are allowed.
  Examples
  { "action": "subscribe-to-connector", "connector_id": "9389ba6f-3696-4571-84d4-34d588c4b109" }
  
  This example has been generated automatically.
- #1Unsubscribe from connector
  application/json
  Message IDunsubscribeFromConnector
  Unsubscribe from receiving status updates regarding a connector.
  
  object
  action
  required
  string
  Const:"unsubscribe-from-connector"
  connector_id
  required
  string
  format: uuid
  The identity of the connector you wish to unsubscribe from.
  
  Additional properties are allowed.
  Examples
  { "action": "unsubscribe-from-connector", "connector_id": "9389ba6f-3696-4571-84d4-34d588c4b109" }
  
  This example has been generated automatically.
- #2Subscribe to event
  application/json
  Message IDsubscribeToEvent
  Subscribe to receive events with the specified type.
  
  object
  action
  required
  string
  Const:"subscribe-to-event"
  event_type
  required
  string
  The type of event to subscribe to. To see all available events see the Partner API documentation.
  
  Additional properties are allowed.
  object
  title
  Event received
  description
  A system event was received.
  object
  action
  string
  The action to which the message is a response.
  
  Const:"event-received"
  event_id
  string
  format: ulid
  Event identifier.
  
  event_type
  string
  The type of the event that was received.
  
  object
  The event payload. For a detailed specification per event type see the Partner API documentation.
  
  Additional properties are allowed.
  Additional properties are allowed.
  Examples
  { "action": "subscribe-to-event", "event_type": "tickets.ticket.created" }
  
  This example has been generated automatically.
- #3Unsubscribe from event
  application/json
  Message IDunsubscribeFromEvent
  Unsubscribe from receiving events with the specified type.
  
  object
  action
  required
  string
  Const:"unsubscribe-from-event"
  event_type
  required
  string
  The type of event to unsubscribe from.
  
  Additional properties are allowed.
  Examples
  { "action": "unsubscribe-from-event", "event_type": "tickets.ticket.created" }
  
  This example has been generated automatically.
SEND /
Operation IDpublish
Available only on servers:
- prd
Accepts one of the following messages:
- #0Connector status update
  application/json
  Message IDconnectorStatusUpdate
  A status update of a subscribed connector.
  
  object
  action
  string
  The action to which the message is a response.
  
  Const:"subscribe-to-connector"
  object
  connector_id
  string
  format: uuid
  The identity of the connector.
  
  voltage
  number
  format: float
  Voltage measured on the connected vehicle in volts.
  
  vin_number
  string
  17 characters
  Vehicle Identification Number of the connected vehicle.
  
  round_trip_time
  integer
  format: int32>= 0
  The round trip time between the local and remote connector in milliseconds.
  
  Additional properties are allowed.
  Additional properties are allowed.
  Examples
  { "action": "subscribe-to-connector", "message": { "connector_id": "9389ba6f-3696-4571-84d4-34d588c4b109", "voltage": 11.2, "vin_number": "JFL91010104491010", "round_trip_time": 23 } }
  
  This example has been generated automatically.
- #1Event received
  application/json
  Message IDeventReceived
  A system event was received.
  
  object
  action
  string
  The action to which the message is a response.
  
  Const:"event-received"
  event_id
  string
  format: ulid
  Event identifier.
  
  event_type
  string
  The type of the event that was received.
  
  object
  The event payload. For a detailed specification per event type see the Partner API documentation.
  
  Additional properties are allowed.
  Additional properties are allowed.
  Examples
  { "action": "event-received", "event_id": "string", "event_type": "tickets.ticket.created", "message": {} }
  
  This example has been generated automatically.

Messages

#1Subscribe to connector
- application/json
Message IDSubscribeToConnector
Subscribe to receive status updates regarding a connector.

object
action
required
string
Const:"subscribe-to-connector"
connector_id
required
string
format: uuid
The identity of the connector you wish to subscribe to.

Additional properties are allowed.
object
title
Connector status update
description
A status update of a subscribed connector.
object
action
string
The action to which the message is a response.

Const:"subscribe-to-connector"
object
connector_id
string
format: uuid
The identity of the connector.

voltage
number
format: float
Voltage measured on the connected vehicle in volts.

vin_number
string
17 characters
Vehicle Identification Number of the connected vehicle.

round_trip_time
integer
format: int32>= 0
The round trip time between the local and remote connector in milliseconds.

Additional properties are allowed.
Additional properties are allowed.
#2Unsubscribe from connector
- application/json
Message IDUnsubscribeFromConnector
Unsubscribe from receiving status updates regarding a connector.

object
action
required
string
Const:"unsubscribe-from-connector"
connector_id
required
string
format: uuid
The identity of the connector you wish to unsubscribe from.

Additional properties are allowed.
#3Connector status update
- application/json
Message IDConnectorStatusUpdate
A status update of a subscribed connector.

object
action
string
The action to which the message is a response.

Const:"subscribe-to-connector"
object
connector_id
string
format: uuid
The identity of the connector.

voltage
number
format: float
Voltage measured on the connected vehicle in volts.

vin_number
string
17 characters
Vehicle Identification Number of the connected vehicle.

round_trip_time
integer
format: int32>= 0
The round trip time between the local and remote connector in milliseconds.

Additional properties are allowed.
Additional properties are allowed.
#4Subscribe to event
- application/json
Message IDSubscribeToEvent
Subscribe to receive events with the specified type.

object
action
required
string
Const:"subscribe-to-event"
event_type
required
string
The type of event to subscribe to. To see all available events see the Partner API documentation.

Additional properties are allowed.
object
title
Event received
description
A system event was received.
object
action
string
The action to which the message is a response.

Const:"event-received"
event_id
string
format: ulid
Event identifier.

event_type
string
The type of the event that was received.

object
The event payload. For a detailed specification per event type see the Partner API documentation.

Additional properties are allowed.
Additional properties are allowed.
#5Unsubscribe from event
- application/json
Message IDUnsubscribeFromEvent
Unsubscribe from receiving events with the specified type.

object
action
required
string
Const:"unsubscribe-from-event"
event_type
required
string
The type of event to unsubscribe from.

Additional properties are allowed.
#6Event received
- application/json
Message IDEventReceived
A system event was received.

object
action
string
The action to which the message is a response.

Const:"event-received"
event_id
string
format: ulid
Event identifier.

event_type
string
The type of the event that was received.

object
The event payload. For a detailed specification per event type see the Partner API documentation.

Additional properties are allowed.
Additional properties are allowed.

Schemas

object
action
required
string
Const:"subscribe-to-connector"
connector_id
required
string
format: uuid
The identity of the connector you wish to subscribe to.

Additional properties are allowed.
object
action
required
string
Const:"unsubscribe-from-connector"
connector_id
required
string
format: uuid
The identity of the connector you wish to unsubscribe from.

Additional properties are allowed.
object
action
string
The action to which the message is a response.

Const:"subscribe-to-connector"
object
connector_id
string
format: uuid
The identity of the connector.

voltage
number
format: float
Voltage measured on the connected vehicle in volts.

vin_number
string
17 characters
Vehicle Identification Number of the connected vehicle.

round_trip_time
integer
format: int32>= 0
The round trip time between the local and remote connector in milliseconds.

Additional properties are allowed.
Additional properties are allowed.
object
action
required
string
Const:"subscribe-to-event"
event_type
required
string
The type of event to subscribe to. To see all available events see the Partner API documentation.

Additional properties are allowed.
object
action
required
string
Const:"unsubscribe-from-event"
event_type
required
string
The type of event to unsubscribe from.

Additional properties are allowed.
object
action
string
The action to which the message is a response.

Const:"event-received"
event_id
string
format: ulid
Event identifier.

event_type
string
The type of the event that was received.

object
The event payload. For a detailed specification per event type see the Partner API documentation.

Additional properties are allowed.
Additional properties are allowed.

Jifeline Partner Websockets API 1.0.0

General Considerations

Servers

Security:

Operations

RECEIVE /

Examples

This example has been generated automatically.

Examples

This example has been generated automatically.

Examples

This example has been generated automatically.

Examples

This example has been generated automatically.

SEND /

Examples

This example has been generated automatically.

Examples

This example has been generated automatically.

Messages

Schemas