Direct naar beschikbare API's
Één centraal platform voor het oproepen van data
Hoe werkt dit en hoe kom ik bij mijn gegevens?
Introductie
Het Dataplatform wordt u aangeboden door het team van Centric Leefomgeving, voor het extern aanroepen van gegevens om deze te gebruiken met uw applicaties. Bijvoorbeeld voor het genereren van inzichten op basis van Business Intelligence, Business Analytics en Data Science, voor het ophalen van (een deel van) de data voor consistentiecontroles, of om (een deel van) de data beschikbaar te stellen voor data-gedreven ontwikkelingen. Daarnaast houdt u beschikking over alle gegevens, bijvoorbeeld voor migratiedoeleinden.
Data wordt ontsloten via een externe gegevenslaag. Dit maakt het mogelijk om de gegevens in een duidelijk Nederlands datamodel aan te bieden en voorkomt invloed op dat de performance van de applicatie. Daarnaast bieden we binnenkort ook de mogelijkheid om een deel van de data af te schermen voor gebruikersgroepen, zodat bijvoorbeeld AVG-gevoelige informatie niet onnodig wordt aangeroepen en verwerkt.
Aansluiten
De gegevens worden beschikbaar gesteld middels REST API's (Representational State Transfer Application Program Interface). Dit is een architectuurstijl waarmee software kan communiceren met andere software via een netwerk of op hetzelfde apparaat. In dit geval hebben we alleen te maken met API's van het type GET, voor het ophalen van gegevens. De werking van de API's wordt verder toegelicht in het hoofdstuk op dit onderwerp.
De gegevens die de API aanlevert zijn van het formaat JSON. Moderne business intelligence applicaties zoals Cognos, PowerBI, Tableau en Qlik kunnen direct verbinding leggen met REST API's, waardoor de gegevens vanuit de bron kunnen worden uitgelezen.
Voor applicaties die niet direct kunnen verbinden met REST API's, maar wel JSON data kunnen verwerken, is het uiteraard ook mogelijk om de gegevens als bestand op te halen en in te lezen.
Laten we beginnen!
Om de gegevens aan te roepen heeft u het volgende nodig:
Endpoint: De URL van de API vormt de basis. Een overzicht van de beschikbare API's vindt u op de gelijknamige pagina, die u kunt bereiken via het hoofdmenu.
Authorisatie: Op dit moment krijgt elke tenant een eigen wachtwoord, dat wordt meegegeven in de Header in de vorm: "Ocp-Apim-Subscription-Key:{HierUwWachtwoord}". In de toekomst wordt authorisatie verder uitgebreid, zodat de toegang wordt gekoppeld aan uw inlogmethode in Centric Leefomgeving.
Parameters: Hiermee geeft u aan welke gegevens u wilt zien, zoals welke tabel, of eventuele filters hierbinnen.
In het voorbeeld rechts hebben we het endpoint /pss/tables/leges aangeroepen. De gegevens komen gestructureerd terug en kunnen zodoende snel worden verwerkt in uw eigen applicaties.
Mocht u nog vragen of opmerkingen hebben over het gebruik van deze pagina, horen wij dit graag.