Het Dataplatform van gemeente Amsterdam gaat het gebruik van een API key bij het gebruik van API's verplicht stellen. Hiermee wil het Dataplatform inzicht krijgen wie gebruik maakt van haar APIs, zodat het Dataplatform kan communiceren over updates en wijzigingen in de API's. Eventuele wijzigingen in de API's kunnen dan tijdig geïmplementeerd worden in uw systemen. Dit gaat gelden voor alle zogenaamde 'DSO API's' van het Dataplatform van gemeente Amsterdam.
Het gebruik van een API key bij de aanroep van een API van het Dataplatform van gemeente Amsterdam is vanaf half september optioneel. In overleg met de dataorganisatie wordt een deadline vastgesteld voor het moment vanaf wanneer de API keys verplicht worden. U kunt de API's van het Dataplatform dan niet meer gebruiken zonder een API key mee te geven.
Dit heeft gevolgen voor uw systemen!
Vraag tijdig een API key aan om uw systemen hierop aan te passen. U kunt met dit formulier een API key aanvragen.
Relaties direct insluiten
Bij iedere relatie wordt er een hyperlink meegegeven om het object op te vragen. Echter kunnen alle objecten ook in een enkele request opgehaald worden. Dit is zowel voor de client als server efficiënter.
Gebruik hiervoor één van volgende opties:
- Door
?_expand=trueworden alle relaties uitgevouwen in de_embeddedsectie. - Door
?_expandScope={veld1},{veld2}worden specifieke relaties getoond in de_embeddedsectie.
De volgende aanroepen zijn identiek:
curl 'https://api.data.amsterdam.nl/v1/gebieden/buurten/?_expand=true'
curl 'https://api.data.amsterdam.nl/v1/gebieden/buurten/?_expandScope=ligtInWijk'
De response bevat zowel het "buurt" object als de "wijk":
{
"_links": {
// ...
},
"_embedded": {
"buurten": [
{
"_links": {
"schema": "https://schemas.data.amsterdam.nl/datasets/gebieden/gebieden#buurten",
"self": {
"href": "https://api.data.amsterdam.nl/v1/gebieden/buurten/03630000000078/?volgnummer=1",
"title": "03630000000078.1",
"volgnummer": 1,
"identificatie": "03630000000078"
},
"buurtenWoningbouwplan": [],
"buurtenStrategischeruimtes": [],
"ligtInWijk": {
"href": "https://api.data.amsterdam.nl/v1/gebieden/wijken/03630012052036/?volgnummer=1",
"title": "03630012052036.1",
"volgnummer": 1,
"identificatie": "03630012052036"
}
},
"code": "A00a",
"naam": "Kop Zeedijk",
"cbsCode": "BU03630000",
"geometrie": {
"type": "Polygon",
"coordinates": [
// ...
]
},
"ligtInWijkVolgnummer": 1,
"ligtInWijkIdentificatie": "03630012052036",
"ligtInWijkId": "03630012052036",
"documentdatum": null,
"documentnummer": null,
"eindGeldigheid": null,
"beginGeldigheid": "2006-06-12",
"registratiedatum": "2018-10-25T12:17:48",
"id": "03630000000078.1"
}
],
"ligtInWijk": [
{
"_links": {
"schema": "https://schemas.data.amsterdam.nl/datasets/gebieden/gebieden#wijken",
"self": {
"href": "https://api.data.amsterdam.nl/v1/gebieden/wijken/03630012052036/?volgnummer=1",
"title": "03630012052036.1",
"volgnummer": 1,
"identificatie": "03630012052036"
},
"ligtInStadsdeel": {
"href": "https://api.data.amsterdam.nl/v1/gebieden/stadsdelen/03630000000018/?volgnummer=3",
"title": "03630000000018.3",
"volgnummer": 3,
"identificatie": "03630000000018"
}
},
"code": "A00",
"naam": "Burgwallen-Oude Zijde",
"cbsCode": "WK036300",
"geometrie": {
"type": "Polygon",
"coordinates": [
// ...
]
},
"documentdatum": null,
"documentnummer": null,
"eindGeldigheid": null,
"beginGeldigheid": "2006-06-12",
"ligtInStadsdeelVolgnummer": 3,
"ligtInStadsdeelIdentificatie": "03630000000018",
"registratiedatum": "2018-10-25T12:17:33",
"id": "03630012052036.1"
}
]
},
"page": {"number": 1, "size": 1, "totalElements": 973, "totalPages": 973}
}