Ruptela device data via API

Obtain telematics data from Ruptela devices via API in 5 easy steps.

Obtain telematics data from Ruptela devices via API in 5 easy steps:

  1. Create a free flespi account.

  2. Set up the Ruptela channel in your flespi.io interface.

  3. Point a Ruptela device to your flespi account using the configurator from Ruptela or by sending an SMS command to the device.

  4. Confirm that the device data is being received and parsed.

  5. Access Ruptela device data via API.


1. Create a free flespi account

(a) Go to www.flespi.io and click on LOGIN / REGISTER:

flespi login page

(b) You can choose from a number of third-party service accounts to log in under or the right-most option @ to register with your name and email address: 

flespi login method

2. Set up the Ruptela channel in your flespi.io interface:
(a) Click on Telematics Hub (1), then on Channels (2), then on the plus button in the lower right corner of the screen (3).

flespi channels section

(b) Channel dialogue box will come up. Enter the name for the channel (any text will suffice) (1), select “Ruptela” in the protocol_id drop-down (2), click SAVE + OPEN (3):

create ruptela channel flespi

(c) Channel dialogue will open. Make a note of the domain name and port that you should point your device to. IMPORTANT: Image below indicates where to find the info and is NOT an actual domain/port for you to use.

flespi ruptela channel domain name port

3. Point your Ruptela device to your flespi account using Ruptela's Advanced Configurator tool, Device Center, or by sending an SMS command to the device. Domain name and port to point the device to are shown in the channel box.

Syntax of the SMS command is as follows:

pass setcfg 110 domain, 120 port

where

pass — configuration password if used,

setcfg — command used to upload configuration parameters,

110 — parameter number for IP1,

120 — parameter number for Port1.

4. Confirm that the device data is being received and parsed:

(a) While in the channel dialogue box, click on LOGS & MESSAGES tab:

flespi ruptela channel toolbox

(b) Ensure BOTH Logs and Messages views are selected. Inspect log records (1) to confirm that your device has successfully connected to flespi. The presence of messages in the lower half of the screen (2) will confirm that the incoming data is parsed.

flespi ruptela channel logs messages

In case of any issues, check out our troubleshooting checklist.

5. Access Ruptela device data via API:

(a) Click on the REST API Documentation menu item in the lower-left corner:

flespi panel open rest api docs

(b) In the menu on the right under Gateway API click on channels:

flespi rest api gateway

(c) Scroll down until you see GET /channels/{1-ch-selector}/messages request. Click on it to reveal additional fields. 

flespi rest api get channel messages

(d) Put in your channel ID into the 1-ch-selector field (1) and execute the API call (2).

flespi rest api get channel messages execute

(e) And here you have it. Ruptela device messages in an easy to read JSON format:

flespi rest api get ruptela channel messages result

What's next?