|
1 | 1 | # Bevraag OGC API - Features met curl |
2 | 2 |
|
3 | | -We hebben eerder gezien hoe je de API-documentatie in de browser kunt bekijken. Nu is het tijd om echt aan de slag te gaan met de API. In dit deel stel je met behulp van de landing page API GET requests samen om data op te vragen. Die ga je vervolgens afvuren met curl (command line). |
| 3 | +We hebben eerder gezien hoe je de API-documentatie in de browser kunt bekijken. Nu is het tijd om echt aan de slag te gaan met de API. |
| 4 | +In de commandline kun je met behulp van de tool `cURL` data opvragen en versturen. Je kunt dit ook gebruiken om API's om data op te vragen en die data vervolgens terug te krijgen. Zo ook de OGC API's van PDOK. Je krijgt het resultaat terug als json-bestand. |
| 5 | +Ontwikkelaars gebruiken dit principe om API's te implementeren in hun eigen applicaties. |
| 6 | + |
| 7 | +In dit deel stel je met behulp van de OpenAPI specification GET requests samen om de de OGC API - Features van de Basisregistratie Grootschalige Topografie (BGT) te bevragen. Die requests vuur je vervolgens met curl af. Het resultaat ontvang je als `json`. |
| 8 | + |
| 9 | +## Voorbereiding |
| 10 | + |
| 11 | +- **Open een commandline / terminal venster.** |
| 12 | + |
| 13 | +!!! warning "Waarschuwing" |
| 14 | + |
| 15 | + Gebruik niet de PowerShell terminal. Die heeft een ingebouwde eigen versie van curl met veel minder mogelijkheden. De voorbeelden zullen daar niet in werken. |
| 16 | + |
| 17 | +Met de OpenAPI specification pagina kun je heel makkelijk commando's voor curl samenstellen. |
| 18 | + |
| 19 | +- **Ga naar de OpenAPI specification van de BGT.** |
| 20 | + |
| 21 | +Weet je niet meer waar je die kunt vinden? Kijk dan even in één van de vorige onderdelen. |
| 22 | + |
| 23 | + |
| 24 | + |
| 25 | +## OpenAPI specification opvragen |
| 26 | + |
| 27 | +Laten we beginnen met een simpele vraag. We vragen eerst de `OpenAPI specification` zelf op. |
| 28 | + |
| 29 | +- **Klap 'GET** `/api` This document' **open**: |
| 30 | + |
| 31 | + |
| 32 | + |
| 33 | +- **Klik op *Try it out*** |
| 34 | +- **Klik op *Execute*** |
| 35 | + |
| 36 | +Je krijgt nu het `curl` commando dat is afgevuurd en het resultaat (response) te zien: |
| 37 | + |
| 38 | + |
| 39 | + |
| 40 | +Er is één parameter meegegeven: geef het resultaat als json. En we krijgen de specificatie inderdaad netjes te zien als json-document. |
| 41 | + |
| 42 | +We kunnen het curl commando kopiëren en zelf uitvoeren in de command line. |
| 43 | + |
| 44 | +!!! warning "Waarschuwing" |
| 45 | + |
| 46 | + Pas voor de Windows commandline (`cmd.exe`) de kant-en-klare curl commando's aan: zet alles op één regel en verander de 'enkele quotes' in "dubbele quotes". |
| 47 | + |
| 48 | +- **Kopieer het curl commando en plak het in de commandline** |
| 49 | + |
| 50 | +Voor Windows: |
| 51 | + |
| 52 | +`curl -X "GET" "https://api.pdok.nl/lv/bgt/ogc/v1/api?f=json" -H 'accept: */*'` |
| 53 | + |
| 54 | + |
| 55 | + |
| 56 | +- **Druk op Enter en bekijk het resultaat:** |
| 57 | + |
| 58 | + |
| 59 | + |
| 60 | +## Vraag collecties op |
| 61 | + |
| 62 | +!!! warning "TO DO" |
| 63 | + |
| 64 | +- GET collections |
| 65 | +- GET collections/spoor |
| 66 | +- GET collections/spoor/schema |
| 67 | +- CRS |
| 68 | + |
| 69 | +## Vraag items op |
| 70 | + |
| 71 | +- GET collections/spoor/items |
| 72 | +- GET collections/spoor/items/{featureId} |
| 73 | +- bounding box |
| 74 | +- limit |
0 commit comments