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.
datadiensten
Gegevens over de beschikbare diensten van dataplatform
- ID:
- datadiensten
- Versie:
- None
- Autorisatie:
- Geen; dit is openbare data.
- Licentie:
- -
- Eigenaar:
- Gemeente Amsterdam
- Uitgever:
- Datadiensten
- Productie:
- Team Datadiensten
- Bronhouder:
- Datadiensten.DV@amsterdam.nl
Endpoints
- REST OpenAPI:
- /v1/datadiensten
Tabellen
Authorisatie scopes
- Autorisatie:
- FP/MDW
- REST URI:
- /v1/datadiensten/authorisatie_scopes
- CSV-export:
- /v1/datadiensten/authorisatie_scopes?_format=csv
- GeoJSON-export:
- /v1/datadiensten/authorisatie_scopes?_format=geojson
De volgende velden zijn beschikbaar:
| Veldnaam | Type | Identifier | Omschrijving |
|---|---|---|---|
id
|
String | ☑ | Id van de scope |
naam
|
String | Naam van de scope (zoals in amsterdam-schema) | |
packageNaam
|
String | Naam van de Myaccess package van deze scope | |
packageId
|
String | Object ID van de Myaccess package van deze scope | |
packageUrl
|
String | URL van de Myaccess package van deze scope |
De volgende query-parameters zijn te gebruiken:
| Parameter | Autorisatie | Mogelijke waarden | Werking |
|---|---|---|---|
id
|
FP/MDW | Tekst | Test op exacte waarde (==) |
id[in]
|
FP/MDW | Lijst van waarden | Test of de waarde overeenkomst met 1 van de opties (IN). |
id[not]
|
FP/MDW | Test of waarde niet overeenkomt (!=). |
|
id[isnull]
|
FP/MDW | true | false |
Test op ontbrekende waarden (IS NULL / IS NOT NULL). |
id[isempty]
|
FP/MDW | true | false |
Test of de waarde leeg is (== '' / != '') |
id[like]
|
FP/MDW | Tekst met jokertekens (* en ?). |
Test op gedeelte van tekst. |
naam
|
FP/MDW | Tekst | Test op exacte waarde (==) |
naam[not]
|
FP/MDW | Test of waarde niet overeenkomt (!=). |
|
naam[in]
|
FP/MDW | Lijst van waarden | Test of de waarde overeenkomst met 1 van de opties (IN). |
naam[isnull]
|
FP/MDW | true | false |
Test op ontbrekende waarden (IS NULL / IS NOT NULL). |
naam[isempty]
|
FP/MDW | true | false |
Test of de waarde leeg is (== '' / != '') |
naam[like]
|
FP/MDW | Tekst met jokertekens (* en ?). |
Test op gedeelte van tekst. |
packageId
|
FP/MDW | Tekst | Test op exacte waarde (==) |
packageId[not]
|
FP/MDW | Test of waarde niet overeenkomt (!=). |
|
packageId[in]
|
FP/MDW | Lijst van waarden | Test of de waarde overeenkomst met 1 van de opties (IN). |
packageId[isnull]
|
FP/MDW | true | false |
Test op ontbrekende waarden (IS NULL / IS NOT NULL). |
packageId[isempty]
|
FP/MDW | true | false |
Test of de waarde leeg is (== '' / != '') |
packageId[like]
|
FP/MDW | Tekst met jokertekens (* en ?). |
Test op gedeelte van tekst. |
packageNaam
|
FP/MDW | Tekst | Test op exacte waarde (==) |
packageNaam[not]
|
FP/MDW | Test of waarde niet overeenkomt (!=). |
|
packageNaam[in]
|
FP/MDW | Lijst van waarden | Test of de waarde overeenkomst met 1 van de opties (IN). |
packageNaam[isnull]
|
FP/MDW | true | false |
Test op ontbrekende waarden (IS NULL / IS NOT NULL). |
packageNaam[isempty]
|
FP/MDW | true | false |
Test of de waarde leeg is (== '' / != '') |
packageNaam[like]
|
FP/MDW | Tekst met jokertekens (* en ?). |
Test op gedeelte van tekst. |
packageUrl
|
FP/MDW | Tekst | Test op exacte waarde (==) |
packageUrl[not]
|
FP/MDW | Test of waarde niet overeenkomt (!=). |
|
packageUrl[in]
|
FP/MDW | Lijst van waarden | Test of de waarde overeenkomst met 1 van de opties (IN). |
packageUrl[isnull]
|
FP/MDW | true | false |
Test op ontbrekende waarden (IS NULL / IS NOT NULL). |
packageUrl[isempty]
|
FP/MDW | true | false |
Test of de waarde leeg is (== '' / != '') |
packageUrl[like]
|
FP/MDW | Tekst met jokertekens (* en ?). |
Test op gedeelte van tekst. |
Dso performance
- Autorisatie:
- FP/MDW
- REST URI:
- /v1/datadiensten/dso_performance
- CSV-export:
- /v1/datadiensten/dso_performance?_format=csv
- GeoJSON-export:
- /v1/datadiensten/dso_performance?_format=geojson
De volgende velden zijn beschikbaar:
| Veldnaam | Type | Identifier | Omschrijving |
|---|---|---|---|
id
|
String | ☑ | Id |
startDateTime
|
Datetime | Begintijd van de responsetijd meting | |
endDateTime
|
Datetime | Begintijd van de reponsetijd meting | |
endpoint
|
String | Dataset endpoint | |
minResponseTime
|
Number | Snelste responsetijd gemeten | |
maxResponseTime
|
Number | Langste responstijd gemeten | |
avgResponseTime
|
Number | Gemiddelde responstijd gemeten |
De volgende query-parameters zijn te gebruiken:
| Parameter | Autorisatie | Mogelijke waarden | Werking |
|---|---|---|---|
avgResponseTime
|
FP/MDW | Getal | Test op exacte waarde (==) |
avgResponseTime[gt]
|
FP/MDW | Test op groter dan (>). |
|
avgResponseTime[lte]
|
FP/MDW | Test op kleiner dan of gelijk (<=). |
|
avgResponseTime[in]
|
FP/MDW | Lijst van waarden | Test of de waarde overeenkomst met 1 van de opties (IN). |
avgResponseTime[not]
|
FP/MDW | Test of waarde niet overeenkomt (!=). |
|
avgResponseTime[gte]
|
FP/MDW | Test op groter dan of gelijk (>=). |
|
avgResponseTime[lt]
|
FP/MDW | Test op kleiner dan (<). |
|
avgResponseTime[isnull]
|
FP/MDW | true | false |
Test op ontbrekende waarden (IS NULL / IS NOT NULL). |
endDateTime
|
FP/MDW | yyyy-mm-dd of yyyy-mm-ddThh:mm[:ss[.ms]] |
Test op exacte waarde (==) |
endDateTime[gt]
|
FP/MDW | Test op groter dan (>). |
|
endDateTime[lte]
|
FP/MDW | Test op kleiner dan of gelijk (<=). |
|
endDateTime[in]
|
FP/MDW | Lijst van waarden | Test of de waarde overeenkomst met 1 van de opties (IN). |
endDateTime[not]
|
FP/MDW | Test of waarde niet overeenkomt (!=). |
|
endDateTime[gte]
|
FP/MDW | Test op groter dan of gelijk (>=). |
|
endDateTime[lt]
|
FP/MDW | Test op kleiner dan (<). |
|
endDateTime[isnull]
|
FP/MDW | true | false |
Test op ontbrekende waarden (IS NULL / IS NOT NULL). |
endpoint
|
FP/MDW | Tekst | Test op exacte waarde (==) |
endpoint[not]
|
FP/MDW | Test of waarde niet overeenkomt (!=). |
|
endpoint[in]
|
FP/MDW | Lijst van waarden | Test of de waarde overeenkomst met 1 van de opties (IN). |
endpoint[isnull]
|
FP/MDW | true | false |
Test op ontbrekende waarden (IS NULL / IS NOT NULL). |
endpoint[isempty]
|
FP/MDW | true | false |
Test of de waarde leeg is (== '' / != '') |
endpoint[like]
|
FP/MDW | Tekst met jokertekens (* en ?). |
Test op gedeelte van tekst. |
id
|
FP/MDW | Tekst | Test op exacte waarde (==) |
id[in]
|
FP/MDW | Lijst van waarden | Test of de waarde overeenkomst met 1 van de opties (IN). |
id[not]
|
FP/MDW | Test of waarde niet overeenkomt (!=). |
|
id[isnull]
|
FP/MDW | true | false |
Test op ontbrekende waarden (IS NULL / IS NOT NULL). |
id[isempty]
|
FP/MDW | true | false |
Test of de waarde leeg is (== '' / != '') |
id[like]
|
FP/MDW | Tekst met jokertekens (* en ?). |
Test op gedeelte van tekst. |
maxResponseTime
|
FP/MDW | Getal | Test op exacte waarde (==) |
maxResponseTime[gt]
|
FP/MDW | Test op groter dan (>). |
|
maxResponseTime[lte]
|
FP/MDW | Test op kleiner dan of gelijk (<=). |
|
maxResponseTime[in]
|
FP/MDW | Lijst van waarden | Test of de waarde overeenkomst met 1 van de opties (IN). |
maxResponseTime[not]
|
FP/MDW | Test of waarde niet overeenkomt (!=). |
|
maxResponseTime[gte]
|
FP/MDW | Test op groter dan of gelijk (>=). |
|
maxResponseTime[lt]
|
FP/MDW | Test op kleiner dan (<). |
|
maxResponseTime[isnull]
|
FP/MDW | true | false |
Test op ontbrekende waarden (IS NULL / IS NOT NULL). |
minResponseTime
|
FP/MDW | Getal | Test op exacte waarde (==) |
minResponseTime[gt]
|
FP/MDW | Test op groter dan (>). |
|
minResponseTime[lte]
|
FP/MDW | Test op kleiner dan of gelijk (<=). |
|
minResponseTime[in]
|
FP/MDW | Lijst van waarden | Test of de waarde overeenkomst met 1 van de opties (IN). |
minResponseTime[not]
|
FP/MDW | Test of waarde niet overeenkomt (!=). |
|
minResponseTime[gte]
|
FP/MDW | Test op groter dan of gelijk (>=). |
|
minResponseTime[lt]
|
FP/MDW | Test op kleiner dan (<). |
|
minResponseTime[isnull]
|
FP/MDW | true | false |
Test op ontbrekende waarden (IS NULL / IS NOT NULL). |
startDateTime
|
FP/MDW | yyyy-mm-dd of yyyy-mm-ddThh:mm[:ss[.ms]] |
Test op exacte waarde (==) |
startDateTime[gt]
|
FP/MDW | Test op groter dan (>). |
|
startDateTime[lte]
|
FP/MDW | Test op kleiner dan of gelijk (<=). |
|
startDateTime[in]
|
FP/MDW | Lijst van waarden | Test of de waarde overeenkomst met 1 van de opties (IN). |
startDateTime[not]
|
FP/MDW | Test of waarde niet overeenkomt (!=). |
|
startDateTime[gte]
|
FP/MDW | Test op groter dan of gelijk (>=). |
|
startDateTime[lt]
|
FP/MDW | Test op kleiner dan (<). |
|
startDateTime[isnull]
|
FP/MDW | true | false |
Test op ontbrekende waarden (IS NULL / IS NOT NULL). |
Dso usage
- Autorisatie:
- FP/MDW
- REST URI:
- /v1/datadiensten/dso_usage
- CSV-export:
- /v1/datadiensten/dso_usage?_format=csv
- GeoJSON-export:
- /v1/datadiensten/dso_usage?_format=geojson
De volgende velden zijn beschikbaar:
| Veldnaam | Type | Identifier | Omschrijving |
|---|---|---|---|
id
|
String | ☑ | Id |
startDateTime
|
Datetime | Begintijd van het aantal requests | |
endDateTime
|
Datetime | Eindtijd van het aantal requests | |
endpoint
|
String | Dataset endpoint | |
failedRequests
|
Integer | Het aantal requests die niet succesvol zijn uitgevoerd HTTP_4XX en HTTP_5XX | |
successfullRequests
|
Integer | Het aantal requests die succevol zijn uitgevoerd HTTP_200 |
De volgende query-parameters zijn te gebruiken:
| Parameter | Autorisatie | Mogelijke waarden | Werking |
|---|---|---|---|
endDateTime
|
FP/MDW | yyyy-mm-dd of yyyy-mm-ddThh:mm[:ss[.ms]] |
Test op exacte waarde (==) |
endDateTime[gt]
|
FP/MDW | Test op groter dan (>). |
|
endDateTime[lte]
|
FP/MDW | Test op kleiner dan of gelijk (<=). |
|
endDateTime[in]
|
FP/MDW | Lijst van waarden | Test of de waarde overeenkomst met 1 van de opties (IN). |
endDateTime[not]
|
FP/MDW | Test of waarde niet overeenkomt (!=). |
|
endDateTime[gte]
|
FP/MDW | Test op groter dan of gelijk (>=). |
|
endDateTime[lt]
|
FP/MDW | Test op kleiner dan (<). |
|
endDateTime[isnull]
|
FP/MDW | true | false |
Test op ontbrekende waarden (IS NULL / IS NOT NULL). |
endpoint
|
FP/MDW | Tekst | Test op exacte waarde (==) |
endpoint[not]
|
FP/MDW | Test of waarde niet overeenkomt (!=). |
|
endpoint[in]
|
FP/MDW | Lijst van waarden | Test of de waarde overeenkomst met 1 van de opties (IN). |
endpoint[isnull]
|
FP/MDW | true | false |
Test op ontbrekende waarden (IS NULL / IS NOT NULL). |
endpoint[isempty]
|
FP/MDW | true | false |
Test of de waarde leeg is (== '' / != '') |
endpoint[like]
|
FP/MDW | Tekst met jokertekens (* en ?). |
Test op gedeelte van tekst. |
failedRequests
|
FP/MDW | Geheel getal | Test op exacte waarde (==) |
failedRequests[gt]
|
FP/MDW | Test op groter dan (>). |
|
failedRequests[lte]
|
FP/MDW | Test op kleiner dan of gelijk (<=). |
|
failedRequests[in]
|
FP/MDW | Lijst van waarden | Test of de waarde overeenkomst met 1 van de opties (IN). |
failedRequests[not]
|
FP/MDW | Test of waarde niet overeenkomt (!=). |
|
failedRequests[gte]
|
FP/MDW | Test op groter dan of gelijk (>=). |
|
failedRequests[lt]
|
FP/MDW | Test op kleiner dan (<). |
|
failedRequests[isnull]
|
FP/MDW | true | false |
Test op ontbrekende waarden (IS NULL / IS NOT NULL). |
id
|
FP/MDW | Tekst | Test op exacte waarde (==) |
id[in]
|
FP/MDW | Lijst van waarden | Test of de waarde overeenkomst met 1 van de opties (IN). |
id[not]
|
FP/MDW | Test of waarde niet overeenkomt (!=). |
|
id[isnull]
|
FP/MDW | true | false |
Test op ontbrekende waarden (IS NULL / IS NOT NULL). |
id[isempty]
|
FP/MDW | true | false |
Test of de waarde leeg is (== '' / != '') |
id[like]
|
FP/MDW | Tekst met jokertekens (* en ?). |
Test op gedeelte van tekst. |
startDateTime
|
FP/MDW | yyyy-mm-dd of yyyy-mm-ddThh:mm[:ss[.ms]] |
Test op exacte waarde (==) |
startDateTime[gt]
|
FP/MDW | Test op groter dan (>). |
|
startDateTime[lte]
|
FP/MDW | Test op kleiner dan of gelijk (<=). |
|
startDateTime[in]
|
FP/MDW | Lijst van waarden | Test of de waarde overeenkomst met 1 van de opties (IN). |
startDateTime[not]
|
FP/MDW | Test of waarde niet overeenkomt (!=). |
|
startDateTime[gte]
|
FP/MDW | Test op groter dan of gelijk (>=). |
|
startDateTime[lt]
|
FP/MDW | Test op kleiner dan (<). |
|
startDateTime[isnull]
|
FP/MDW | true | false |
Test op ontbrekende waarden (IS NULL / IS NOT NULL). |
successfullRequests
|
FP/MDW | Geheel getal | Test op exacte waarde (==) |
successfullRequests[gt]
|
FP/MDW | Test op groter dan (>). |
|
successfullRequests[lte]
|
FP/MDW | Test op kleiner dan of gelijk (<=). |
|
successfullRequests[in]
|
FP/MDW | Lijst van waarden | Test of de waarde overeenkomst met 1 van de opties (IN). |
successfullRequests[not]
|
FP/MDW | Test of waarde niet overeenkomt (!=). |
|
successfullRequests[gte]
|
FP/MDW | Test op groter dan of gelijk (>=). |
|
successfullRequests[lt]
|
FP/MDW | Test op kleiner dan (<). |
|
successfullRequests[isnull]
|
FP/MDW | true | false |
Test op ontbrekende waarden (IS NULL / IS NOT NULL). |