Developers

Cómo consumir un métdo con la API REST

Para consumir cualquier método de la API REST de OcioAvila hay que realizar una petición HTTP a la URL

http://ocioavila.com/api/v1

seguido del método elegido. Por ejemplo para obtener la agenda para hoy tendríamos que hacer una petición a

http://ocioavila.com/api/v1/calendar.

Si el método requiere autenticación mediante AccessToken deberemos añadir el parametro ?access_token=<AccessToken>. En nuestro ejemplo, la URL quedaría así:

http://ocioavila.com/api/v1/calendar?access_token=<AccessToken>

 

Cómo obtener el AccessToken

Existen varias formas de obtener un AccessToken:

1) Si la App dispone de permisos OAuth, se debe realizar una petición al método GET oauth/app añadiendo los parámetros ConsumerKey y ConsumerToken que se generan al crear una aplicación. Así al realizar la petición:

http://ocioavila.com/api/v1/oauth/app?consumer_key=<ConsumerKey>&consumer_token=<ConsumerToken>

Si los datos son válidos nos devolverá en formato JSON el AccessToken con validez para un par de horas, entendiendo como usuario de dicha petición al creador de la aplicación.

 

2) La App no dispone de permisos OAuth, por tanto el usuario que creó la aplicación es el que interactúa con la API. Se debe realizar una petición al método GET oauth/getaccesstoken añadiendo los parámetros ConsumerKey y ConsumerToken que se generan al crear una aplicación. Así al realizar la petición:

http://ocioavila.com/api/v1/oauth/getaccesstoken?consumer_key=<ConsumerKey>&consumer_token=<ConsumerToken>

Si los datos son válidos se devuelve el AccessToken con validez para un par de horas, en caso contrario, se muestra el error detallado.

 

3) Utilizando un AccessToken Extendido, que se obtiene solicitándolo desde el apartado "Mis aplicaciones" del Área de Desarrolladores y que tiene una validez de 60 días.

Recordamos que la vida de los AccessToken se reinicia cada vez que son usados. Así, después de cada petición a la que se le añada un AccessToken reiniciará su cuenta atrás de nuevo, disponiendo de otras dos horas o 60 días para que expire.

Puedes encontrar más información sobre el funcionamiento de los AccessToken en el apartado OAuth de la web.

Importante

Los textos entre los simbolos < y > marcados en color azul son variables y deben ser sustituidos por el valor requerido en cada petición.