Gedaan met laden. U bevindt zich op: Download API v2 Downloadtoepassing

Download API v2

Met de Download API kunt u op maat bestellingen plaatsen op alle producten van de Downloadtoepassing van Digitaal Vlaanderen. Op deze pagina vindt u informatie over de v2 van de API.

Algemeen

Authenticatie en autorisatie

  • De applicatie maakt gebruik van de Veiligheidsbouwstenen van de Vlaamse overheid voor het authentiseren en autoriseren van afnemers van token authenticatie (via Bearer token).
  • 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.
  • Voor het opvragen van productinformatie hebt u de scope “download_catalogus_v2” nodig.
  • Voor het plaatsen en downloaden van een bestelling hebt u de scope “download_orders_v2” nodig.

Omgevingen

Beta-omgeving(opent in nieuw venster)
Productie-omgeving(opent in nieuw venster)Authenticatie gebeurt via de PRD-omgeving van de veiligheidsbouwstenen. Onboarden kan via het beheerportaal productie-omgeving(opent in nieuw venster).

Onboarden via het beheerportaal

Om de Download API te gebruiken, en “niet-open” data te downloaden, is een onboarding nodig. Via het beheerportaal kunt u zo een onboarding starten en een Client aanvragen. Vergeet hierbij ook niet de juiste scopes aan te vragen.

Een product 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 Download API:

  • Stap 1

    Token opvragen

  • Stap 2

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

    Haal een gepagineerde lijst van producten op

  • Stap 3

    “GET Product”: detail van een product

    Haal een specifiek product op aan de hand van een id en raadpleeg de configuratiemogelijkheden

  • Stap 4

    "POST order": plaats een bestelling

    • Minimale configuratie: productId, format, geographicalCrop (via selectieEntiteit of polygoon)
    • U kunt de gedownloade gegevens beperken tot:
      • een bepaald geografisch gebied (GeographicalCrop)
      • een bepaalde tijdsperiode (TemporalCrop).
    • U kan opgeven of u een notificatie wenst te ontvangen wanneer de verwerking klaar is.
    • Na een succesvolle validatie van de request ontvangt u een orderId.
  • Stap 5

    “GET Status Order”: haal de status van de bestelling op

  • Stap 6

    “GET Order”: detail van de bestelling

  • Stap 7

    "Get Order Download”: downloaden van de bestelling

API-documentatie

Bekijk de API-documentatie in detail voor een overzicht van alle endpoints, response samples en errors.