APIs
Three ways for other systems to work with MaxwellTrack: devices report readings over HTTPS, any system starts an automation with a webhook, and your apps sign people in with their MaxwellTrack account.
| API | Who calls it | Authenticated by |
|---|---|---|
| Device reports | A device, gateway, phone app or script | The device's ID and access token |
| Automation webhooks | Any system | The secret in the webhook's address |
| Sign in with MaxwellTrack | Your web, mobile or server app | OAuth 2.0 and OpenID Connect |
Base address
Every request goes to https://maxwelltrack.com over HTTPS. Request and response bodies are JSON.
Responses
Device reports and webhooks answer with the same envelope. Read success first; on failure, error.message is a sentence you can log or show.
{ "success": true, "data": { "accepted": true } }Sign in with MaxwellTrack follows the OAuth 2.0 format instead: { "error": "invalid_grant", "error_description": "..." }.
Status codes
| Code | Meaning |
|---|---|
202 | Accepted. The request is taken for processing. |
400 | The body is malformed or a field is not allowed. The message names the problem. |
401 | The credentials are missing or wrong. |
404 | No such address. A deleted webhook answers this too. |
409 | The automation behind a webhook is switched off. |
413 | The body is too large. |
429 | Too many requests. Slow down and retry later. |
503 | Briefly unavailable. Retry after the number of seconds in Retry-After. |
The requests the MaxwellTrack console makes for itself are not a public API and change without notice. Build only on the APIs on these pages.
Something unclear or out of date on this page? Tell support.
