API
El API de rutamina permite obtener datos de nuestra base de datos de rutas, así cualquier aplicación podrá obtener, buscar y mostrar en sus propios mapas nuestras rutas
Documentación
A continuación se provee de la documentación de los servicios disponibles. Todas las invocaciones tienen que llevar el parámetro adicional 'app' que será la key proporcionada por el equipo de rutamina.
Si no dispones de una key, contacta con nosotros.
Idiomas disponibles
Obtiene los idiomas disponibles
Ejempmlo: http://rutamina.com/api/proxy/languages
Paises disponibles
Obtiene los paises disponibles
Ejemplo: http://rutamina.com/api/proxy/countries?languageId=es
Parámetros:
| Parámetro | Obligatorio | Uso |
|---|---|---|
| languageId | si | Identificador del idioma |
Provincias disponibles
Obtiene los provincias disponibles de un pais
Ejemplo: http://rutamina.com/api/proxy/provinces?languageId=es&countryId=2390234380600
Parámetros:
| Parámetro | Obligatorio | Uso |
|---|---|---|
| languageId | si | Identificador del idioma |
| countryId | si | Identificador del país |
Ciudades disponibles
Obtiene las ciudades disponibles de una provincia
Ejemplo: http://rutamina.com/api/proxy/cities?languageId=es&provinceId=2390234565610
Parámetros:
| Parámetro | Obligatorio | Uso |
|---|---|---|
| languageId | si | Identificador del idioma |
| provinceId | si | Identificador de la provincia |
Tipos de rutas
Obtiene los tipos de ruta
Ejemplo: http://rutamina.com/api/proxy/types
Dificuultades
Obtiene las dificultades
Ejemplo: http://rutamina.com/api/proxy/types
Buscar rutas
Busca rutas disponibles
Ejemplo: http://rutamina.com/api/proxy/search?languageId=es&provinceId=2390234565610
Ejemplo: http://rutamina.com/api/proxy/search?languageId=es&query=New+York
Parámetros:
| Parámetro | Obligatorio | Uso |
|---|---|---|
| languageId | si | Identificador del idioma |
| countryId | no | Identificador del país |
| provinceId | no | Identificador de la provincia |
| cityId | no | Identificador de la ciudad |
| typeId | no | Tipo de ruta |
| difficultyId | no | Dificultad |
| query | no | Texto de búsqueda |
Obtener ruta
Obtiene una ruta completa
Ejemplo: http://rutamina.com/api/proxy/get?languageId=es&id=2523174454950
Parámetros:
| Parámetro | Obligatorio | Uso |
|---|---|---|
| languageId | si | Identificador del idioma |
| id | si | Identificador de la ruta |
Login
Realiza un login sobre la aplicación para poder obtener los datos de un usuario
Ejemplo: http://rutamina.com/api/proxy/login?username=XXX&password=YYY
Parámetros:
| Parámetro | Obligatorio | Uso |
|---|---|---|
| username | si | Username |
| password | si | Password |
Rutas de un usuario
Obtiene las rutas creadas por un usuario
Ejemplo: http://rutamina.com/api/proxy/userroutes?languageId=es&userId=ZZZ
Parámetros:
| Parámetro | Obligatorio | Uso |
|---|---|---|
| languageId | si | Identificador del idioma |
| userId | si | Identificador del usuario |
Rutas favoritas de un usuario
Obtiene las rutas favoritas de un usuario
Ejemplo: http://rutamina.com/api/proxy/userfavorites?languageId=es&userId=ZZZ
Parámetros:
| Parámetro | Obligatorio | Uso |
|---|---|---|
| languageId | si | Identificador del idioma |
| userId | si | Identificador del usuario |
Registrar un usuario
Registra un nuevo usuario en rutamina. Éste método deberá invocarse en modo POST
Ejemplo: http://rutamina.com/api/proxy/register
Parámetros:
| Parámetro | Obligatorio | Uso |
|---|---|---|
| xml | si | Formato del XML: <user> <name>Nombre</name> <email>aaaa@bbb.ccc</email> <username>xxxxx</username> <password>yyyyy</password> </user> |
