Utilizar la API

Una API (interfaz de programación de aplicaciones) es una interfaz destinada a la comunicación y el intercambio de datos de los programas.

Nota

Para ampliar información sobre qué son las API y cómo se utilizan, puede leer el artículo “No necesita analogías para entender las API” escrito por uno de nuestros desarrolladores de OpenDataSoft.

OpenDataSoft da acceso a 6 interfaces API, que pueden dividirse en 3 categorías:

Todas estas API ofrecen acceso a los datos insertados en la plataforma, independientemente de su origen o formato, siempre que las reglas de seguridad definidas por el propietario de los datos permitan ese acceso.

Estas API se pueden usar, por ejemplo, para buscar conjuntos de datos y datos, calcular análisis o realizar agregaciones geográficas. Pese a estar orientadas a los desarrolladores, le invitamos a ver ejemplos más concretos de lo que se puede hacer con las API: aplicaciones como reutilizaciones de datos. En efecto, algunos de los clientes de OpenDataSoft han visto cómo se reutilizaban sus conjuntos de datos a través de su API para crear aplicaciones (Qui dit miam ! y Y’A D Frites! son 2 aplicaciones que visualizan el menú de cafeterías escolares de las ciudades francesas de Toulouse, Rennes y Saint-Malo).

Recordatorio previo a la profundización en cualquier especificación API

Antes de usar alguna de las API disponibles, es muy importante estar familiarizado con la naturaleza de sus datos. Todo el contenido de la plataforma está construido con una estructura de árbol (obviamente, hay más tipos de datos en la plataforma, pero solo son relevantes en contextos muy específicos). En consecuencia, OpenDataSoft se puede ver en estos términos:

  • La plataforma OpenDataSoft es una red de portales OpenDataSoft.

  • Un portal proporciona un catálogo de todos sus conjuntos de datos.

  • Cada uno de los conjuntos de datos está definido por un diccionario de metadatos, un esquema de datos (que especifica los nombres y tipos de campos) y una colección de registros.

  • Cada uno de los registros suministra valores para cada uno de los campos del conjunto de datos.

Triple Pattern Fragments

La API de Triple Pattern Fragments (TPF) hace posible la consulta de conjuntos de datos en formato RDF (Resource Description Framework). Este trabajo sigue en curso y forma parte de un proyecto de PhD que pretende mejorar la calidad de los conjuntos de datos de OpenDataSoft mediante tecnologías de semántica web.

OData, WFS y CSW

Las siglas OData, WFS y CSW hacen referencia a otros estándares que implementa la plataforma. Recomendamos a los usuarios que no estén familiarizados con estas 3 API que se ciñan a la API de búsqueda de ODS ya que proporciona el acceso más amplio a los datos.

  • OData: Estándar de interfaces API REST que proporciona un lenguaje común para realizar solicitudes en las API. El inconveniente del paradigma genérico de esta norma es su mayor complejidad en comparación con las API REST personalizadas tradicionales. OpenDataSoft ha implementado esta norma para las operaciones simples (buscar conjuntos de datos y registros), pero para las más complejas (como análisis, agregaciones, cálculos geográficos, etc.) deben utilizarse nuestras API de búsqueda de ODS (V1 y V2).

  • WFS y CSW: Estándares que se centran en los datos geográficos. Por ejemplo, son especialmente relevantes para que la plataforma interactúe con otro software GIS.