Dirección Base URL

Para recuperar los POA disponibles, deberá utilizar las siguientes URI:

Base URL
https://siif.bosquesnativos.net.ar/ws

Patrones URI

                        /poa

                        /poa/{poa}

                        /poa.json

                        /poa.xml

Salida

La salida puede ser especificada concatenando .json o .xml al final del URI del recurso y antes de los diferentes tipos de parámetros para consultar. Si no se especifica, por defecto la salida es json.

Parámetros Adicionales

Los diferentes tipos de datos admitidos en las consultas se describen en la siguiente tabla:

Parametro Tipo	Descripción
Entero	El tipo esperado es un entero y admite valores >0. Al especificarse un único valor devolverá los registros que coincidan con el valor ingresado. En caso de ingresar 2 valores separados por el carácter \| devolverá los datos comprendidos entre ambos. EJ: ?anio=2016 ?anio=2016\|2018
Decimal	El tipo esperado es un decimal y admite valores >0 hasta con 2 decimales. Al especificarse un único valor devolverá los registros que coincidan con el valor ingresado. En caso de ingresar 2 valores separados por el carácter \| devolverá los datos comprendidos entre ambos. EJ: ?superficie=10.5 ?superficie=5.45\|12
Cadena	Cadena de texto alfanumérica con acentos y eñes, cuya longitud máxima por palabra es de 20 caracteres. Considera n términos separados por \| y la misma es excluyente. EJ: ?titulares=gomez ?titulares=gomez\|gutierrez\|perez
Fecha	Se trata de una máscara de fecha representada por una cadena "AAAA-MM-DD" o “AAAA” donde AAAA es un año de 4 dígitos, MM es el mes en 2 dígitos y DD es el día en 2 dígitos. Si se ingresa una única fecha la consulta devolverá los registros cuyo campo coincidan con dicha fecha. En caso de ingresar 2 fechas separadas por \| se devolverán los campos cuya fecha se encuentre comprendida entre ambos. EJ: ?fecha_acreditacion=2016-04-01 ?fecha_acreditacion=2016-04-01 \| 2018-08-30 ?fecha_acreditacion=20014\|2018

A continuación se muestra una lista de los parámetros de consulta que están disponibles para este patrón URI. Construir el servicio web a partir de la URL base y los patrones de URI anteriores, luego agregar estos parámetros después del signo de interrogación como separador de consulta (con cada par campo-valor separado por un signo ampersand).
Todos los parámetros son opcionales.

Parametro	Valores Permitidos	Descripción
cod	cadena	Deberá ser un valido ID de POA.
plan_cod	cadena	Deberá ser un valido ID de Plan.
anio	entero	Año del POA.
provincia	cadena	Provincia del POA.
departamento	cadena	Departamento del POA.
monto_adjudicado	decimal	Monto adjudicado.
tipo_plan	cadena	Tipo del Plan al que pertenece el POA.
estado	cadena	Estado del POA Valores permitidos: ingreso de datos, en revision, anulado, aprobado, adjudicado, en ejecucion, suspendido, concluido, judicializado, devuelto a ana
fecha_acreditacion	fecha	Fecha de acreditacion del monto.
titulares	cadena	Nombre de los titulares
titulares_cuit	cadena	CUIT de los titulares
tipo_beneficiario	cadena	Tipo de beneficiario
superficie	entero	Superficie en hectareas

También es posible adicionar parámetros independientemente del recurso que se está consultando, como los que se muestran a continuación:
Todos los parámetros son opcionales.

Parametro	Valores Permitidos	Descripción
ws_orden	cadena	Nombre del campo a partir del cual se realizará el ordenamiento. Se debe anteponer un simbolo + para un ordenamiento ascendente o - para uno descendente De no ingresar un simbolo de ordenamiento se toma por defecto ascendente. Ej: ws_orden=+anio,-cod
ws_regi	entero	Registro inicial a partir del cuál recuperar los datos. Por defecto 0, que se considera el registro inicial.
ws_regn	entero	Número total de regitros a recuperar. Por defecto 10 registros.
ws_cons	cadena	Tipo de consulta. Valores permitidos: l (Lista: Devuelve un subconjunto de los campos. Valor por defecto.) d (Detalle: Devuelve la totalidad de los campos del recurso)
ws_campos	cadena	Campos a recuperar separados por coma.

URI Ejemplos

Haga Click en los links siguientes para visualizar los resultados de ejemplo
desde cada consulta REST. Seleccione ambos, xml o json para ver cada formato
respectivamente. Copie la URL listada para usar como una referencia.

Encontrar POA en la provincia de Salta con planes que contienen el código "337" y cuyo monto adjudicado
se encuentre entre $40.000 y $100.000
https://siif.bosquesnativos.net.ar/ws/poa.json?provincia=salta&plan_cod=337&monto_adjudicado=40000|100000

Visualiza únicamente los POA de la provincia de Río Negro con algun titular de nombre Claudio y devuelve
la información detallada con la totalidad de los campos.
https://siif.bosquesnativos.net.ar/ws/poa.xml?provincia=río%20negro&titulares=claudio&ws_cons=d

Uso de la API - PHP

Para emplear la API desde PHP utilizamos la libreria cURL que permite conectarse y comunicarse con diferentes tipos de servidores y diferentes tipos de protocolos. cURL hace la petición por medio de HTTP, lo único que debemos hacer es ocuparnos de su resultado que es el valor $decoded->status. En caso de que sea distinto de 200, algo anduvo mal.

Ejemplo JSON

	                        //Iniciar sesión cURL
							$service_url = 'https://siif.bosquesnativos.net.ar/ws/poa.json';
							$curl = curl_init();
							//Establecer todas las opciones para la transferencia 
							curl_setopt($curl, CURLOPT_URL, $service_url);
							curl_setopt($curl, CURLOPT_TIMEOUT, 130);
							curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
							//Ejecutar la sesión
							$curl_response = curl_exec($curl); 
							
							if ($curl_response === false) {
							    $info = curl_getinfo($curl);
							    curl_close($curl);
							    die('Error ocurrido durante la ejecucion de curl. Informacion adicional: ' . var_export($info));
							}
							//Finalizar la sesión
							curl_close($curl);
							
							//Procesamos el JSON devuelto
							$decoded = json_decode($curl_response);
							if (isset($decoded->status) && $decoded->status != '200') {
							      die('Un error ha ocurrido: ' . $decoded->error . " - Mensaje: " . $decoded->message);
							}
							
							foreach($decoded->data as $entrada){
							      echo 'ID: ' . $entrada->id . " - COD: " . $entrada->cod . " - Provincia: " . $entrada->provincia . "<br/>";
							}

Ejemplo XML

	                        //Iniciar sesión cURL
							$service_url = 'https://siif.bosquesnativos.net.ar/ws/poa.xml';
							$curl = curl_init();
							//Establecer todas las opciones para la transferencia 
							curl_setopt($curl, CURLOPT_URL, $service_url);
							curl_setopt($curl, CURLOPT_TIMEOUT, 130);
							curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
							//Ejecutar la sesión
							$curl_response = curl_exec($curl); 
							
							if ($curl_response === false) {
							    $info = curl_getinfo($curl);
							    curl_close($curl);
							    die('Error ocurrido durante la ejecucion de curl. Informacion adicional: ' . var_export($info));
							}
							//Finalizar la sesión
							curl_close($curl);
							
							//Procesamos el XML devuelto
							$decoded = new SimpleXMLElement($curl_response);
							if (isset($decoded->status) && $decoded->status != '200') {
							      die('Un error ha ocurrido: ' . $decoded->error . " - Mensaje: " . $decoded->message);
							}	        
							foreach($decoded->data->table->row as $entrada){
							   echo 'ID: ' . $entrada->id . " - COD: " . $entrada->cod . " - Provincia: " . $entrada->provincia . "<br/>";
							}

Uso de la API - Jquery

Para emplear la API desde Jquery utilizamos el método $.ajax() para consumir el servicio. Si se tiene éxito se asignara el json recibido al objeto "ws". Luego lo único que debemos hacer es recorrer cada elemento del resultado y en este caso se incorporan al elemento div.ws.

Ejemplo JSON

                        <!DOCTYPE html>
                        <html>
                            <head>
                                <title>Web Services jQuery</title>
                                <script src="https://code.jquery.com/jquery-3.4.0.min.js"></script>
                                <script>
                                    $(document).ready(function() {
                                        $.ajax({
                                            url: "https://siif.bosquesnativos.net.ar/ws/poa.json"
                                        }).then(function(ws) {
                                            console.log(ws);
                                            jQuery.each(ws.data,function(index,item) {
                                                console.log(item.id);
                                                $('.ws').append('<p>El COD es '+item.cod+'</p>');
                                                $('.ws').append('<p>La provincia es '+item.provincia+'</p><hr/>');
                                            });
                                        });
                                    });
                                </script>
                            </head>

                            <body>
                                <div class="ws"></div>
                            </body>
                        </html>

Solución de Problemas

Si usted está teniendo problemas de recuperación de datos, compruebe lo siguiente:

Revise el código, prestando especial atención a los errores tipográficos.
Pruebe la URL completa en un navegador web para chequear si se están consiguiendo los resultados esperados.