U kunt deze catalogus bevragen op niveau van categorieën en producten. Deze catalogus is beschikbaar voor iedereen, u hoeft hiervoor niet aan te melden.

Om datasets te downloaden die “open” zijn (geen registratie noodzakelijk) moet u niet geauthenticeerd zijn. U kunt deze dus direct downloaden.

Echter, om de andere datasets te downloaden of uw bestelling te configureren moet u eerst geauthenticeerd zijn.

Authenticatie en autorisatie

De applicatie maakt gebruik van de Authenticatie en Autorisatie Server van Digitaal Vlaanderen voor het authentiseren en autoriseren van afnemers in het geval van token authenticatie.

Deze autorisatie is per product (dataset/datasetgroep) geregeld. Als u de catalogus (i.e. de ‘product’ resource) benadert met je OAuth token, krijgt u een indicatie of u al dan niet gemachtigd bent om de producten te downloaden.

Raadpleeg de API-autorisatiedocumentatie voor meer informatie over het gebruik van OAuth 2.0. ((opent in nieuw venster))

We raden een integratie aan via OAuth client credentials grant. ((opent in nieuw venster)) Deze OAuth flow is bedoeld voor machine-to-machine B2B integraties.

Bij het uitvoeren van de integratie raden we ook aan om de client authenticatie op basis van een JSON Web Key te doen waarbij gebruik gemaakt wordt van een keypair ipv een shared secret. Meer info vindt u hier:

Orderconfiguratie

Om een ​​bestelling te configureren moet men minimaal volgende gegevens opgeven:

  • de id van het product (dataset, datasetgroep of entiteit)
  • het bestandsformaat (indien vector) en
  • het bestandstype: een volledig bestand of een verschilbestand (full of diff)

Keuzes bij downloaden

U kunt de gedownloade gegevens beperken tot:

  • een bepaald geografisch gebied (aangepast of vooraf gedefinieerd) of
  • tot een bepaalde tijdsperiode.

Een enkele bestelling kan een of meer bestel-items bevatten.

Na een succesvolle validatie van de orderconfiguratie ontvangt u een order id.

Deze id kan worden gebruikt om te peilen naar voltooiing van de bestelling:

  • de HEAD-methode biedt een controle voor de bestelstatus,
  • terwijl de GET-methode alle details van de bestelling retourneert.

Wanneer de bestelling is voltooid, kunt u het resulterende zip-bestand downloaden.

Via de Downloadservice

  • Stap 1

    Token opvragen

  • Stap 2

    "GET product": lijst van beschikbare producten (catalogus)

  • Stap 3

    "GET dataset": detail product

  • Stap 4

    "POST order": configuratie en bestelling

    • Uitsnede
    • Formaat
    • Clip
    • Type artikel
      • Recentste versie
      • Historische versie
      • Verschilbestanden
  • Stap 5

    "HEAD order" of "GET order": pollen van status bestelling

  • Stap 6

    "GET order download": downloaden