Download OpenAPI specification:
This document describes HTTP based APIs supported in CANlink mobile 10000 devices.
Protocol: HTTPS, REST.
Authorization: Basic Authentication, required user is api or admin.
Authentication failure will result in HTTP error 401 Unauthorized
CURL examples use plain text authentication option --user username:password, but alternatively it can be replaced with an Authorization header that contains Basic and a base64-encoded string username:password.
For instance to authorize as user username with password password, issue CURL request with option --user username:password or with header option -H 'Autorization: Basic dXNlcm5hbWU7cGFzc3dvcmQ='.
Certificate:
The CANlink mobile 10000 provides a self-signed ceritificate hence given CURL examples for API calls require --insecure option to ignore SSL certificate verification.
Response type: JSON
File transfer to machine - Get files transferred to the machine from the Data Platform,
The CANlink mobile 10000 device is capable of receiving files from the DataPlatform. The user can upload any file to DataPlatform
which will push it to the CANlink mobile 10000, thus making it available on the CANlink mobile 10000 local network.
A common use case is to upload update and configuration files for ECUs connected to the CANlink mobile 10000 network.
Files uploaded to the DataPlatform are then transferred to the CANlink mobile 10000 which will hold them in downloads location.
Note that due to the implementation of the file transfer process, files that are still incomplete because they are
still being transferred will be named part.{random}. Files that match this pattern should be ignored because
they have still not being fully transferred to the CANlink mobile 10000.
The downloads location status can be queried and manipulated using the downloads API endpoint, which is documented below.
curl -X GET --insecure --user 'admin:yourPassword' -H 'Accept: application/json' 'https://192.168.82.1/api/downloads'
{- "data": {
- "items": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "filename": "test0000.txt",
- "timestamp": 1700501852,
- "size": 1024
}
]
}
}| fileId required | string <uuid> Example: a0405144-36f8-4cf3-b9ed-f12f8face74f ID of the file |
curl -X GET --insecure --user 'admin:yourPassword' -H 'Accept: application/json' 'https://192.168.82.1/api/downloads/8c9890dd-2da4-54e1-886f-7a031884a5fa'
{- "data": {
- "items": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "filename": "test0000.txt",
- "timestamp": 1700501852,
- "size": 1024
}
]
}
}| fileId required | string <uuid> Example: a0405144-36f8-4cf3-b9ed-f12f8face74f ID of file that needs to be deleted |
curl -X DELETE --insecure --user 'admin:yourPassword' 'https://192.168.82.1/api/downloads/8c9890dd-2da4-54e1-886f-7a031884a5fa'
| fileId required | string <uuid> Example: a0405144-36f8-4cf3-b9ed-f12f8face74f ID of the file |
curl -X GET --insecure --user 'admin:yourPassword' -H 'Accept: application/octet-stream' 'https://192.168.82.1/api/downloads/8c9890dd-2da4-54e1-886f-7a031884a5fa/content' --output '/tmp/update-file.bin'