Ruptela device data via API

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

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

  1. Create a free flespi account.

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

  3. Create a flespi device to access telemetry, apply plugins and analytics, and use long-term message storage.

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

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

  6. 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. Create a flespi device. This step takes interaction with your device to a qualitatively new level — get access to device telemetry, easily send configuration commands, configure post-processing using plugins, aggregate messages into intervals, and benefit from extended message storage.

Click on Telematics Hub (1), then on Devices (2), then on the plus button (3) in the lower right corner of the screen (3). Pick the proper device type and specify the device ID:

create flespi device ruptela

Now you can use the device API to access device data, send commands, and a lot more, or explore the numerous tabs on the device card.

4. 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.

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

(a) While on the device screen, click on the LOGS & MESSAGES tab:

flespi ruptela device logs messages

(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.

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

6. Access Ruptela device data via API:

(a) Make a note of what your device ID is:

flespi ruptela device ID

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

flespi rest api menu item

(c) In the menu on the left under Gateway API click on devices. Find GET /devices/{dev-selector}/messages request. Click on it to reveal additional fields.

flespi get device messages api request

(d) Paste the device ID into the dev-selector field and click the eye button to view the results (or copy CURL for execution):

request to get ruptela device messages

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

ruptela data in json message flespi

What's next?