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.

WFS handmatig koppelen

De WFS server kan rechtstreeks vanuit de browser of HTTP-client (curl e.d.) uitgelezen worden. Gebruik de basis URL https://api.data.amsterdam.nl/v1/wfs/{<dataset naam>}/ in een WFS-client.

Voor HTTP-clients voeg je ?SERVICE=WFS&VERSION=2.0.0&REQUEST=GetFeature&TYPENAMES={laagnaam} toe. De parameters ?expand en ?embed (elders beschreven) werken ook.

Exportformats

De volgende exportformats zijn beschikbaar:

GeoJSON
CSV

Deze worden opgevraagd door zelf een GetFeature aanvraag samen te stellen. Hiervoor zijn de parameters TYPENAMES={laagnaam} en OUTPUTFORMAT={format} nodig. De volledige URL wordt dan:

https://api.data.amsterdam.nl/v1/wfs/{dataset}/?SERVICE=WFS&VERSION=2.0.0&REQUEST=GetFeature&TYPENAMES={laagnaam}&OUTPUTFORMAT={format}.

Bijvoorbeeld:

Relaties bij exportformats

De exportformats ondersteunen tevens het embedden/nesten van relaties. Hiervoor is het voldoende om de nesting-parameters te gebruiken bij het export links.

Bijvoorbeeld:

Geometrie projectie

De exportlink kan uitgebreid worden met de SRSNAME parameter om geometrie velden in de gewenste projectie te ontvangen. Bijvoorbeeld: SRSNAME=urn:ogc:def:crs:EPSG::3857 voor de web-mercator projectie die Google Maps gebruikt. De toegestane projecties zijn:

Projectie	Toelichting
`urn:ogc:def:crs:EPSG::28992`	Nederlandse rijksdriehoekscoördinaten (RD New).
`urn:ogc:def:crs:EPSG::4258`	ETRS89, Europese projectie.
`urn:ogc:def:crs:EPSG::3857`	Pseudo-Mercator (vergelijkbaar met Google Maps)
`urn:ogc:def:crs:EPSG::4326`	WGS 84 latitude-longitude, wereldwijd.
`urn:ogc:def:crs:OGC::CRS84`	WGS 84 longitude/latitude. Coordinaten zijn in x/y volgorde, o.a. gebruikt in GeoJSON.
`EPSG:4326`	De oude notatie voor WGS 84, en geeft coordinaten in de oude longitude/latitude volgorde.

Wie goed oplet ziet dat WFS 2.0 de coördinaatvolgorde van de autoriteit aanhoud. Gebruik daarvoor wel de aanbevolen OGC-notatie van urn:ogc:def:crs:EPSG::4326 of http://www.opengis.net/def/crs/epsg/0/4326.

Compatibiliteit

In veel legacy-software wordt nog EPSG:4326 als notatie gebruikt, en aangenomen dat er longitude/latitude coördinaten zijn. Wie deze code gebruikt in de SRSNAME of BBOX, zal de coordinaten ook in deze legacy volgorde ontvangen. Moderne GIS pakketten gebruiken allemaal de aanbevolen OGC-notatie, en hebben hier geen last van.

Eenvoudige Filters

Het WFS-protocol biedt een krachtige syntax voor het filteren van data. Gebruik hiervoor REQUEST=GetFeature en het FILTER argument, waarbij de waarde als XML wordt uitgedrukt:

<Filter>
    <PropertyIsEqualTo>
        <ValueReference>ligt_in_stadsdeel/naam</ValueReference>
        <Literal>Centrum</Literal>
    </PropertyIsEqualTo>
</Filter>

Dit wordt dan in de request verwerkt, bijvoorbeeld:

...&TYPENAMES=wijken&OUTPUTFORMAT=geojson&FILTER=%3CFilter%3E%3CPropertyIsEqualTo%3E%3CValueReference...

De FILTER parameter vervangt de losse parameters BBOX en RESOURCEID. Als je deze parameters ook gebruikt, moet je deze opnemen in het filter:

<Filter>
    <And>
        <BBOX>
            <gml:Envelope srsName="EPSG:4326">
                <gml:lowerCorner>4.58565 52.03560</gml:lowerCorner>
                <gml:upperCorner>5.31360 52.48769</gml:upperCorner>
            </gml:Envelope>
        </BBOX>
        <PropertyIsEqualTo>
            <ValueReference>status</ValueReference>
            <Literal>1</Literal>
        </PropertyIsEqualTo>
    </And>
</Filter>

De RESOURCEID kan in het filter meermaals voorkomen:

<Filter>
    <ResourceId rid="TYPENAME.123" />
    <ResourceId rid="TYPENAME.4325" />
    <ResourceId rid="OTHERTYPE.567" />
</Filter>

Complexe filters

De WFS Filter Encoding Standaard (FES) ondersteunt veel operatoren. Deze tags worden allemaal ondersteund:

Element	SQL equivalent	Omschrijving
`<PropertyIsEqualTo>`	`{a} == {b}`	Exacte waarde vergelijken tussen 2 expressies.
`<PropertyIsNotEqualTo>`	`{a} != {b}`	Waarde moet ongelijk zijn.
`<PropertyIsLessThan>`	`{a} < {b}`	Waarde 1 moet kleiner zijn dan waarde 2.
`<PropertyIsGreaterThan>`	`{a} > {b}`	Waarde 1 moet groter zijn dan waarde 2.
`<PropertyIsLessThanOrEqualTo>`	`{a} <= {b}`	Waarde 1 moet kleiner of gelijk zijn dan waarde 2.
`<PropertyIsGreaterThanOrEqualTo>`	`{a} >= {b}`	Waarde 1 moet groter of gelijk zijn dan waarde 2.
`<PropertyIsBetween>`	`{a} BETWEEN {x} AND {y}`	Vergelijkt tussen `<LowerBoundary>` en `<UpperBoundary>`, die beiden een expressie bevatten.
`<PropertyIsLike>`	`{a} LIKE {b}`	Voert een wildcard vergelijking uit.
`<PropertyIsNil>`	`{a} IS NULL`	Waarde moet `NULL` zijn (`xsi:nil="true"` in XML).
`<PropertyIsNull>`	n.b.	Property mag niet bestaan (momenteel identiek aan `<PropertyIsNil>` geïmplementeerd).
`<BBOX>`	`ST_Intersects({a}, {b})`	Geometrie moet in waarde 2 voorkomen. De veldnaam mag weggelaten worden.
`<Contains>`	`ST_Contains({a}, {b})`	Geometrie 1 bevat geometrie 2 compleet.
`<Crosses>`	`ST_Crosses({a}, {b})`	Geometrieën lopen door elkaar heen.
`<Disjoint>`	`ST_Disjoint({a}, {b})`	Geometrieën zijn niet verbonden.
`<Equals>`	`ST_Equals({a}, {b})`	Geometrieën moeten gelijk zijn.
`<Intersects>`	`ST_Intersects({a}, {b})`	Geometrieën zitten in dezelfde ruimte.
`<Touches>`	`ST_Touches({a}, {b})`	Randen van de geometrieën raken elkaar.
`<Overlaps>`	`ST_Overlaps({a}, {b})`	Geometrie 1 en 2 overlappen elkaar.
`<Within>`	`ST_Within({a}, {b})`	Geometrie 1 ligt compleet in geometrie 2.
`<And>`	`{a} AND {b}`	De geneste elementen moeten allemaal waar zijn.
`<Or>`	`{a} OR {b}`	Slechts één van de geneste elementen hoeft waar zijn.
`<Not>`	`NOT {a}`	Negatie van het geneste element.
`<ResourceId>`	`table.id == {value}`	Zoekt slechts een enkel element op "typenaam.identifier". Meerdere combineren tot een `IN` query.

Tip

Bij de operator <BBOX> mag het geometrieveld weggelaten worden. Het standaardgeometrieveld wordt dan gebruikt (doorgaans het eerste veld).

Note

Hoewel een aantal geometrie-operatoren dubbelop lijken voor vlakken (zoals <Intersects>, <Crosses> en <Overlaps>), worden de onderlinge verschillen met name zichtbaar bij het vergelijken van punten met vlakken.

Als waarde mogen diverse expressies gebruikt worden:

Expressie	SQL equivalent	Omschrijving
`<ValueReference>`	`{veldnaam}`	Verwijzing naar een veld.
`<Literal>`	waarde	Letterlijke waarde, mag ook een GML-object zijn.
`<Function>`	`{functienaam}(..)`	Uitvoer van een functie, zoals `abs`, `sin`, `strLength`.
`<Add>`	`{a} + {b}`	Waarden optellen (WFS 1 expressie).
`<Sub>`	`{a} - {b}`	Waarden aftrekken (WFS 1 expressie).
`<Mul>`	`{a} * {b}`	Waarden ermenigvuldigen (WFS 1 expressie).
`<Div>`	`{a} / {b}`	Waarden delen (WFS 1 expressie).

Dit maakt complexe filters mogelijk, bijvoorbeeld:

<Filter>
    <And>
        <PropertyIsEqualTo>
            <ValueReference>status</ValueReference>
            <Literal>1</Literal>
        </PropertyIsEqualTo>
        <Or>
            <PropertyIsEqualTo>
                <ValueReference>fractie_omschrijving</ValueReference>
                <Literal>Rest</Literal>
            </PropertyIsEqualTo>
            <PropertyIsEqualTo>
                <ValueReference>fractie_omschrijving</ValueReference>
                <Literal>Textiel</Literal>
            </PropertyIsEqualTo>
            <PropertyIsEqualTo>
                <ValueReference>fractie_omschrijving</ValueReference>
                <Literal>Glas</Literal>
            </PropertyIsEqualTo>
            <PropertyIsEqualTo>
                <ValueReference>fractie_omschrijving</ValueReference>
                <Literal>Papier</Literal>
            </PropertyIsEqualTo>
            <PropertyIsEqualTo>
                <ValueReference>fractie_omschrijving</ValueReference>
                <Literal>Gft</Literal>
            </PropertyIsEqualTo>
            <PropertyIsEqualTo>
                <ValueReference>fractie_omschrijving</ValueReference>
                <Literal>Plastic</Literal>
            </PropertyIsEqualTo>
        </Or>
    </And>
</Filter>

Functies

Functies worden uitgevoerd door met de tag <Function name="..">..</Function>. Dit mag op iedere plek als expressie gebruikt worden in plaats van een <ValueReference> of <Literal>.

Binnen in de function worden de parameters tevens als expressie opgegeven: een <ValueReference>, <Literal> of nieuwe <Function>. Als simpel voorbeeld:

<fes:Function name="sin">
    <fes:ValueReference>fieldname</fes:ValueReference>
</fes:Function>

Aangezien de argumenten een expressie mogen zijn, is het volgende ook mogelijk:

<Filter>
    <PropertyIsEqualTo>
        <Function name="strToLowerCase">
            <Function name="strSubstring">
                <ValueReference>name</ValueReference>
                <Literal>0</Literal>
                <Literal>4</Literal>
            </Function>
        </Function>
        <Literal>cafe</Literal>
    </PropertyIsEqualTo>
</Filter>

De volgende functies zijn beschikbaar in de server, gebaseerd op de filter functies uit GeoServer:

Tekstbewerking

Functie	SQL equivalent	Omschrijving
`strConcat(string)`	`CONCAT()`	Combineert teksten
`strIndexOf(string, substring)`	`STRPOS() - 1`	Zoekt de tekst, met een 0-gebaseerde index.
`strSubstring(string, begin, end)`	`SUBSTRING()`	Verwijderd tekens voor het begin en achter het einde
`strSubstringStart(string, begin)`	`SUBSTRING()`	Verwijderd tekens voor begin, index op 0 gebaseeerd.
`strToLowerCase(string)`	`LOWER()`	Tekst omzetten naar kleine letters.
`strToUpperCase(string)`	`UPPER()`	Tekst omzetten naar hoofdletters
`strTrim(string)`	`TRIM()`	Witruimte aan het begin en einde verwijderen.
`strLength(string)`	`LENGTH()` / `CHAR_LENGTH()`	Tekstlengte bepalen.
`length(string)`	`LENGTH()` / `CHAR_LENGTH()`	Alias van `strLength()`.

Wiskundige getalfuncties

Functie	SQL equivalent	Omschrijving
`abs(number)`	`ABS()`	Negatieve getallen omdraaien.
`ceil(number)`	`CEIL()`	Afronden naar boven.
`floor(number)`	`FLOOR()`	Afronden naar beneden.
`round(value)`	`ROUND()`	Afronden
`min(value1, value2)`	`LEAST()`	Kleinste getal gebruiken.
`max(value1, value2)`	`GREATEST()`	Grootste getal gebruiken.
`pow(base, exponent)`	`POWER()`	Machtsverheffing
`exp(value)`	`EXP()`	Exponent van 𝑒 (2,71828...; natuurlijke logaritme).
`log(value)`	`LOG()`	Logaritme; inverse van een exponent.
`sqrt(value)`	`SQRT()`	Worteltrekken; inverse van machtsverheffen.

Wiskundige trigonometrie

Functie	SQL equivalent	Omschrijving
`acos(value)`	`ACOS()`	Arccosinus; inverse van cosinus.
`asin(value)`	`ASIN()`	Arcsinus; inverse van sinus.
`atan(value)`	`ATAN()`	Arctangens; invere van tangens.
`atan2(x, y)`	`ATAN2()`	Arctangens, voor bereik buiten een circel.
`cos(radians)`	`COS()`	Cosinus
`sin(radians)`	`SIN()`	Sinus
`tan(radians)`	`TAN()`	Tangens
`pi()`	`PI`	De waarde van π (3,141592653...)
`toDegrees(radians)`	`DEGREES()`	Omzetting radialen naar graden.
`toRadians(degree)`	`RADIANS()`	Omzetting graden naar radialen.

Geometrie functies

Functie	SQL equivalent	Omschrijving
`Area(geometry)`	`ST_AREA()`	Geometrie omzetten naar gebied.
`Centroid(features)`	`ST_Centroid()`	Geometrisch centrum als "zwaartekrachtpunt" teruggeven.
`Difference(geometry1, geometry2)`	`ST_Difference()`	Delen van geometrie 1 die niet overlappen met geometrie 2.
`distance(geometry1, geometry2)`	`ST_Distance()`	Minimale afstand tussen 2 geometrieën.
`envelope(geometry)`	`ST_Envelope()`	Geometrie omzetten naar bounding box.
`geomLength(geometry)`	`ST_Length()`	De cartesiaanse lengte voor een lijnstring/curve.
`isValid(geometry)`	`ST_IsValid()`	Geometrie moet geldig zijn.
`numGeometries(geometry)`	`ST_NumGeometries()`	Hoeveel geometrieën er in een collectie zitten.
`numPoints(geometry)`	`ST_NumPoints()`	Hoeveel punten er in een lijn zitten.
`perimeter(geometry)`	`ST_Perimeter()`	De 2D-omtrek van het oppervlak of veelhoek.
`Intersection(geometry1, geometry2)`	`ST_Intersection()`	Delen van geometrie 1 die overlappen met geometrie 2.
`Union(geometry1, geometry2)`	`ST_Union()`	Geometrie 1 en 2 samenvoegen.

XML POST requests gebruiken

Als een filter te lang is voor de query-string, kan je ook een XML POST request gebruiken in plaats van het KVP query-string formaat.

Een GET aanvraag zoals:

?SERVICE=WFS&VERSION=2.0.0&REQUEST=GetFeature
&TYPENAMES=app:restaurant
&FILTER=<Filter>...</Filter>
&PROPERTYNAME=app:id,app:name,app:location
&SORTBY=app:name ASC

...kan ook worden ingestuurd als XML-gecodeerde POST aanvraag:

<wfs:GetFeature service="WFS" version="2.0.0"
    xmlns:wfs="http://www.opengis.net/wfs/2.0"
    xmlns:gml="http://www.opengis.net/gml/3.2"
    xmlns:fes="http://www.opengis.net/fes/2.0"
    xmlns:app="https://api.data.amsterdam.nl/v1/wfs/">

  <wfs:Query typeNames="app:restaurant">
    <wfs:PropertyName>app:id</wfs:PropertyName>
    <wfs:PropertyName>app:name</wfs:PropertyName>
    <wfs:PropertyName>app:location</wfs:PropertyName>

    <fes:Filter>
      ...
    </fes:Filter>

    <fes:SortBy>
      <fes:SortProperty>
        <fes:ValueReference>app:name</fes:ValueReference>
        <fes:SortOrder>ASC</fes:SortOrder>
      </fes:SortProperty>
    </fes:SortBy>
  </wfs:Query>
</wfs:GetFeature>

Filter compatibiliteit

Ontbrekende XML-namespaces

Officieel zijn XML-namespaces verplicht in het filter. Aangezien veel clients deze achterwege laten, ondersteunt de server ook aanvragen zonder namespaces. Voor de volledigheid zal het request er met namespaces zo uit zien:

<fes:Filter xmlns:fes="http://www.opengis.net/fes/2.0"
        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
        xsi:schemaLocation="http://www.opengis.net/fes/2.0
        http://schemas.opengis.net/filter/2.0/filterAll.xsd">
    <fes:PropertyIsEqualTo>
        <fes:ValueReference>stadsdeel/naam</fes:ValueReference>
        <fes:Literal>Centrum</fes:Literal>
    </fes:PropertyIsEqualTo>
</fes:Filter>

Bij geometriefilters is dat officieel zelfs:

<fes:Filter
    xmlns:fes="http://www.opengis.net/fes/2.0"
    xmlns:gml="http://www.opengis.net/gml/3.2"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://www.opengis.net/fes/2.0
    http://schemas.opengis.net/filter/2.0/filterAll.xsd
    http://www.opengis.net/gml/3.2 http://schemas.opengis.net/gml/3.2.1/gml.xsd">
    <fes:BBOX>
        <gml:Polygon gml:id="P1" srsName="http://www.opengis.net/def/crs/epsg/0/4326">
            <gml:exterior>
                <gml:LinearRing>
                    <gml:posList>10 10 20 20 30 30 40 40 10 10</gml:posList>
                </gml:LinearRing>
            </gml:exterior>
        </gml:Polygon>
    </fes:BBOX>
</fes:Filter>

Conform de XML-regels mag hier de "fes" namespace alias hernoemd worden, of weggelaten worden als er alleen xmlns="..." gebruikt wordt i.p.v. xmlns:fes="...".

Oudere filter syntax

Diverse bestaande filters gebruiken nog andere WFS 1-elementen, zoals <PropertyName> in plaats van <ValueReference>. Voor compatibiliteit wordt deze tag ook ondersteund.

De WFS 1-expressies <Add>, <Sub>, <Mul> en <Div> zijn tevens geïmplementeerd om rekenkundige operaties te ondersteunen vanuit QGIS (optellen, aftrekken, vermenigvuldigen en delen).