REST API - Uploading Data to Devices

Uploading Data to Devices

The URL for this endpoint is: https://www.satvue.com.au/api/uploadData.

The uploadData endpoint allows for data from third party systems to be ingested into the SatVUE portal. All parameters must be URL encoded.

  • access_id: The Access ID of the API Key.
  • secret: The Secret of the API Key.
  • serial: The serial number of the device to upload data to
  • latitude: [OPTIONAL] The device's new latitude co-ordinate
  • longitude: [OPTIONAL] The device's new longitude co-ordinate
  • records: A JSON structure containing all the timestamped data records in the following format:
    [
    	{
    		"timestamp": "2021-01-01 00:00:00 +10",      // Either a text timestamp
    		"ts": 1619741943,                            // Or an epoch in UTC, or both
    		"values": {
    			"FieldName1": 1,
    			"FieldName2": 2,
    			...
    			...
    		}
    	},
    	...
    	...
    ]
    							

The available devices for the API Key will be returned in the following JSON structure:

{
   "success": [true|false],
   "error": "[Error String if success=false]",
}
					

The following is an cURL example of how to use this API Endpoint using a GET request.

curl "https://www.satvue.com.au/api/uploadData?access_id=[ACCESS_ID]&secret=[SECRET]&serial=[SERIAL_NUMBER]&latitude=[LATITUDE]&longitude=[LONGITUDE]&records=[RECORDS_JSON]"
					

The following is an cURL example of how to use this API Endpoint using a POST request.

curl --data "access_id=[ACCESS_ID]&secret=[SECRET]&serial=[SERIAL_NUMBER]&latitude=[LATITUDE]&longitude=[LONGITUDE]&records=[RECORDS_JSON]" "https://www.satvue.com.au/api/uploadData"
					

The following is example the data returned by this endpoint.

{
   "success":true,
}