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:
- default
- 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:
| Veld ID | Veldnaam | Type | Identifier | Omschrijving |
|---|---|---|---|---|
id
|
id | String | ☑ | Id van de scope |
naam
|
Scope naam | String | Naam van de scope (zoals in amsterdam-schema) | |
packageNaam
|
Myaccess package naam | String | Naam van de Myaccess package van deze scope | |
packageId
|
Myaccess package id | String | Object ID van de Myaccess package van deze scope | |
packageUrl
|
Myaccess package URL | 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[like]
|
FP/MDW | Tekst met jokertekens (* en ?). |
Test op gedeelte van tekst. |
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[not]
|
FP/MDW | Test of waarde niet overeenkomt (!=). |
|
naam
|
FP/MDW | Tekst | Test op exacte waarde (==) |
naam[in]
|
FP/MDW | Lijst van waarden | Test of de waarde overeenkomst met 1 van de opties (IN). |
naam[like]
|
FP/MDW | Tekst met jokertekens (* en ?). |
Test op gedeelte van tekst. |
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[not]
|
FP/MDW | Test of waarde niet overeenkomt (!=). |
|
packageId
|
FP/MDW | Tekst | Test op exacte waarde (==) |
packageId[in]
|
FP/MDW | Lijst van waarden | Test of de waarde overeenkomst met 1 van de opties (IN). |
packageId[like]
|
FP/MDW | Tekst met jokertekens (* en ?). |
Test op gedeelte van tekst. |
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[not]
|
FP/MDW | Test of waarde niet overeenkomt (!=). |
|
packageNaam
|
FP/MDW | Tekst | Test op exacte waarde (==) |
packageNaam[in]
|
FP/MDW | Lijst van waarden | Test of de waarde overeenkomst met 1 van de opties (IN). |
packageNaam[like]
|
FP/MDW | Tekst met jokertekens (* en ?). |
Test op gedeelte van tekst. |
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[not]
|
FP/MDW | Test of waarde niet overeenkomt (!=). |
|
packageUrl
|
FP/MDW | Tekst | Test op exacte waarde (==) |
packageUrl[in]
|
FP/MDW | Lijst van waarden | Test of de waarde overeenkomst met 1 van de opties (IN). |
packageUrl[like]
|
FP/MDW | Tekst met jokertekens (* en ?). |
Test op gedeelte van tekst. |
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[not]
|
FP/MDW | Test of waarde niet overeenkomt (!=). |
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:
| Veld ID | Veldnaam | Type | Identifier | Omschrijving |
|---|---|---|---|---|
id
|
id | String | ☑ | Id |
startDateTime
|
Begintijd van de meting | Datetime | Begintijd van de responsetijd meting | |
endDateTime
|
Eindtijd van de meting | Datetime | Begintijd van de reponsetijd meting | |
endpoint
|
Dataset endpoint | String | Dataset endpoint | |
minResponseTime
|
Snelste responsetijd gemeten | Number | Snelste responsetijd gemeten | |
maxResponseTime
|
Langste responstijd gemeten | Number | Langste responstijd gemeten | |
avgResponseTime
|
Gemiddelde responstijd gemeten | 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[in]
|
FP/MDW | Lijst van waarden | Test of de waarde overeenkomst met 1 van de opties (IN). |
avgResponseTime[isnull]
|
FP/MDW | true | false |
Test op ontbrekende waarden (IS NULL / IS NOT NULL). |
avgResponseTime[gte]
|
FP/MDW | Test op groter dan of gelijk (>=). |
|
avgResponseTime[not]
|
FP/MDW | Test of waarde niet overeenkomt (!=). |
|
avgResponseTime[lte]
|
FP/MDW | Test op kleiner dan of gelijk (<=). |
|
avgResponseTime[lt]
|
FP/MDW | Test op kleiner dan (<). |
|
avgResponseTime[gt]
|
FP/MDW | Test op groter dan (>). |
|
endDateTime
|
FP/MDW | yyyy-mm-dd of yyyy-mm-ddThh:mm[:ss[.ms]] |
Test op exacte waarde (==) |
endDateTime[in]
|
FP/MDW | Lijst van waarden | Test of de waarde overeenkomst met 1 van de opties (IN). |
endDateTime[isnull]
|
FP/MDW | true | false |
Test op ontbrekende waarden (IS NULL / IS NOT NULL). |
endDateTime[gte]
|
FP/MDW | Test op groter dan of gelijk (>=). |
|
endDateTime[not]
|
FP/MDW | Test of waarde niet overeenkomt (!=). |
|
endDateTime[lte]
|
FP/MDW | Test op kleiner dan of gelijk (<=). |
|
endDateTime[lt]
|
FP/MDW | Test op kleiner dan (<). |
|
endDateTime[gt]
|
FP/MDW | Test op groter dan (>). |
|
endpoint
|
FP/MDW | Tekst | Test op exacte waarde (==) |
endpoint[in]
|
FP/MDW | Lijst van waarden | Test of de waarde overeenkomst met 1 van de opties (IN). |
endpoint[like]
|
FP/MDW | Tekst met jokertekens (* en ?). |
Test op gedeelte van tekst. |
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[not]
|
FP/MDW | Test of waarde niet overeenkomt (!=). |
|
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[like]
|
FP/MDW | Tekst met jokertekens (* en ?). |
Test op gedeelte van tekst. |
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[not]
|
FP/MDW | Test of waarde niet overeenkomt (!=). |
|
maxResponseTime
|
FP/MDW | Getal | Test op exacte waarde (==) |
maxResponseTime[in]
|
FP/MDW | Lijst van waarden | Test of de waarde overeenkomst met 1 van de opties (IN). |
maxResponseTime[isnull]
|
FP/MDW | true | false |
Test op ontbrekende waarden (IS NULL / IS NOT NULL). |
maxResponseTime[gte]
|
FP/MDW | Test op groter dan of gelijk (>=). |
|
maxResponseTime[not]
|
FP/MDW | Test of waarde niet overeenkomt (!=). |
|
maxResponseTime[lte]
|
FP/MDW | Test op kleiner dan of gelijk (<=). |
|
maxResponseTime[lt]
|
FP/MDW | Test op kleiner dan (<). |
|
maxResponseTime[gt]
|
FP/MDW | Test op groter dan (>). |
|
minResponseTime
|
FP/MDW | Getal | Test op exacte waarde (==) |
minResponseTime[in]
|
FP/MDW | Lijst van waarden | Test of de waarde overeenkomst met 1 van de opties (IN). |
minResponseTime[isnull]
|
FP/MDW | true | false |
Test op ontbrekende waarden (IS NULL / IS NOT NULL). |
minResponseTime[gte]
|
FP/MDW | Test op groter dan of gelijk (>=). |
|
minResponseTime[not]
|
FP/MDW | Test of waarde niet overeenkomt (!=). |
|
minResponseTime[lte]
|
FP/MDW | Test op kleiner dan of gelijk (<=). |
|
minResponseTime[lt]
|
FP/MDW | Test op kleiner dan (<). |
|
minResponseTime[gt]
|
FP/MDW | Test op groter dan (>). |
|
startDateTime
|
FP/MDW | yyyy-mm-dd of yyyy-mm-ddThh:mm[:ss[.ms]] |
Test op exacte waarde (==) |
startDateTime[in]
|
FP/MDW | Lijst van waarden | Test of de waarde overeenkomst met 1 van de opties (IN). |
startDateTime[isnull]
|
FP/MDW | true | false |
Test op ontbrekende waarden (IS NULL / IS NOT NULL). |
startDateTime[gte]
|
FP/MDW | Test op groter dan of gelijk (>=). |
|
startDateTime[not]
|
FP/MDW | Test of waarde niet overeenkomt (!=). |
|
startDateTime[lte]
|
FP/MDW | Test op kleiner dan of gelijk (<=). |
|
startDateTime[lt]
|
FP/MDW | Test op kleiner dan (<). |
|
startDateTime[gt]
|
FP/MDW | Test op groter dan (>). |
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:
| Veld ID | Veldnaam | Type | Identifier | Omschrijving |
|---|---|---|---|---|
id
|
id | String | ☑ | Id |
startDateTime
|
Begintijd van de meting | Datetime | Begintijd van het aantal requests | |
endDateTime
|
Eindtijd van de meting | Datetime | Eindtijd van het aantal requests | |
endpoint
|
Dataset endpoint | String | Dataset endpoint | |
failedRequests
|
Failed requests | Integer | Het aantal requests die niet succesvol zijn uitgevoerd HTTP_4XX en HTTP_5XX | |
successfullRequests
|
Successfull Requests | 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[in]
|
FP/MDW | Lijst van waarden | Test of de waarde overeenkomst met 1 van de opties (IN). |
endDateTime[isnull]
|
FP/MDW | true | false |
Test op ontbrekende waarden (IS NULL / IS NOT NULL). |
endDateTime[gte]
|
FP/MDW | Test op groter dan of gelijk (>=). |
|
endDateTime[not]
|
FP/MDW | Test of waarde niet overeenkomt (!=). |
|
endDateTime[lte]
|
FP/MDW | Test op kleiner dan of gelijk (<=). |
|
endDateTime[lt]
|
FP/MDW | Test op kleiner dan (<). |
|
endDateTime[gt]
|
FP/MDW | Test op groter dan (>). |
|
endpoint
|
FP/MDW | Tekst | Test op exacte waarde (==) |
endpoint[in]
|
FP/MDW | Lijst van waarden | Test of de waarde overeenkomst met 1 van de opties (IN). |
endpoint[like]
|
FP/MDW | Tekst met jokertekens (* en ?). |
Test op gedeelte van tekst. |
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[not]
|
FP/MDW | Test of waarde niet overeenkomt (!=). |
|
failedRequests
|
FP/MDW | Geheel getal | Test op exacte waarde (==) |
failedRequests[in]
|
FP/MDW | Lijst van waarden | Test of de waarde overeenkomst met 1 van de opties (IN). |
failedRequests[isnull]
|
FP/MDW | true | false |
Test op ontbrekende waarden (IS NULL / IS NOT NULL). |
failedRequests[gte]
|
FP/MDW | Test op groter dan of gelijk (>=). |
|
failedRequests[not]
|
FP/MDW | Test of waarde niet overeenkomt (!=). |
|
failedRequests[lte]
|
FP/MDW | Test op kleiner dan of gelijk (<=). |
|
failedRequests[lt]
|
FP/MDW | Test op kleiner dan (<). |
|
failedRequests[gt]
|
FP/MDW | Test op groter dan (>). |
|
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[like]
|
FP/MDW | Tekst met jokertekens (* en ?). |
Test op gedeelte van tekst. |
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[not]
|
FP/MDW | Test of waarde niet overeenkomt (!=). |
|
startDateTime
|
FP/MDW | yyyy-mm-dd of yyyy-mm-ddThh:mm[:ss[.ms]] |
Test op exacte waarde (==) |
startDateTime[in]
|
FP/MDW | Lijst van waarden | Test of de waarde overeenkomst met 1 van de opties (IN). |
startDateTime[isnull]
|
FP/MDW | true | false |
Test op ontbrekende waarden (IS NULL / IS NOT NULL). |
startDateTime[gte]
|
FP/MDW | Test op groter dan of gelijk (>=). |
|
startDateTime[not]
|
FP/MDW | Test of waarde niet overeenkomt (!=). |
|
startDateTime[lte]
|
FP/MDW | Test op kleiner dan of gelijk (<=). |
|
startDateTime[lt]
|
FP/MDW | Test op kleiner dan (<). |
|
startDateTime[gt]
|
FP/MDW | Test op groter dan (>). |
|
successfullRequests
|
FP/MDW | Geheel getal | Test op exacte waarde (==) |
successfullRequests[in]
|
FP/MDW | Lijst van waarden | Test of de waarde overeenkomst met 1 van de opties (IN). |
successfullRequests[isnull]
|
FP/MDW | true | false |
Test op ontbrekende waarden (IS NULL / IS NOT NULL). |
successfullRequests[gte]
|
FP/MDW | Test op groter dan of gelijk (>=). |
|
successfullRequests[not]
|
FP/MDW | Test of waarde niet overeenkomt (!=). |
|
successfullRequests[lte]
|
FP/MDW | Test op kleiner dan of gelijk (<=). |
|
successfullRequests[lt]
|
FP/MDW | Test op kleiner dan (<). |
|
successfullRequests[gt]
|
FP/MDW | Test op groter dan (>). |