We designed the Equinox API to allow for RESTful URI-based interactions with Equinox. We will expand the functionality over time to allow for more complicated and in-depth interactions with Equinox.
All of the routes in this document must start with a hostname (URL). This will be a combination of the URL that you use to access your Equinox account and /products/api at the end. Here are a few examples below. This is not a complete list and your hostname may be different.
| Server | Hostname |
|---|---|
| Main | https://www.workanyware.co.uk/products/api |
| Canada | https://ca.workanyware.co.uk/products/api |
| Pacific | https://pacific.workanyware.co.uk/products/api |
| US (Central) | https://central-us.equinox-ipms.com/products/api |
Routes and Functionality
HTTP Responses
The API will return different status codes/responses depending on why you can't authenticate with the service. The table below summarises these response codes:
| Status Code | Reason for the response |
|---|---|
| 200 | OK |
| 400 | Validation error |
| 401 | Unauthorised – Invalid credentials were provided |
| 403 | Forbidden – Correct username/key combination was entered, but this key has been marked as invalid and will no longer allow access. |
| 405 | Method not allowed – Probably incorrect GET or POST |
| 500 | Internal server error |