Documentación del API

1. Patagonia por descubrir API

La función de nuestra API es la de entregar informacion en modo de articulos, como los que se presentan en el sistio web www.patagoniapordescubrir.com, es decir es posible obtener los datos que contienen los articulos y otros recursos que lo componene como videos, imagenes, rutas desde Wikiloc y más.

Para poder obtener dicha información mediante nuestra API es necesario contar con una llave de seguridad denominadad API KEY que estara ligada a la IP de servidor de donde se estan realzando las peticiones, es decir, si para un sistema que funciona en 2 servidores es necesario pedir 2 API KEY, una para cada servidor.

El API es cerrada, es decir que no existe un formulario de pedido automatico de API KEY's, solo es posible obtenerla mediante el pedido directamente con el administrador del sistema, el que enviara posteriormente el API KEY por el medio que el convenga.

Toda la información entregada a travez del API esta bajo los Terminos y Condiciones de Patagonia por Descubrir y no se autoriza la utilización de los recursos o información fuera de dichos parametros.

Por ultimo cabe mencionar que se estarám desarrollando mas metodos para la utilización de nuestra API.

2. Aplicaciones

Los resultados de la peticiones al API se entegan en formato JSON, donde es posible obtener dos tipos de datos o la mezcla de ellos, los que son JSONObject y JSONArray.

JSON es uno de los formatos de comunicacione entre sistemas mas utilizados hoy en dia y es perfecto para la utilizacion en Aplicaciones moviles tanto para Android como pa iOS, por otra parte tambien puede ser utilizado en Sistema Web o Sitios Web los que quieran enriquecer sus contenidos que muestran a su publico objetivo.

3. API KEY

Para obtener la API KEY es necesario contactar a la Doctora Trace Gale del CIEP a los siguientes contactos Email: tracegale@ciep.cl, Teléfono: +56 (67) 2244516 o acudir directamente a las oficinas en Avda. Simpson 471, Región de Aysén, Coyhaique, Chile. Quien entrega la llave solicita por el medio que se convenga.

Cuando se realice una petición al API es necesario enviar el API KEY en los headers del request, enviando el key como api_key y como value el string de 40 carecteres $2y$10$pgwxcFReHs9Gd86rja4.ne.AlA3YIr5Ke4xrvX12tGwBlPS19UOK.

Para realizar pruebas recomendamos la aplicacion para Google Chrome Postman. Con esta herramienta podrán ejecutar pruebas hasta llegar a los request que se necesitan para su desarrollo.

4. Obtener una lista de articulos

  • URL
    URL de solicitud

    GET: http://www.patagoniapordescubrir.com/ppd-get-articles/list/{params}

    El ultimo parametro de la URL {params} es requerido, de lo contrario la respuesta a la petición sera un código error 404, pero podra ser enviado vacio lo que traera la información por defecto de la lista de ariculos.

    GET: http://www.patagoniapordescubrir.com/ppd-get-articles/list/{}

    Por defecto se entrega una lista de minimo 25 articulos y cada uno contiene el identificador, geolocalización, zona, actitividad e interes al que pertenece, titulo, bajada, imagen principal y la url del articulo en www.patagoniapordescubrir.com

    Esta URL retorna un valor del tipo JSONArray

  • Parametros
    Parametros y opciones

    La URL acepta opciones en formato de objeto en el ultimo parametro de la URL, los que permiten agregar y filtrar los contenidos por las Zonas, Actividades e Intereses en la que los articulos fueron clasificados en www.patagoniapordescubrir.com, por lo que con una sola petición es posible obtener informacion bastante acotada, pudiendo no ser necesario generar otra petición optimizando el desarrollo.

    Es necesario tener en cuenta que a mayor cantidad de articulos que el API entregue, más sera el tiempo de respuesta de una petición, por lo que es altamente recomendable utilizar los filtros y cantidades necesarias para obtener justo lo deseado y acelerar la experiencia al usuario final

    GET: http://www.patagoniapordescubrir.com/ppd-get-articles/list/{"zona":"2,3","cantidad":"100","opciones":{"galeria":true,"tips":true}}

    Parametro : Valores posibles
    • zona: 1,2,3,4,5,6,7 (String)
    • actividad: 1,2,3,4,5,6 (String)
    • interes: 1,2,3,4,5,6 (String)
    • cantidad: 1 - 99999 (Integer)
    • opciones: {} (Object)

    Opción : Valores posibles - Default
    • relato: true|false (Boolean) - default: false - retorna (String)
    • galeria: true|false (Boolean) - default: false - retorna (JSONArray)
    • tips: true|false (Boolean) - default: false - retorna (JSONArray)
    • video: true|false (Boolean) - default: false - retorna (JSONArray)
    • ficha: true|false (Boolean) - default: false - retorna (JSONArray)
    • wikiloc: true|false (Boolean) - default: false - retorna (JSONArray)
    • recetas: true|false (Boolean) - default: false - retorna (JSONArray)
    • res_imagen_principal: 120|640|480|640|1280|1440 (integer) - default: 640 - retorna (String)
    • res_galeria: 120|640|480|640|1280|1440 (integer) - default: 640 - retorna (String)


  • Detalle Parametros
    Significados de los diferentes parametros

    Conoce cada parametro y opción que puedes utilizar en tus peticiones, ademas saber el comportamiento de cada una y en que modo retornan los valores.

    Zonas

    Es la categorización de los distintios articulos por una zona geografica definida por Patagonia por Descubrir y existen 7 las que que tienen los siguientes identificadores numericos de tipo Integer:

    • 1: Información de Aysén
    • 2: Zona Palena - Queulat
    • 3: Zona Fiordos - Canales
    • 4: Zona Aysén - Simpson
    • 5: Zona Chelenco
    • 6: Zona Baker - O'Higgins
    • 7: Zona Argentina

    Puede ser enviado de la siguiente forma: zona: "1,2,3,4,5,6,7", pero de no ser requerido puede no enviarse o dejarlo con un valor false de la siguiente manera: zona: false

    Actividades

    Al igual que la zonas existe otra categorización de los articulos y es definida por las actividades y tienen los siguientes identificadores del tipo Integer

    • 1: Informarse & prepararse
    • 2: Comer & Beber
    • 3: Actividades & aventuras
    • 4: Descansar & relajarse
    • 5: Arte & cultura
    • 6: Aprender & ayudar

    Puede ser enviado de la siguiente forma: actividad: "1,2,3,4,5,6", pero de no ser requerido no es necesario su envio o puede dejarse con un valor false de la siguiente manera: actividad: false

    Intereses

    Los Intereses son categorias a las que los articulos estan sometidos y en total son 6 diferentes interes representados por un identificador del tipo Integer

    • 1: Binacional
    • 2: Turismo Independiente
    • 3: Turismo Gastronómico
    • 4: Turismo Marinero
    • 5: Turismo Científico
    • 6: Turismo de Pesca Recreativa

    El envio de estos datos puede ejecutarse de la siguiente manera: interes: "1,2,3,4,5,6", pero de no ser necesario puede dejarse en false o simplemente no enviarse interes: false

    Opciones

    Existen variadas opciones que pueden ser enviadas para incluir ciertos datos o excluirlos de ser necesarios, por defecto la API entrega el Titulo, Bajada, Geolocalización, Zona, Actividad, Interes, Imagen principal y la URL del articulo en www.patagoniapordescubrir.com

    • relato : Si es true devuelve el Texto del articulo
    • galeria : Si es true devuelve la Galeria Fotografica del articulo
    • tips : Si es true devuelve los Tips Viajeros correspondientes al articulo
    • video : Si es true devuelve los Videos relaciondos a dicho articulo
    • ficha : Si es true devuelve la Ficha Tecnica del articulo
    • wikiloc : Si es true devuelve las rutas de Wikiloc
    • res_imagen_principal : Si es establecido devuelve la imagen principal de todos los articulos en dicha resolucion
    • res_galeria : Si es establecido devuelve la resulicion para las galerias de imagenes de los articulos

    Observaciones

    Al momento de crear el objeto que contendra los parametro y opciones hay que tener en cuante qeu al enviar solo una zona, actividad o interes puede enviarse como entero Integer, pero se quire obtener articulos de mas de una zona debe enviarse como String "1,3,5,6".

    Tambien cabe mencionar que las Zonas, Actividades e Intereses no son exclyentes, es posible obtener articulos simultaneamente especificando una o varias zonas, actividades y/o intereses.

  • Ejemplo
    Ejemplo de uso

    Aqui veras todos los parametros que conforman el objeto que se debe enviar para una petición correcta al API:

    var params =
    {
       zona: "1,2,5",
       actividad: 6,
       interes: false,
       cantidad: 30,
       opciones: {
          relato:true,
          galeria:true,
          tips:true,
          video":true,
          ficha:true,
          wikiloc:true,
          res_imagen_principal": 1280,
          res_galeria: 640
       }
    }


    Ejemplo utilizado Ajax de jQuery

    $.ajax({
       url: 'http://www.patagoniapordescubrir.com/ppd-get-articles/list/' + params,
       headers: {
          'api_key':'xxxxxxxxxxxxx',
          'Content-Type':'application/json'
       },
       method: 'GET',
       dataType: 'json',
       success: function(data){
          console.log('succes: ' + data);
       }
    });

    Ejemplo utilizado $http de Angular js utilizado para crear aplicaciones moviles con Ionic Framework

    $http({
       method: 'GET',
       url: 'http://www.patagoniapordescubrir.com/ppd-get-articles/list/' + params,
       header : {
          'api_key':'xxxxxxxxxxxxx',
          'Content-Transfer-Encoding' : 'application/json; charset=UTF-8'
       }
       }).then(function successCallback(response) {
          console.log('Success');
       }, function errorCallback(response) {
          console.log('Error');
    });

5. Obtener un articulo

  • URL
    URL de solicitud

    GET: http://patagoniapordescubrir.com/ppd-get-articles/single/{params}

    El ultimo parametro de la URL {params} es requerido, de lo contrario la respuesta a la petición sera un código error 404, pero podra ser enviado vacio lo que traera la información por defecto de la lista de ariculos.

    GET: http://www.patagoniapordescubrir.com/ppd-get-articles/single/{}

    Esta URL no acepta Zonas, Actividades ni Intereses

    Esta URL retorna un valor del tipo JSONObject

  • Parametros
    Parametros y opciones

    Es posible la obtencion de información correspondiena un articulo en singular, pero de igual manera acepta las opciones para poder filtrar los datos que desamos obtener.

    GET: http://patagoniapordescubrir.com/ppd-get-articles/single/{"id":33,"idioma":"es","opciones":{"relato":true,"galeria":true,"tips":true}}

    Parametro : Valores posibles
    • id: 1 (Integer)
    • idioma: "es" (String)
    • opciones: {} (Object)

    Opción : Valores posibles - Default
    • relato: true|false (Boolean) - default: false - retorna (String)
    • galeria: true|false (Boolean) - default: false - retorna (JSONArray)
    • tips: true|false (Boolean) - default: false - retorna (JSONArray)
    • video: true|false (Boolean) - default: false - retorna (JSONArray)
    • ficha: true|false (Boolean) - default: false - retorna (JSONArray)
    • wikiloc: true|false (Boolean) - default: false - retorna (JSONArray)
    • recetas: true|false (Boolean) - default: false - retorna (JSONArray)
    • res_imagen_principal: 120|640|480|640|1280|1440 (integer) - default: 640 - retorna (String)
    • res_galeria: 120|640|480|640|1280|1440 (integer) - default: 640 - retorna (String)


  • Detalle Parametros
    Significados de los diferentes parametros

    Conoce cada parametro y opción que puedes utilizar en tus peticiones, ademas saber el comportamiento de cada una y en que modo retornan los valores.

    • id : Identificador numerico del articulo
    • idioma : idioma en que se quiere la información (es|en disponibles)

    Opciones

    Existen variadas opciones que pueden ser enviadas para incluir ciertos datos o excluirlos de ser necesarios, por defecto la API entrega el Titulo, Bajada, Geolocalización, Zona, Actividad, Interes, Imagen principal y la URL del articulo en www.patagoniapordescubrir.com

    • relato : Si es true devuelve el Texto del articulo
    • galeria : Si es true devuelve la Galeria Fotografica del articulo
    • tips : Si es true devuelve los Tips Viajeros correspondientes al articulo
    • video : Si es true devuelve los Videos relaciondos a dicho articulo
    • ficha : Si es true devuelve la Ficha Tecnica del articulo
    • wikiloc : Si es true devuelve las rutas de Wikiloc
    • res_imagen_principal : Si es establecido devuelve la imagen principal de todos los articulos en dicha resolucion
    • res_galeria : Si es establecido devuelve la resulicion para las galerias de imagenes de los articulos
  • Ejemplo
    Ejemplo de uso

    Aqui veras todos los parametros que conforman el objeto que se debe enviar para una petición correcta al API:

    var params =
    {
       id: 334,
       idioma: "es",
       opciones: {
          relato:true,
          galeria:true,
          tips:true,
          video":true,
          ficha:true,
          wikiloc:true,
          res_imagen_principal": 1280,
          res_galeria: 640
       }
    }


    Ejemplo utilizado Ajax de jQuery

    $.ajax({
       url: 'http://www.patagoniapordescubrir.com/ppd-get-articles/single/' + params,
       headers: {
          'api_key':'xxxxxxxxxxxxx',
          'Content-Type':'application/json'
       },
       method: 'GET',
       dataType: 'json',
       success: function(data){
          console.log('succes: ' + data);
       }
    });

    Ejemplo utilizado $http de Angular js utilizado para crear aplicaciones moviles con Ionic Framework

    $http({
       method: 'GET',
       url: 'http://www.patagoniapordescubrir.com/ppd-get-articles/single/' + params,
       header : {
          'api_key':'xxxxxxxxxxxxx',
          'Content-Transfer-Encoding' : 'application/json; charset=UTF-8'
       }
       }).then(function successCallback(response) {
          console.log('Success');
       }, function errorCallback(response) {
          console.log('Error');
    });