Mappls Snap to Road V2 API¶
Easy To Integrate Maps & Location APIs & SDKs For Web & Mobile Applications
Powered with India's most comprehensive and robust mapping functionalities.
You can get your api key to be used in this document here: https://about.mappls.com/api/
Disclaimer¶
- This API is released for select use cases only; Please contact Mappls API Support or your account manager for discussions on usage of this solution.
- Mappls reserves the right to revoke access of this API at its own discrection.
Introduction¶
The trace_route variant of Snap to Road V2 API requires two parameters: a costing mode and a series of latitude and longitude coordinates. This function is designed to transform these coordinates, typically obtained from a GPS trace, into a route that closely follows the road network. Additionally, it generates a set of guidance directions for navigation purposes.
Security Type¶
This APIs follow OAuth2 based security. To know more on how to create your authorization tokens, please use our authorization token URL. More details available here
Request Headers¶
The API leverages OAuth 2.0 based security. Hence, the developer would need to send a request for access token using their client_id and client_secret to the OAuth API. Once validated from the OAuth API, the access_token and the token_type need to be sent as Authorization header with the value: “{token_type} {access_token}”.
Authorization: “token_type access_token”.
Input Method¶
POST
Contructing the request cURL¶
curl --location 'https://apis.mappls.com/advancedmaps/v2/trace_route' \
--header 'Authorization: bearer 0XXXXXXf-dXX0-4XX0-8XXa-eXXXXXXXXXX6' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'points=72.8632,21.207756;72.86322,21.207582;72.86325,21.207506;72.86324,21.207438;72.86321,21.207426;72.8632,21.207474;72.8632,21.207546;72.86319,21.20757;72.863174,21.207487;72.863174,21.20747;72.86319,21.20743;72.863174,21.207357;72.863144,21.2073;72.862976,21.207394;72.86255,21.207676;72.86244,21.207796;72.86244,21.207764' \
--data-urlencode 'type=break' \
--data-urlencode 'search_radius=12'
Request Parameters¶
Mandatory Parameters¶
points: set of sequential (time-based sequence) coordinates as pairs of longitude,latitude separated by a semicolon. At present maximum number of points is limited to 100 in a single request. For example 77.983936,28.255904;77.05993,28.487555.type: (string) type of additional actions applicable. Valid values:break: split the route response into multiple legs. As of now only onetypeis applicable.
Optional Parameters¶
search_radius: Limits the search of nearest snappable road network to the given radius in meters.
Response Type¶
JSON: response will served as JSON
Response Parameters¶
tracepoints(array of objects): each containing:matchings_index(integer)waypoint_index(integer)alternatives_count(integer)distance(float)name(string)location(list of float values, latitude and longitude)
code(string): status message of the requestmatchings(array of objects): each containingweight_name(string): MMI Internal Usage for debugging purposes.weight(float)duration(float) in seconds of the road section to which the raw input was snapped to & not considering live traffic.distance(float) in meters of the road section to which the raw input was snapped to.legs(array of objects): each containing:weight(float): Internal usage.duration(float): in seconds between successive location sent for snapping as per road section snapped to.steps(array): empty array as of now.distance(float):in meters between successive location sent for snapping as per road section snapped to.summary(string): Not processed as of now.
geometry(string): the 1e5 standard encoded polyline of the snapped road section.confidence(float): Confidence with which the snapping has been performed to the provided geometry. Values range between 0 & 1.
Response Codes¶
| Status Code | Status | Description |
|---|---|---|
| 200 | Successful Response | A happy bit of json describing your result |
| 400 | Failed to parse request | You need a valid request |
| 400 | Failed to parse location | You need a valid location object in your json request |
| 400 | Failed to parse correlated location | There was a problem with the location once correlated to the routing network |
| ~~400~~ | ~~No profile provided~~ | ~~You forgot the profile parameter~~ |
| 400 | Insufficient number of locations provided | You didn't provide enough locations |
| 400/401 | Exceeded max route locations of X | You are asking for too many locations |
| 400 | Locations are in unconnected regions. | You are routing between regions of no connectivity |
| ~~400~~ | ~~No profile method found for 'X'~~ | ~~You are asking for a non-existent profile mode~~ |
| 400 | No suitable road network near location | There were no roads applicable to your mode of travel near the input location |
| 400 | No data found for location | There was no route data found at the input location |
| 400 | No path could be found for input | There was no path found between the input locations |
| 401 | Unauthorized | Developer’s key is not allowed to send a request |
| 403 | Forbidden | Developer’s key has hit its daily/hourly limit. |
| 405 | Incorrect Method | Use valid HTTP method |
| 412 | Precondition Failed | Mandatory parameter is missing |
| 500 | Internal Server Error | The request caused an error in our systems. |
| 501 | Not implemented | Not Implemented |
| 503 | Service Unavailable | Maintenance break or server downtime |
Sample Response¶
{
"tracepoints": [
{
"matchings_index": 0,
"waypoint_index": 0,
"alternatives_count": 0,
"distance": 10.22,
"name": "",
"location": [
72.863187,
21.207665
]
},
{
"matchings_index": 0,
"waypoint_index": 1,
"alternatives_count": 0,
"distance": 1.361,
"name": "",
"location": [
72.863207,
21.207579
]
},
{
"matchings_index": 0,
"waypoint_index": 2,
"alternatives_count": 0,
"distance": 2.585,
"name": "",
"location": [
72.863226,
21.207501
]
},
{
"matchings_index": 0,
"waypoint_index": 3,
"alternatives_count": 0,
"distance": 0.0,
"name": "",
"location": [
72.863241,
21.207438
]
},
{
"matchings_index": 0,
"waypoint_index": 4,
"alternatives_count": 0,
"distance": 3.38,
"name": "",
"location": [
72.863242,
21.207433
]
},
{
"matchings_index": 0,
"waypoint_index": 5,
"alternatives_count": 0,
"distance": 6.337,
"name": "",
"location": [
72.863242,
21.207433
]
},
{
"matchings_index": 0,
"waypoint_index": 6,
"alternatives_count": 0,
"distance": 37.068,
"name": "",
"location": [
72.863291,
21.207224
]
},
{
"matchings_index": 0,
"waypoint_index": 7,
"alternatives_count": 0,
"distance": 39.847,
"name": "",
"location": [
72.863269,
21.20722
]
},
{
"matchings_index": 0,
"waypoint_index": 8,
"alternatives_count": 0,
"distance": 31.145,
"name": "",
"location": [
72.863239,
21.207214
]
},
{
"matchings_index": 0,
"waypoint_index": 9,
"alternatives_count": 0,
"distance": 29.299,
"name": "",
"location": [
72.863239,
21.207214
]
},
{
"matchings_index": 0,
"waypoint_index": 10,
"alternatives_count": 0,
"distance": 24.592,
"name": "",
"location": [
72.863239,
21.207214
]
},
{
"matchings_index": 0,
"waypoint_index": 11,
"alternatives_count": 0,
"distance": 16.978,
"name": "",
"location": [
72.863207,
21.207208
]
},
{
"matchings_index": 0,
"waypoint_index": 12,
"alternatives_count": 0,
"distance": 13.933,
"name": "",
"location": [
72.863091,
21.207185
]
},
{
"matchings_index": 0,
"waypoint_index": 13,
"alternatives_count": 0,
"distance": 14.391,
"name": "",
"location": [
72.86284,
21.207367
]
},
{
"matchings_index": 0,
"waypoint_index": 14,
"alternatives_count": 0,
"distance": 12.871,
"name": "",
"location": [
72.862671,
21.207699
]
},
{
"matchings_index": 0,
"waypoint_index": 15,
"alternatives_count": 0,
"distance": 6.755,
"name": "",
"location": [
72.862376,
21.207784
]
},
{
"matchings_index": 0,
"waypoint_index": 16,
"alternatives_count": 0,
"distance": 6.047,
"name": "",
"location": [
72.862383,
21.207753
]
}
],
"code": "Ok",
"matchings": [
{
"weight_name": "auto",
"weight": 773.477,
"duration": 95.636,
"distance": 245.203,
"legs": [
{
"weight": 5.155,
"duration": 3.495,
"steps": [],
"distance": 9.708,
"summary": ""
},
{
"weight": 4.718,
"duration": 3.198,
"steps": [],
"distance": 8.884,
"summary": ""
},
{
"weight": 3.787,
"duration": 2.568,
"steps": [],
"distance": 7.133,
"summary": ""
},
{
"weight": 0.336,
"duration": 0.228,
"steps": [],
"distance": 0.632,
"summary": ""
},
{
"weight": 0.0,
"duration": 0.0,
"steps": [],
"distance": 0.0,
"summary": ""
},
{
"weight": 12.554,
"duration": 8.511,
"steps": [],
"distance": 23.642,
"summary": ""
},
{
"weight": 1.038,
"duration": 0.847,
"steps": [],
"distance": 2.353,
"summary": ""
},
{
"weight": 1.393,
"duration": 1.137,
"steps": [],
"distance": 3.158,
"summary": ""
},
{
"weight": 0.0,
"duration": 0.0,
"steps": [],
"distance": 0.0,
"summary": ""
},
{
"weight": 0.0,
"duration": 0.0,
"steps": [],
"distance": 0.0,
"summary": ""
},
{
"weight": 1.437,
"duration": 1.173,
"steps": [],
"distance": 3.258,
"summary": ""
},
{
"weight": 5.394,
"duration": 4.403,
"steps": [],
"distance": 12.231,
"summary": ""
},
{
"weight": 630.297,
"duration": 20.187,
"steps": [],
"distance": 46.767,
"summary": ""
},
{
"weight": 43.638,
"duration": 16.771,
"steps": [],
"distance": 46.587,
"summary": ""
},
{
"weight": 61.886,
"duration": 31.868,
"steps": [],
"distance": 77.375,
"summary": "Abhaynagar Society Road"
},
{
"weight": 1.844,
"duration": 1.25,
"steps": [],
"distance": 3.473,
"summary": ""
}
],
"geometry": "aflmg@e|e~iCjDg@zCe@|B]HA??`LaBFj@Jz@????J~@l@fFvAjKcMhB{MlBYFORLjCSTm@N}ATcQ~BpBlOfH_A|@M",
"confidence": 1.0
}
]
}
For any queries and support, please contact:
Email us at apisupport@mappls.com
Support
Need support? contact us!
@ Copyright 2024 CE Info Systems Ltd. All Rights Reserved.
Terms & Conditions | Privacy Policy | Supplier Sustainability Policy | Health & Safety Policy | Environmental Policy & CSR Report
Customer Care: +91-9999333223