Introductie API Keys

Het Dataplatform van de gemeente Amsterdam gaat het gebruik van een identificatie key bij het aanroepen van haar API's vanaf 1 februari 2024 verplicht stellen. Vanaf 1 februari 2024 kun je de API's van het Dataplatform niet meer zonder een key gebruiken. Vraag tijdig een key aan via dit aanvraagformulier. Doe je dit niet, dan werkt je applicatie of website vanaf 1 februari 2024 niet meer. Dit geldt voor alle API's die op deze pagina gedocumenteerd zijn.

Door de API key kunnen we contact houden met de gebruikers van onze API's. Zo kunnen we gebruikers informeren over updates. Daarnaast krijgen we hiermee inzicht in het gebruik van de API's en in wie welke dataset via de API bevraagt. Ook voor dataeigenaren is dit waardevolle informatie.

Meer info:
Pagina API key aanvragen
Technische documentatie
Vragen? Mail naar dataplatform@amsterdam.nl

Endpoints

Tabellen

Authorisatie scopes

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[not] FP/MDW None Test of waarde niet overeenkomt (!=).
id[like] FP/MDW Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
id[isempty] FP/MDW true of false Test of de waarde leeg is (== '' / != '')
id[isnull] FP/MDW true of false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
id[in] FP/MDW Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
naam FP/MDW Tekst Test op exacte waarde (==)
naam[not] FP/MDW None Test of waarde niet overeenkomt (!=).
naam[like] FP/MDW Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
naam[isempty] FP/MDW true of false Test of de waarde leeg is (== '' / != '')
naam[isnull] FP/MDW true of false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
naam[in] FP/MDW Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
packageId FP/MDW Tekst Test op exacte waarde (==)
packageId[not] FP/MDW None Test of waarde niet overeenkomt (!=).
packageId[like] FP/MDW Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
packageId[isempty] FP/MDW true of false Test of de waarde leeg is (== '' / != '')
packageId[isnull] FP/MDW true of false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
packageId[in] FP/MDW Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
packageNaam FP/MDW Tekst Test op exacte waarde (==)
packageNaam[not] FP/MDW None Test of waarde niet overeenkomt (!=).
packageNaam[like] FP/MDW Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
packageNaam[isempty] FP/MDW true of false Test of de waarde leeg is (== '' / != '')
packageNaam[isnull] FP/MDW true of false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
packageNaam[in] FP/MDW Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
packageUrl FP/MDW Tekst Test op exacte waarde (==)
packageUrl[not] FP/MDW None Test of waarde niet overeenkomt (!=).
packageUrl[like] FP/MDW Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
packageUrl[isempty] FP/MDW true of false Test of de waarde leeg is (== '' / != '')
packageUrl[isnull] FP/MDW true of false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
packageUrl[in] FP/MDW Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).

Dso performance

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[lt] FP/MDW None Test op kleiner dan (<).
avgResponseTime[not] FP/MDW None Test of waarde niet overeenkomt (!=).
avgResponseTime[gt] FP/MDW None Test op groter dan (>).
avgResponseTime[isnull] FP/MDW true of false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
avgResponseTime[gte] FP/MDW None Test op groter dan of gelijk (>=).
avgResponseTime[lte] FP/MDW None Test op kleiner dan of gelijk (<=).
avgResponseTime[in] FP/MDW Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
endDateTime FP/MDW yyyy-mm-dd of yyyy-mm-ddThh:mm[:ss[.ms]] Test op exacte waarde (==)
endDateTime[lt] FP/MDW None Test op kleiner dan (<).
endDateTime[not] FP/MDW None Test of waarde niet overeenkomt (!=).
endDateTime[gt] FP/MDW None Test op groter dan (>).
endDateTime[isnull] FP/MDW true of false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
endDateTime[gte] FP/MDW None Test op groter dan of gelijk (>=).
endDateTime[lte] FP/MDW None Test op kleiner dan of gelijk (<=).
endDateTime[in] FP/MDW Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
endpoint FP/MDW Tekst Test op exacte waarde (==)
endpoint[not] FP/MDW None Test of waarde niet overeenkomt (!=).
endpoint[like] FP/MDW Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
endpoint[isempty] FP/MDW true of false Test of de waarde leeg is (== '' / != '')
endpoint[isnull] FP/MDW true of false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
endpoint[in] FP/MDW Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
id FP/MDW Tekst Test op exacte waarde (==)
id[not] FP/MDW None Test of waarde niet overeenkomt (!=).
id[like] FP/MDW Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
id[isempty] FP/MDW true of false Test of de waarde leeg is (== '' / != '')
id[isnull] FP/MDW true of false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
id[in] FP/MDW Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
maxResponseTime FP/MDW Getal Test op exacte waarde (==)
maxResponseTime[lt] FP/MDW None Test op kleiner dan (<).
maxResponseTime[not] FP/MDW None Test of waarde niet overeenkomt (!=).
maxResponseTime[gt] FP/MDW None Test op groter dan (>).
maxResponseTime[isnull] FP/MDW true of false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
maxResponseTime[gte] FP/MDW None Test op groter dan of gelijk (>=).
maxResponseTime[lte] FP/MDW None Test op kleiner dan of gelijk (<=).
maxResponseTime[in] FP/MDW Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
minResponseTime FP/MDW Getal Test op exacte waarde (==)
minResponseTime[lt] FP/MDW None Test op kleiner dan (<).
minResponseTime[not] FP/MDW None Test of waarde niet overeenkomt (!=).
minResponseTime[gt] FP/MDW None Test op groter dan (>).
minResponseTime[isnull] FP/MDW true of false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
minResponseTime[gte] FP/MDW None Test op groter dan of gelijk (>=).
minResponseTime[lte] FP/MDW None Test op kleiner dan of gelijk (<=).
minResponseTime[in] FP/MDW Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
startDateTime FP/MDW yyyy-mm-dd of yyyy-mm-ddThh:mm[:ss[.ms]] Test op exacte waarde (==)
startDateTime[lt] FP/MDW None Test op kleiner dan (<).
startDateTime[not] FP/MDW None Test of waarde niet overeenkomt (!=).
startDateTime[gt] FP/MDW None Test op groter dan (>).
startDateTime[isnull] FP/MDW true of false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
startDateTime[gte] FP/MDW None Test op groter dan of gelijk (>=).
startDateTime[lte] FP/MDW None Test op kleiner dan of gelijk (<=).
startDateTime[in] FP/MDW Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).

Dso usage

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[lt] FP/MDW None Test op kleiner dan (<).
endDateTime[not] FP/MDW None Test of waarde niet overeenkomt (!=).
endDateTime[gt] FP/MDW None Test op groter dan (>).
endDateTime[isnull] FP/MDW true of false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
endDateTime[gte] FP/MDW None Test op groter dan of gelijk (>=).
endDateTime[lte] FP/MDW None Test op kleiner dan of gelijk (<=).
endDateTime[in] FP/MDW Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
endpoint FP/MDW Tekst Test op exacte waarde (==)
endpoint[not] FP/MDW None Test of waarde niet overeenkomt (!=).
endpoint[like] FP/MDW Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
endpoint[isempty] FP/MDW true of false Test of de waarde leeg is (== '' / != '')
endpoint[isnull] FP/MDW true of false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
endpoint[in] FP/MDW Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
failedRequests FP/MDW Geheel getal Test op exacte waarde (==)
failedRequests[lt] FP/MDW None Test op kleiner dan (<).
failedRequests[not] FP/MDW None Test of waarde niet overeenkomt (!=).
failedRequests[gt] FP/MDW None Test op groter dan (>).
failedRequests[isnull] FP/MDW true of false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
failedRequests[gte] FP/MDW None Test op groter dan of gelijk (>=).
failedRequests[lte] FP/MDW None Test op kleiner dan of gelijk (<=).
failedRequests[in] FP/MDW Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
id FP/MDW Tekst Test op exacte waarde (==)
id[not] FP/MDW None Test of waarde niet overeenkomt (!=).
id[like] FP/MDW Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
id[isempty] FP/MDW true of false Test of de waarde leeg is (== '' / != '')
id[isnull] FP/MDW true of false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
id[in] FP/MDW Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
startDateTime FP/MDW yyyy-mm-dd of yyyy-mm-ddThh:mm[:ss[.ms]] Test op exacte waarde (==)
startDateTime[lt] FP/MDW None Test op kleiner dan (<).
startDateTime[not] FP/MDW None Test of waarde niet overeenkomt (!=).
startDateTime[gt] FP/MDW None Test op groter dan (>).
startDateTime[isnull] FP/MDW true of false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
startDateTime[gte] FP/MDW None Test op groter dan of gelijk (>=).
startDateTime[lte] FP/MDW None Test op kleiner dan of gelijk (<=).
startDateTime[in] FP/MDW Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
successfullRequests FP/MDW Geheel getal Test op exacte waarde (==)
successfullRequests[lt] FP/MDW None Test op kleiner dan (<).
successfullRequests[not] FP/MDW None Test of waarde niet overeenkomt (!=).
successfullRequests[gt] FP/MDW None Test op groter dan (>).
successfullRequests[isnull] FP/MDW true of false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
successfullRequests[gte] FP/MDW None Test op groter dan of gelijk (>=).
successfullRequests[lte] FP/MDW None Test op kleiner dan of gelijk (<=).
successfullRequests[in] FP/MDW Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).