Kite Javascript API

Connector functions Kite JS API guide

This API allows users to execute operations in the Kite connector from a connector function.

Kite Object

The Kite object is the main object of the Kite connector. It allows to connect to the Kite server and execute operations.

Kite Object Properties

Property Type Default Description
uriHost string Host of the Kite server.
uriService string Service of the Kite server.
proxyEnabled boolean false Enable proxy.
proxyHost string Host of the proxy (If proxy is enabled).
proxyPort number Port of the proxy (If proxy is enabled).
proxyProtocol string Protocol of the proxy (If proxy is enabled).

It should be noted that these properties will be used in all methods of communicating with Kite Service.

Specific datastreams to use Kite

Datastream Type Description
provision.administration.connection.kite.certificate String Certificate to communication with Kite
provision.administration.connection.kite.privateKey String Private Key to communication with Kite

This data streams can be specified:

  • To a chosen device.
  • To a chosen channel. Please make sure you use these values for all the entities in the selected channel.
  • To a chosen organization. This set of values should be used in the same way in every part of the organization.

Kite Object Methods

requestChangeTerminalStatus (status) ⇒ Object

Changes the status of the subscription using the specified parameter and completing collection object with new administrative status.

Parameter Type Description
status string Status of the subscription.

Returns a object with the following properties:

  • isOk (boolean): True if request is ok
  • description: Result description of the operation.

requestTerminalDetails () ⇒ Object

Gets the details of the subscription and complete collection object with result.

Returns a object with the following properties:

  • isOk (boolean): True if request is ok
  • description: Result description of the operation.