Versión 3.0

La Versión 3.0 de la API SBIF permite el acceso a diversos recursos de información con datos actuales e históricos de diferentes tipos de reportes que se ofrecen en el sitio web. Para su eso es necesario contar con una API Key que debe incorporarse en cada consulta realizada.

Para acceder a la documentación, siga los siguientes enlaces:

Uso de parámetros GET

La API fue implementada para que las URIs puedan ser utilizadas mediante parámetros GET, con el objetivo de indicar las características de la petición que se ejecuta. El orden en que se indiquen estos parámetros no es relevante.

Los parámetros utilizados en el API SBIF son los siguientes:

  • apikey: permite incluir el valor de la clave se haya entregado al usuario.
  • formato: permite indicar si el archivo de salida será en formato JSON o XML; si no se utiliza este parámetro, la salida será en XML. Los parámetros se pueden indicar en mayúsculas (JSON|XML) o en minúsculas (json|xml).
  • callback: este parámetro es opcional y sólo se emplea cuando se pide un archivo de salida del tipo JSON (para obtener la respuesta usando JSONP). En caso de solicitarse una salida JSON y no especificarse una función de callback, se retorna JSON normal.

En cada uno de los recursos que se detallan en esta documentación se explica de manera más específica la forma de incluirlos.

Códigos de Error

Cualquier llamado a los recursos que no cumpla con la entrega de la API Key o que tenga parámetros errados, generará un archivo XML que muestra dos datos relevantes:

  • Un código de error con información general que emplea la numeración usada en el protocolo HTTP.
  • Un código de error con información particular, de acuerdo a la nomenclatura utlizada en la API SBIF.

La documentación acerca de los errores puede encontrarse en este documento.

Actualizado: 04/08/2017

Versión 1.0

La Versión 1.0 de la API SBIF comenzó a funcionar en 2010 y será descontinuada a fines de 2017. Se recomienda a los usuarios de este sistema, migrar hacia la Versión 3.0 de la API SBIF.

Actualizado: 04/08/2017