API
Rutamina API provides data from our database of routes, so any application can get, search and display on their own maps our routes
Documentation
The following provides documentation of services available. All invocations must bear the additional parameter 'app' that will be the key provided by the team rutamina.
If you do not have a key, contact us.
Languages
Gets the available languages
Example: http://rutamina.com/api/proxy/languages
Available Countries
Gets the available countries
Example: http://rutamina.com/api/proxy/countries?languageId=es
Parameters:
| Parameter | Required | Use |
|---|---|---|
| languageId | yes | Language Identifier |
Available Provinces
Gets the available provinces of a country
Example: http://rutamina.com/api/proxy/provinces?languageId=es&countryId=2390234380600
Parameters:
| Parameter | Required | Use |
|---|---|---|
| languageId | yes | Language Identifier |
| countryId | yes | Country Identifier |
Available Cities
Gets the available cities of a province
Example: http://rutamina.com/api/proxy/cities?languageId=es&provinceId=2390234565610
Paramters:
| Parameter | Required | Use |
|---|---|---|
| languageId | yes | Language Identifier |
| provinceId | yes | Province Identifier |
Types of routes
Gets the type of route
Example: http://rutamina.com/api/proxy/types
Difficulties
Gets the difficulties
Example: http://rutamina.com/api/proxy/types
Search routes
Search for available routes
Example: http://rutamina.com/api/proxy/search?languageId=es&provinceId=2390234565610
Example: http://rutamina.com/api/proxy/search?languageId=es&query=New+York
Parameters:
| Parameter | Required | Use |
|---|---|---|
| languageId | yes | Language Identifier |
| countryId | no | Country Identifier |
| provinceId | no | Province Identifier |
| cityId | no | City Identifier |
| typeId | no | Route Type |
| difficultyId | no | Difficulty |
| query | no | Text search |
Get routes
Get a full route
Example: http://rutamina.com/api/proxy/get?languageId=es&id=2523174454950
Parameters:
| Parameter | Required | Use |
|---|---|---|
| languageId | yes | Language Identifier |
| id | yes | Route Identifier |
Login
Make a log on the application to obtain a user data
Example: http://rutamina.com/api/proxy/login?username=XXX&password=YYY
Parameters:
| Parameter | Required | Use |
|---|---|---|
| username | yes | Username |
| password | yes | Password |
User routes
Gets the user-created routes
Example: http://rutamina.com/api/proxy/userroutes?languageId=es&userId=ZZZ
Parameters:
| Parameter | Required | Use |
|---|---|---|
| languageId | yes | Language Identifier |
| userId | yes | User Identifier |
A user's favorite routes
Obtains a user's favorite routes
Example: http://rutamina.com/api/proxy/userfavorites?languageId=es&userId=ZZZ
Parameters:
| Parameter | Required | Use |
|---|---|---|
| languageId | yes | Language Identifier |
| userId | yes | User Identifier |
Register user
Add a new user in rutamina. This method should be invoked in POST mode
Example: http://rutamina.com/api/proxy/register
Parameters:
| Parameter | Required | Use |
|---|---|---|
| xml | yes | XML Format : <user> <name>Name</name> <email>aaaa@bbb.ccc</email> <username>xxxxx</username> <password>yyyyy</password> </user> |
