API Pólenes

Esta versión está oficialmente menospreciada y dejará de estar disponible a partir del 15 de agosto de 2021.

Introducción

La API Pólenes provee información sobre la cantidad de granos por m3 de aire presente de árboles, gramíneas y hierbas en la ciudad de Bahía Blanca, Provincia de Buenos Aires, Argentina.

Además de esto, categoriza los resultados en tres niveles: bajo, moderado y alto. De esta forma, los resultados son más fácilmente interpretados por el público general.


Todas las entradas

Para poder leer todas las entradas disponibles en la base de datos, realice la siguiente petición:

GET /v1/polen/leer/todas

Datos retornados

Clave Tipo Valor
categorias JSON Object

El límite máximo de cada categoría (bajo y medio).

La unidad de medida utilizada es granos por m3 de aire.

Float
categorias.arboles.bajo
Float
categorias.arboles.medio
Float
categorias.gramineas.bajo
Float
categorias.gramineas.medio
Float
categorias.hierbas.bajo
Float
categorias.hierbas.medio
Cualquier valor mayor al límite medio se considera alto y se extiende hasta MAXINT.
error Boolean

Propiedad que determina si hubieron errores o no.

true
si existe un error o no se encontraron las entradas
false
si no hubo errores
Importante: se retornará un estado HTTP 200 tanto en true como en false. Si no se encontraran entradas, se retornará un mensaje con un estado HTTP 404.
datos JSON Array

Arreglo de objetos JSON que contiene la información de cada entrada.

Cada entrada contiene las siguientes propiedades:

Float
arboles
Float
gramineas
Float
hierbas
String
fecha
String null
observaciones
mensaje String Un mensaje detallando el error encontrado.
No se requiere clave privada ya que es una API pública.

Esta petición producirá una salida parecida a la siguiente:

        
    {
        "error": false,
        "categorias": {
            "arboles": {
                "bajo": 14,
                "medio": 89
            },
            "gramineas": {
                "bajo": 4,
                "medio": 19
            },
            "hierbas": {
                "bajo": 9,
                "medio": 49
            }
        },
        "datos": [
            {
                "arboles": 48,
                "gramineas": 1,
                "hierbas": 5,
                "fecha": "2018-08-24"
                "observaciones": null
            },
            {
                "arboles": 178,
                "gramineas": 3,
                "hierbas": 17,
                "fecha": "2018-09-14"
                "observaciones": "Se le recomienda a las personas alérgicas a permanecer en sus hogares."
            },
            {
                "arboles": 76,
                "gramineas": 0,
                "hierbas": 3,
                "fecha": "2018-09-17"
                "observaciones": null
            }
        ]
    }
        
    

Un ejemplo de error producirá una salida parecida a la siguiente:

        
    {
        "error": true,
        "mensaje": "No se pudieron leer todas las entradas."
    }
        
    

Última entrada

Para poder leer la entrada más reciente de la base de datos, realice la siguiente petición:

GET /v1/polen/leer/ultima

Datos retornados

Clave Tipo Valor
categorias JSON Object

El límite máximo de cada categoría (bajo y medio).

La unidad de medida utilizada es granos por m3 de aire.

Float
categorias.arboles.bajo
Float
categorias.arboles.medio
Float
categorias.gramineas.bajo
Float
categorias.gramineas.medio
Float
categorias.hierbas.bajo
Float
categorias.hierbas.medio
Cualquier valor mayor al límite medio se considera alto y se extiende hasta MAXINT.
error Boolean

Propiedad que determina si hubieron errores o no.

true
si existe un error o no se encontraron las entradas
false
si no hubo errores
Importante: se retornará un estado HTTP 200 tanto en true como en false. Si no se encontraran entradas, se retornará un mensaje con un estado HTTP 404.
datos JSON Array

Arreglo de objetos JSON que contiene la información de cada entrada.

Cada entrada contiene las siguientes propiedades:

Float
arboles
Float
gramineas
Float
hierbas
String
fecha
String null
observaciones
mensaje String Un mensaje detallando el error encontrado.
No se requiere clave privada ya que es una API pública.

Esta petición producirá una salida parecida a la siguiente:

        
    {
        "error": false,
        "categorias": {
            "arboles": {
                "bajo": 14,
                "medio": 89
            },
            "gramineas": {
                "bajo": 4,
                "medio": 19
            },
            "hierbas": {
                "bajo": 9,
                "medio": 49
            }
        },
        "datos": [
            {
                "arboles": 76,
                "gramineas": 0,
                "hierbas": 3,
                "fecha": "2018-09-17"
                "observaciones": null
            }
        ]
    }
        
    

Un ejemplo de error producirá una salida parecida a la siguiente:

        
    {
        "error": true,
        "mensaje": "No se pudo leer la última entrada."
    }
        
    

Buscar entrada

Para poder buscar una entrada específica en la base de datos, realice la siguiente petición:

POST /v1/polen/buscar

Datos a enviar

Clave Tipo Valor
fecha String La fecha correspondiente a la entrada en formato Y-m-d. Ver documentación en PHP.net.

Datos retornados

Clave Tipo Valor
categorias JSON Object

El límite máximo de cada categoría (bajo y medio).

La unidad de medida utilizada es granos por m3 de aire.

Float
categorias.arboles.bajo
Float
categorias.arboles.medio
Float
categorias.gramineas.bajo
Float
categorias.gramineas.medio
Float
categorias.hierbas.bajo
Float
categorias.hierbas.medio
Cualquier valor mayor al límite medio se considera alto y se extiende hasta MAXINT.
error Boolean

Propiedad que determina si hubieron errores o no.

true
si existe un error o no se encontraron las entradas
false
si no hubo errores
Importante: se retornará un estado HTTP 200 tanto en true como en false. Si no se encontraran entradas, se retornará un mensaje con un estado HTTP 404.
datos JSON Array

Arreglo de objetos JSON que contiene la información de cada entrada.

Cada entrada contiene las siguientes propiedades:

Float
arboles
Float
gramineas
Float
hierbas
String
fecha
String null
observaciones
mensaje String Un mensaje detallando el error encontrado.
No se requiere clave privada ya que es una API pública.

Esta petición, con "fecha": "2018-09-17", producirá una salida parecida a la siguiente:

        
    {
        "error": false,
        "categorias": {
            "arboles": {
                "bajo": 14,
                "medio": 89
            },
            "gramineas": {
                "bajo": 4,
                "medio": 19
            },
            "hierbas": {
                "bajo": 9,
                "medio": 49
            }
        },
        "datos": [
            {
                "arboles": 76,
                "gramineas": 0,
                "hierbas": 3,
                "fecha": "2018-09-17"
                "observaciones": null
            }
        ]
    }
        
    

Un ejemplo de error producirá una salida parecida a la siguiente:

        
    {
        "error": true,
        "mensaje": "No se pudo leer la entrada buscada."
    }
        
    
25 de Mayo 44
B8000JRB, Bahía Blanca
Prov. de Buenos Aires
Argentina

+54 291 455-4547 / 452-2696

Documentacion · Soporte
2021 © Instituto de Alergia e Inmunología del Sur