API

The Syrus 4 device has an internal/embedded API that allows you to interact with its internal components via RESTful http methods.
You can view the online reference in the following link syrus-api-docs.dctserver.com

To use the API you'll need to make the request to the device's IP address or the local address http://syrus-IMEI.local, example: http://syrus-867698041064091.local

Tip
When doing local requests on the device you can use http://localhost:8080 to test the API methods:

syrus4g@syrus-867698040012345 ~
$ curl http://localhost:8080/gps/position
{"coords":{"latitude":25.782976,"longitude":-80.293276,"speed":0.272777996,"accuracy":4.25,"altitude":32.229,"bearing":190.83,"altitudeAccuracy":6.35},"timestamp":1636997251,"extras":{"hdop":0.85,"vdop":1.27,"pdop":1.52,"fix":3,"satsActive":11,"criteria":"signal"}}

📘

Sending Commands / Taking Actions Requires Auth

Note that sending commands and taking actions, like activating an output on the device, requires Basic Auth. There is no Login method, you just need the credentials for the syrus4g user in order to send commands to the device.

Check this section of the docs to enable it for the API methods

If you're looking to remotely interact with the API you must expose the remote IP address and port (8080).

Click here to see the Postman and OpenAPI specification documents.

         

📘

Local testing with Postman

If you're using postman you must download the Desktop client version to run the API locally with the Syrus 4.