Estás en: quieropilotar » Documentación API

Documentación de la API

Introducción

Empezamos con una API básica que iremos ampliando a lo largo del tiempo, incluyendo más prestaciones e información.

Para empezar a utilizar el servicio, necesitas una API key personalizada para usar en tu propio sitio web.

Ésta API key sólo será válida cuando sea utilizada desde el sitio web para el que haya sido generada.

Formatos

Nuestra API utiliza el formato RESTful para cada consulta, y necesita ciertos parámetros, un api_key, un method y un parámetro extra que depende del method elegido.

El formato de respuesta es en formato XML por defecto, aunque se puede solicitar JSON como formato de salida para los datos.

Ejemplo de consulta

http://www.quieropilotar.com//index.php/api/request?api_key=XXXX&method=user.getInfo&user=albertoGS500&format=xml

Las consultas devolverán un resultado en formato XML o JSON, XML por defecto.

El campo status indica si la consulta fue válida. En caso de error, consulta la sección Códigos de ERROR.

El campo results indica el número de resultados obtenidos en la consulta.

Para obtener un grupo menor de resultados, utiliza el parámetro opcional limit.

Ejemplo de una respuesta CORRECTA en formato XML

Ejemplo de una respuesta FALLIDA en formato JSON

http://www.quieropilotar.com//index.php/api/request?api_key=XXXX&method=user.getInfo&user=&format=json

[
{
  "status": "error",
  "errors": {    
    "error_code": 4,    
    "error_desc": "Unknown USER or not specified"    }
}
]

Normas de utilización del servicio web (API)

Antes de empezar, deberías conocer las siguientes normas:

No debes alterar la información que te proveemos mediante el servicio web, incluyendo fotografías, descripciones, precios, logos y cualquier otra información que obtengas a través del servicio web.
No debes cambiar los enlaces que proveemos.
Debes indicar que la información utilizada proviene de quieropilotar.com adjuntando un enlace a nuestro sitio web (http://www.quieropilotar.com/).
No puedes vender nuestra api a terceras partes.
El uso de nuestra api es gratuito. Deberás solicitar autorización expresa de quieropilotar.com para que puedas utilizarla con fines comerciales.
Entiendes y aceptas que quieropilotar.com pueda imponer o ajustar un límite de transacciones mensual que puedes enviar a través del servicio.
El incumplimiento de las Normas de utilización del servicio web (API) o el abuso del servicio puede hacer que quieropilotar.com bloquee tus consultas al servicio web.

Obtener una API key

Para usar el servicio web necesitas solicitar una API key.

Métodos

user

user.getInfo

Devuelve información sobre un usuario en concreto.

Parámetros necesarios

user: El nombre del usuario

Parámetros opcionales

format: Especifica el formato de la respuesta: XML o JSON. Por defecto, se utiliza XML.

Ejemplo de consulta

/api/request?api_key=XXXX&method=user.getInfo&user=albertoGS500&format=xml

Ejemplo de respuesta

user.getAlerts

Devuelve información sobre las alertas que tiene activas el usuario.

Parámetros necesarios

user: El nombre del usuario

Parámetros opcionales

format: Especifica el formato de la respuesta: XML o JSON. Por defecto, se utiliza XML.

limit: Número de registros que deseas recibir.

Ejemplo de consulta

/api/request?api_key=XXXX&method=user.getAlerts&user=albertoGS500&format=xml&limit=2

Ejemplo de respuesta

organizer

organizer.getEvents

Devuelve información sobre los eventos futuros que realiza el organizador.

Parámetros necesarios

organizer: El nombre del organizador

Parámetros opcionales

format: Especifica el formato de la respuesta: XML o JSON. Por defecto, se utiliza XML.

limit: Número de registros que deseas recibir.

Ejemplo de consulta

/api/request?api_key=XXXX&method=organizer.getEvents&organizer=Motor+Extremo&format=xml&limit=2

Ejemplo de respuesta

organizer.getInfo

Devuelve información sobre el organizador.

Parámetros necesarios

organizer: El nombre del organizador

Parámetros opcionales

format: Especifica el formato de la respuesta: XML o JSON. Por defecto, se utiliza XML.

Ejemplo de consulta

/api/request?api_key=XXXX&method=organizer.getInfo&organizer=Motor+Extremo&format=xml

Ejemplo de respuesta

organizer.getList

Devuelve un listado de organizadores.

Parámetros necesarios

N/A

Parámetros opcionales

format: Especifica el formato de la respuesta: XML o JSON. Por defecto, se utiliza XML.

Ejemplo de consulta

/api/request?api_key=XXXX&method=organizer.getList&format=xml

Ejemplo de respuesta

city

city.getEvents

Devuelve información sobre los eventos futuros que se celebrarán en una ciudad.

Parámetros necesarios

city: El nombre de la ciudad

Parámetros opcionales

format: Especifica el formato de la respuesta: XML o JSON. Por defecto, se utiliza XML.

limit: Número de registros que deseas recibir.

Ejemplo de consulta

/api/request?api_key=XXXX&method=city.getEvents&city=Almer%C3%ADa&format=xml&limit=2

Ejemplo de respuesta

city.getList

Devuelve un listado de ciudades donde se realizan actividades de motor.

Parámetros necesarios

N/A

Parámetros opcionales

format: Especifica el formato de la respuesta: XML o JSON. Por defecto, se utiliza XML.

Ejemplo de consulta

/api/request?api_key=XXXX&method=city.getList&format=xml

Ejemplo de respuesta

date

date.getEvents

Devuelve información sobre los eventos que tendrán lugar en fechas futuras o entre un rango de fechas especificado.

Parámetros necesarios

N/A

Parámetros opcionales

date_from: Fecha desde la cual obtener los eventos.

date_to: Fecha hasta la cual obtener los eventos.

format: Especifica el formato de la respuesta: XML o JSON. Por defecto, se utiliza XML.

limit: Número de registros que deseas recibir.

Ejemplo de consulta

/api/request?api_key=XXXX&method=date.getEvents&date_from=18-06-2012&date_to=18-08-2012&format=xml&limit=2

Ejemplo de respuesta

track

track.getEvents

Devuelve información sobre los eventos futuros que se realizarán en un circuito.

Parámetros necesarios

track: El nombre del circuito

Parámetros opcionales

format: Especifica el formato de la respuesta: XML o JSON. Por defecto, se utiliza XML.

limit: Número de registros que deseas recibir.

Ejemplo de consulta

/api/request?api_key=XXXX&method=track.getEvents&track=Circuito+de+Jerez&format=xml&limit=2

Ejemplo de respuesta

track.getInfo

Devuelve información sobre un circuito.

Parámetros necesarios

track: El nombre del circuito

Parámetros opcionales

format: Especifica el formato de la respuesta: XML o JSON. Por defecto, se utiliza XML.

Ejemplo de consulta

/api/request?api_key=XXXX&method=track.getInfo&track=Circuito+de+Jerez&format=xml

Ejemplo de respuesta

track.getList

Devuelve un listado de circuitos.

Parámetros necesarios

N/A

Parámetros opcionales

format: Especifica el formato de la respuesta: XML o JSON. Por defecto, se utiliza XML.

Ejemplo de consulta

/api/request?api_key=XXXX&method=track.getList&format=xml

Ejemplo de respuesta

event

event.getInfo

Devuelve información sobre un evento.

Parámetros necesarios

event: El IDentificador de un evento

Parámetros opcionales

format: Especifica el formato de la respuesta: XML o JSON. Por defecto, se utiliza XML.

Ejemplo de consulta

/api/request?api_key=XXXX&method=event.getInfo&event=550&format=xml

Ejemplo de respuesta

event.getList

Devuelve un listado de las n próximas actividades de motor.

Parámetros necesarios

limit: Número de registros que deseas recibir.

Parámetros opcionales

format: Especifica el formato de la respuesta: XML o JSON. Por defecto, se utiliza XML.

Ejemplo de consulta

/api/request?api_key=XXXX&method=event.getList&limit=2&format=xml

Ejemplo de respuesta

Códigos de ERROR

1: Invalid API key.
2: API key is over the quota limit
3: Request is missing parameters, like making a user.getEvents request without specifying a pilot
4: Unknown USER or not specified
5: Unknown TRACK or not specified
5: Can't find TRACKS
6: Unknown ORGANIZER or not specified
6: Can't find ORGANIZERS
7: Unknown CITY or not specified
7: Can't find CITIES
8: Unknown DATE or not specified
8: Incorrect DATE TO
8: Incorrect DATE FROM
8: Incorrect dates. DATE_FROM must be a date BEFORE the DATE_TO
8: Can't find EVENTS
9: Unknown EVENT or not specified
10: Unknown FORMAT
11: Unknown METHOD or not specified