Help Home | Motors@Work | Setup Overview | Glossary
Motors@Work API
Connect with the Motors@Work using the JSON-based RESTful API. The Motors@Work REST/HTTP API allows you to send motor and motor based system readings to the Motors@Work analytics engine.
Authentication
The Motors@Work public API uses REST which requires authentication on every request. The API expects HTTP basic access authentication to be included with each request and each request must be made over HTTPS.
Endpoints
Endpoint | HTTP verb | Purpose |
---|---|---|
/api/1.0/rest/test | GET | Authentication Testing |
/api/1.0/rest/motor/external/measurement | PUT | Adding a measurement |
Authentication Testing
Test your Motors@Work authentication by sending a GET request to https://www.app.motorsatwork.com/api/1.0/rest/test with HTTP basic access authentication using valid Motors@Work credentials included in the request header.
If successful, you will receive a json response:
{"message":"Way to go, you are authenticated!"}
If not successful, the response will look like this:
{"errors":{"entity":{"errorMessages":["Authorization failure."]}},"data":""}
Adding a measurement
Test your Motors@Work Adding a Measurement by sending a PUT request to https://www.app.motorsatwork.com//api/1.0/rest/motor/external/measurement with HTTP basic access authentication using valid Motors@Work credentials included in the request header.
The PUT Request will have the following format
{
"data": [
{
"referenceNumber": "MOTORTEST3",
"measurementDate": "2017-04-05T12:37:53.000Z",
"voltageAB": 450,
"voltageBC": 400,
"voltageCA": 380,
"currentA": 5,
"currentB": 6,
"currentC": 7,
"powerFactor": 90,
"measuredSpeed": 1800,
"powerDraw": 50,
"totalHarmonicDistortion": 10,
"insulationResistance": 20,
"vibration": 20,
"surgeMotorCircuit": 10
}
]
}