MyWakes geo location REST Web API
Consume REST Web API service from any device or application.
With MyWakes REST API you will be able to build your custom solution and send HTTP requests in order to get the data you need.
MyWakes REST Web API use case
Here are some examples of what you can do with GPS tracking APIs:
- Create and manage your tracks, consumers, users and so on...
- Generate points from any of your registered device
- Build a mobile App that takes a picture, upload it on MyWakes linking it to your current track
- Develop a desktop application that downloads tracks data and creates custom statistics
- Design a website that shows your vehicles positions
- Retrieve information like mileage when a vehicle is parked and import it in your ERP
- Applications written in any programming language can interact with data on MyWakes.
Through our web interface it is possible to look at the Rest API documentation and test every endpoints (based on your execution permissions).
First of all you have to insert your Application Id in the “My Wakes Application Id” field.
Then, by clicking on the desired signature (on the right you can see what kind of permission you need in order to execute that specific command) you will see the command description along with request parameters and response object.
When a command expects for “username” request parameter, it means that it is possible to specify a User that has been created by the current Application.
Tracking REST APIs quick reference
MyWakes Rest API can be accessed over HTTPS, via the https://cloud.mywakes.com domain.
The relative path prefix /api/v1.0 indicates that we are currently using version 1.0 of the API.
The next part of path indicates the type of request and can be:
/actions: with these endpoints it is possible to manage actions and also raise them;
/brands: these endpoints allow you to manage the brands of your vehicles;
/charts: with these endpoints it is possible to manage the charts to show on map;
/consumers: it is made up many entry points that are focused in consumer management included consumer real time radar appearance;
/consumerstypes: these endpoints allow you to manage the consumers types of your vehicles;
/devices: these entry points permits to associate devices to users and get all devices-related data;
/drivers: these endpoints allow you to manage the drivers of your vehicles;
/geofences: create and manage your virtual fences and their alarm modes;
/groups: these endpoints allow you to manage the groups of your vehicles;
/kmls: with these endpoints it is possible to manage the Kml / Kmz / GeoRSS to show on map;
/models: these endpoints allow you to manage the models of your vehicles;
/mywakesui: include any pages of the reserved area such as Iframe in your pages;
/ownershiptypes: these endpoints allow you to manage the ownership types of your vehicles;
/pois: with these endpoints it is possible to manage the points of interest to show on map;
/query: permits to run fully customized queries against MyWakes database;
/reports: permits to download several reports in PDF format;
/shop: renew services and buy shop products;
/suppliers: these endpoints allow you to manage the suppliers of your vehicles;
/tracks: includes many entry points that permits to create, read and manage tracks and points;
/users: contains user account management and related information;
/utilities: useful functions for geospatial data.
You can view the complete list of endpoints to “all endpoints” page.
REST Web APIs interface permissions
Every MyWakes user can request one Application Id to make Rest API Requests.
Each endpoint belongs to a set of endpoints called “interface”.
Depending on user's contract, an Application Id can be qualified to run one or more interfaces' endpoints. This makes ad Application Id capable to run some endpoints but not others.
The permission referenced by each endpoint is specified next to Rest API signature: , , etc.
REST requests format standards
Each request must include MyWakes Application Id in the HTTP Header X-MyWakes-Application-Id.
The X-MyWakes-Application-Id header identifies your application and, consequently the interfaces that you will be able to use.
Each POST and PUT requests, can have a request body both in JSON and XML, with the Content-Type header set to application/json or application/xml.
REST response format standards
The response format for all requests depends on the Accept header and can be a JSON object or a XML document with the Accept header set to application/json or application/xml.
Whether a request succeeded is indicated by the HTTP status code.
A 2xx status code indicates success, whereas a 4xx status code indicates failure.
When a request fails, the response body format will be JSON or XML accordingly the Accept header, but always contains the fields “code” and “message” which you can inspect to use for debugging. For example, trying to use an invalid Application Id will return:
<message>Application not allowed</message>
"message": "Application not allowed"
The following headers are present in the response:
X-MyWakes-Limit-Current - Maximum limit of daily calls;
X-MyWakes-Limit-Remaining - Number of calls left in the day;
X-MyWakes-Limit-Reset - Seconds left until next calls totalizer reset.
Error 429 indicates that too many daily calls have been sent; it is necessary to wait the remaining seconds for the next reset. The reset will take place at 00:00 UTC.
MyWakes Tracking REST APIs SDKs to download
You can easily generate SDKs (REST API libraries) in many programming languages.
Just select the target platform and click the download button in order to get the corresponding client with default setting.
You can also create a more customized solution by selecting the “advanced options” link that will show you the language-specific configuration settings.