API-register: Overzicht

Overzicht nieuwbouwplannen van de Gemeenten van Amsterdam. Onderdeel bestaat uit 3 sets met woningbouwplannen waarvan 1 set openbaar is en voor de andere 2 sets autorisatie voor moet worden aangevraagd.

Een API om een notificatierouteringscomponent te benaderen.

Deze API voorziet in drie functionaliteiten voor notificaties:

• registreren van kanalen (=exchanges)
• abonneren van consumers op kanalen
• ontvangen en routeren van berichten

Registreren van kanalen

Een component dekt een bepaald domein af, en heeft het recht om hiervoor een kanaal te registeren waarop eigen notificaties verstuurd worden. Een kanaal is uniek in naam. Een component dient dus te controleren of een kanaal al bestaat voor het registreren. Bij het registeren van kanalen wordt een documentatielink verwacht die beschrijft welke events en kenmerken van toepassing zijn op het kanaal.

Abonneren

Consumers kunnen een abonnement aanmaken voor een of meerdere kanalen. Per kanaal kan op de kenmerken van het kanaal gefilterd worden. Consumers dienen zelf een endpoint te bouwen waarop berichten afgeleverd (kunnen) worden.

Routeren van berichten

Bronnen sturen berichten naar deze API, die vervolgens de berichten onveranderd routeert naar alle abonnees.

Afhankelijkheden

Deze API is afhankelijk van:

• Autorisaties API

Autorisatie

Deze API vereist autorisatie. Je kan de token-tool gebruiken om JWT-tokens te genereren.

Handige links

• Documentatie
• Zaakgericht werken

Naar INSPIRE thema Nutsdiensten en overheidsdiensten geharmoniseerde lozingspunten zoals gerapporteerd naar de Europese Commissie tbv EU rapportage Stedelijk Afvalwater 2020.

Naar INSPIRE thema Nutsdiensten en overheidsdiensten geharmoniseerde riool water zuiveringsinstallaties (RWZI's) zoals gerapporteerd naar de Europese Commissie tbv EU rapportage Stedelijk Afvalwater 2020.

This OData service is located at https://www.cbs.nl/odata/v1

API to access the OSS register of developer.overheid.nl.

This API distinguishes between public and private endpoints. Public endpoints can be accessed with either an API key or a client credentials token. Private endpoints can only be accessed with a client credentials token.

Using an API key, you can access all public endpoints of the API register. These requests can also be made from the browser. Request a read-only API key at https://apis.developer.overheid.nl/apis/key-aanvragen. Simply pass the obtained API key with each request using the X-Api-Key header.

Using a client credentials token, you can access both public and private endpoints of the OSS register. To obtain the token, you need to perform a POST request to https://auth.developer.overheid.nl/realms/don/protocol/openid-connect/token with the following Form URL Encoded body:

• grant_type: client_credentials
• scope: depending on the access you need and the client you are, you can request one or more of the following scopes:
  • repositories:read
  • repositories:write
  • gitOrganisations:read
  • gitOrganisations:write
  • organisations:read
  • organisations:write
• client_id: the client id you received from us
• client_secret: the client secret you received from us

Pass the obtained token with each request using the Authorization header. Example:

Authorization: Bearer {ACCESS_TOKEN} (replace {ACCESS_TOKEN} with the obtained access_token)

Pagination of collections is done using the Link header. There are various libraries available (such as parse-link-header for Javascript) that can parse this header. Additionally, the following headers provide extra support for implementing pagination in the client:

• Current-Page: the current page in the collection
• Per-Page: the number of items per page
• Total-Count: the total number of items
• Total-Pages: the total number of pages

Met deze REST API kan een regelingversie van een Omgevingsdocument in een zip-bestand worden gedownload met daarin de juridische tekst, de GIO's en de OW-objecten. Ook is het mogelijk voor een lijst locaties de geometrieën in GeoPackage-formaat (GPKG) op te vragen. De Omgevingsdocumenten Download API volgt de standaarden zoals beschreven in de DSO API-strategie versie 2.0. De Omgevingsdocumenten Download API levert informatie conform de STOP/TPOD-standaard, in het bijzonder het Conceptueel Informatiemodel Omgevingswet. Meer informatie is hier te vinden: https://www.geonovum.nl/omgevingswet/STOPTPOD

De Omgevingsdocumenten Presenteren API ontsluit beschikbaar gestelde omgevingsdocumenten op zo'n manier dat deze eenvoudig visueel te verbeelden zijn. Op de Ontwikkel, Test, Acceptatie en Pre-productieomgeving worden ook omgevingsdocumenten toegevoegd en verwijderd door beheerders voor testdoeleinden binnen en buiten de voorziening.

De Omgevingsdocumenten Presenteren API volgt de standaarden zoals beschreven in de DSO API-strategie versie 2.0. Zo is het standaard mediatype HAL (application/hal+json). Dit is een mediatype voor het weergeven van resources en hun relaties via hyperlinks.

De Omgevingsdocumenten Presenteren API levert informatie conform de STOP/TPOD-standaard, in het bijzonder het Conceptueel Informatiemodel Omgevingswet. Meer informatie is hier te vinden: https://www.geonovum.nl/omgevingswet/STOPTPOD

De Omgevingsdocumenten Verbeelden API ontsluit informatie tbv het verbeelden van beschikbaar gestelde omgevingsdocumenten. Op de Ontwikkel, Test, Acceptatie en Pre-productieomgeving worden ook omgevingsdocumenten toegevoegd en verwijderd door beheerders voor testdoeleinden binnen en buiten de voorziening. De Omgevingsdocumenten Verbeelden API volgt de standaarden zoals beschreven in de DSO API-strategie versie 1.1. Zo is het standaard mediatype HAL (application/hal+json). Dit is een mediatype voor het weergeven van resources en hun relaties via hyperlinks. Layers zijn gebaseerd op de OGC API Tiles. De Omgevingsdocumenten Verbeelden API levert informatie conform de STOP/TPOD-standaard, in het bijzonder het Conceptueel Informatiemodel Omgevingswet. Meer informatie is hier te vinden: https://www.geonovum.nl/omgevingswet/STOPTPOD

De Omgevingsinformatie ontsluiten API ontsluit omgevingsinformatie uit meerdere bronnen in samenhang. Bijvoorbeeld om te kunnen zoeken naar zowel omgevingsdocumenten in het kader van de Omgevingswet (OW), als IMRO-documenten (bestemmingsplannen en dergelijke) in het kader van de Wet op de Ruimtelijke Ordening (Wro).

Deze API volgt de standaarden zoals beschreven in de DSO API-strategie. Deze API wijkt daar op sommige punten vanaf, vooruitlopend op een nieuwe versie van de API-strategie die wordt gebaseerd op de NLGov REST API Design Rules.