API Data
Infoscod ofrece una potente API de datos en tiempo real para descargar los datos correspondientes a una serie de datos de tu interés. Los resultados se entregan en milisegundos en formato JSON. Al utilizar la API Data, podrás obtener los datos de las series de tu interés y utilizarlas en consecuencia.
Esta documentación describe en detalle las características de API Data, las opciones disponibles y las guías de integración en diferentes lenguajes de programación.
Consejo! Si quieres obtener el mejor resultado en el uso de las APIs consulta esta guía que te ayudará a comprender cómo funciona Infoscod.
Antes de empezar
Para obtener acceso a las APIs de Infoscod, es necesario disponer de una Clave de acceso API (API Access Key), que es la clave de autenticación única utilizada para obtener acceso a las APIs de Infoscod.
Todos los usuarios registrados en Infoscod disponen de una API Access Key. Consulta aquí cúal es tu Clave de acceso API o regístrate aquí para obtenerla.
Cómo usar API Data
El uso de API Data de Infoscod es simple. No hay más que añadir los Parámetros de consulta a la URL base de la API.
URL Base:
https://infoscod.es/apis/api_data.php
Agrega tu clave de acceso a la API y el código de la serie de datos que quieres obtener: Este es un ejemplo de llamada a la API que ilustra cómo autenticarse con la Clave de acceso API y obtener los datos de exportaciones mensuales de España para el año 2017:
https://infoscod.es/apis/api_data.php ? access_key = YOUR_ACCESS_KEY &table = bds_500000 &aaaa = 2017 Run API Request
Respuesta API
API Data entrega datos en formato JSON. Este es el resultado de la API que Infoscod devolvería en respuesta a la llamada a la API
que se muestra en la sección anterior, que consulta la API para obtener los datos de exportaciones mensuales de España bds_500000 para el año 2017.
{"2017 1":"21440076.544000","2017 2":"22075630.876000","2017 3":"26225818.428000","2017 4":"21796212.378000","2017 5":"25359083.706000","2017 6":"23978634.052000","2017 7":"22189031.161000","2017 8":"19237660.907000","2017 9":"23257499.333000","2017 10":"24240876.738000","2017 11":"25354529.395000","2017 12":"21970682.428000"}
Conexión vía HTTPS
Las conexiones a las APIs de Infoscod vienen con soporte para cifrado SSL de 256 bits a través de conexión https.
Códigos de error
Cuando un recurso solicitado no está disponible o una llamada a la API falla por otro motivo, se devuelve un error JSON. Los errores siempre vienen con un código de error y una descripción.
Ejemplo de Error: Se devuelve el siguiente error cuando no se ha proporcionado una Clave de acceso API correcta.
"error": {
"code": 101,
"type": "invalid_access_key",
"info": "No se ha proporcionado una clave de acceso de API válida."
}
Otros errores:
| Código | Tipo | Info |
|---|---|---|
404 |
404_not_found |
El recurso solicitado no existe. |
101 |
missing_access_key |
No se ha proporcionado la clave de acceso de API. |
101 |
invalid_access_key |
No se ha proporcionado una clave de acceso de API válida. |
102 |
inactive_user |
La cuenta de usuario actual no está activa. |
103 |
invalid_api_data |
El recurso solicitado (serie de datos) no existe. |
103 |
no_data |
No existen registros con los parámetros especificados. |
104 |
usage_limit_reached |
Se ha alcanzado la cantidad máxima permitida de solicitudes de API mensuales. |
Parámetros de consulta
API Data permite configurar los parámetros de llamada para ajustar el resultado que se desea obtener en función de las necesidades de cada usuario
Parámetros de la solicitud:
| Parámetro | Descripción |
|---|---|
access_key |
[Requerido] Tu clave de acceso de API. |
table |
[Requerido] Código de la serie de datos de la que desea obtener los datos. Puedes localizar aquí las series de datos de tu interés. Utiliza  para configurar los parámetros de búsqueda. |
aaaa |
[Opcional] Año para el que deseas obtener los datos en formato 'aaaa'. Restringe la obtención de datos al año especificado. |
mm |
[Opcional] Mes para el que deseas obtener los datos en formato 'mm'. Restringe la obtención de datos al mes especificado. |
codespazo |
[Opcional] Código del territorio para el que se desea obtener los datos. Se usa en las series de datos ige_* cuando se quieren obtener los datos de un determinado municipio, comarca o provincia para aquellas series de datos disponibles a nivel provincial, comarcal o municipal. Su valor por defecto es '12' (Galicia). |
Códigos de muestra
PHP (file_get_contents)
Búsqueda estándar: Se muestra a continuación un ejemplo para una carga de datos estándar
// establecer la serie de datos y la clave de acceso API $access_key = "YOUR_ACCESS_KEY"; $table = "bds_500000"; // Parámetros conexión $options = [ "ssl" => [ "verify_peer"=>false, "verify_peer_name"=>false, ] ]; $url_api = "https://infoscod.es/apis/api_data.php?access_key=$access_key&table=$table"; // Almacenar los datos $json = file_get_contents("$url_api", false, stream_context_create($options)); // Decodificar respuesta JSON $api_result = json_decode($json, true); // comprobar respuesta echo "$json";
PHP (cURL)
Búsqueda estándar: Se muestra a continuación un ejemplo para una carga de datos estándar utilizando PHP cURL.
// establecer la serie de datos y la clave de acceso API $access_key = "YOUR_ACCESS_KEY"; $table = "bds_500000"; // Inicializar cURL $ch = curl_init(); curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);; curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); // Establecer la URL y otras opciones apropiadas $url_api = "https://infoscod.es/apis/api_data.php?access_key=$access_key&table=$table"; curl_setopt($ch, CURLOPT_URL, "$url_api"); // Almacenar los datos $json = curl_exec($ch); curl_close($ch); // Decodificar respuesta JSON $api_result = json_decode($json, true); // comprobar respuesta echo "$json";