De API gebruiken

Een API (Application Programming Interface) is een interface voor programma's om data te communiceren en uit te wisselen.

Opmerking

Om meer te weten te komen over wat API's zijn en waarom en hoe ze worden gebruikt, kunt u het artikel "You don't need analogies to understand APIs" lezen dat geschreven is door een van onze Opendatasoft-ontwikkelaars.

Opendatasoft biedt toegang tot 5 API's:

  • ODS Explore API V2: belangrijkste Opendatasoft verken-API, die wordt gebruikt om catalogi en datasets te verkennen met een gepersonaliseerde SQL-achtige zoektaal: ODSQL.

  • Triple Pattern Fragments API: ODS API voor drievoudige patronen die zoeken naar datasets uit Opendatasoft-portalen

  • OData, WFS, en CSW: 3 standaard protocollen die ondersteund en verschaft worden door Opendatasoft

Al deze API's bieden toegang tot data die naar het platform wordt geduwd, ongeacht de bron of het formaat, zolang de veiligheidsregels, zoals die door de eigenaar van de data zijn gedefinieerd, die toegang mogelijk maken.

Deze API's kunnen bijvoorbeeld gebruikt worden om te zoeken naar datasets en data om analyses te berekenen of om geografische optellingen uit te voeren. Deze zijn nog altijd ontwikkelaargericht, maar voor meer concrete voorbeelden van wat gedaan worden met API's: applicaties als hergebruiken van data. Sommige van de klanten van Opendatasoft hebben inderdaad gezien dat hun datasets via hun API worden hergebruikt om applicaties aan te maken (bijv. "Qui dit miam !" en "Y'A D Frites!" zijn 2 applicaties die het menu in de schoolkantine van Franse steden, Toulouse, Rennes en Saint-Malo weergeven).

Belangrijk

Alvorens een van de beschikbare API's te gebruiken, is het belangrijk om vertrouwd te zijn met de aard van deze data. Alles binnen het platform is opgebouwd volgens een boomstructuur (er zijn natuurlijke meerdere soorten data binnen het platform, maar deze zijn enkel relevant in zeer specifieke contexten). Bijgevolg kan Opendatasoft gezien worden als volgt:

  • Het Opendatasoft-platform is een netwerk van Opendatasoft-portalen.

  • Een portaal biedt een catalogus van al zijn datasets.

  • Elke dataset wordt gedefinieerd door een woordenboek van metadata, een dataschema (waarin veldnamen en -types worden gespecificeerd) en een verzameling van records.

  • Elk record biedt waarden voor elk van de velden van de dataset.

ODS Search API

De ODS Search API wordt gebruikt in Opendatasoft-widgets. Om een app te ontwikkelen, raden we aan deze API te gebruiken in V2.

Er bestaan momenteel 2 versies van de ODS Search API: de V2 en de V1, die nu ouderwets is. Hieronder vindt u een lijst met de belangrijkste verschillen tussen de 2 versies.

  • Belangrijkste wijzigingen in de V2:

    • Er is een meer volledige zoektaal (ODSQL) beschikbaar met nieuwe functies en wiskundige uitdrukkingen.

    • Speciale filters (zoals een geofilter en facet filters) zijn nu rechtstreeks geïntegreerd in ODSQL, in de parameter waar.

    • We hebben de analyseer-API afgevoerd aangezien alle operaties nu beschikbaar zijn voor alle eindpunten. Indien u een analyse wenst uit te voeren (met uitdrukkingen of functies), kunt u dit ofwel doen op de catalogus ofwel op het eindpunt van de dataset. Indien u een analyse wenst uit te voeren op groepen records, hoeft u ze enkel te groeperen met een REST-parameter group_by.

Triple Pattern Fragments

De Triple Pattern Fragments (TPF) API biedt de mogelijkheid om datasets te zoeken in Resource Description Framework (RDF) formaat.

OData, WFS enCSW

OData, WFS en CSW verwijzen naar andere normen die gehanteerd worden door het platform. We raden gebruikers, die niet met deze 3 API's vertrouwd zijn, aan om de ODS Search API te blijven gebruiken aangezien deze de meest volledige toegang tot de data biedt.

  • OData is een standaard voor REST API's die een gemeenschappelijke taal bieden die in alle API's gebruikt kan worden om zoekopdrachten uit te voeren. De trade-off voor de generische aanpak van deze norm is zijn grotere complexiteit in vergelijking met traditionele gewone REST API's. Opendatasoft heeft deze norm gehanteerd voor de eenvoudige operaties (zoeken naar datasets en records); voor de meer complexe operaties (analyse, samenvoegingen, geografische berekeningen, enz.) moet onze Search API V2 worden gebruikt.

  • WFS en CSW zijn normen die gefocust zijn op geografische data. Deze zijn vooral relevant voor bijvoorbeeld de interface met het platform met andere GIS-software.