Toepassingen van Pro6PP

Copy-paste

Zoeken binnen een straal

Na het invullen van een postcode worden de omringende postcodes getoond.

Met de volgende aanroep krijg je alle postcodes terug in de buurt van postcode 5408

http://api.pro6pp.nl/v1/range?auth_key=YOUR_AUTH_KEY&nl_fourpp=5408

{"status": "ok",
 "results": [ {"lat": 51.65, "nl_fourpp": "5408", "lng": 5.65},
              {"lat": 51.666667, "nl_fourpp": "5400", "lng": 5.616667},
              {"lat": 51.666667, "nl_fourpp": "5401", "lng": 5.616667},
              {"lat": 51.666667, "nl_fourpp": "5402", "lng": 5.616667},
              {"lat": 51.666667, "nl_fourpp": "5403", "lng": 5.616667},
              {"lat": 51.666667, "nl_fourpp": "5404", "lng": 5.616667},
              {"lat": 51.666667, "nl_fourpp": "5405", "lng": 5.616667},
              {"lat": 51.666667, "nl_fourpp": "5406", "lng": 5.616667},
              {"lat": 51.65, "nl_fourpp": "5409", "lng": 5.7}
            ]
}

De standaard zoekstraal is 5000 meter (range), het aantal resultaten 10 (per_page).

Zoeken in een omtrek van 80km, maar maximaal 20 resultaten:

http://api.pro6pp.nl/v1/range?auth_key=YOUR_AUTH_KEY&nl_fourpp=5408&range=80000&per_page=20

Code voorbeelden

De communicatie met de webservice werkt op basis van een HTTP GET, welke JSON data teruggeeft.
Dit onderwerp bevat code voorbeeld in deze talen:

• Javascript

(Doe een aanvraag voor een voorbeeld in Java/Python/Ruby/Visual Basic/andere taal of kijk bij autocomplete voor extra voorbeelden)

API call: range

Behalve Javascript kan in principe elke programmeertaal worden gebruikt. Dit zijn de instructies voor algemeen gebruik.

Er zijn 2 parameters verplicht:
De 'auth_key' parameter. Dit is de key welke is toegewezen bij het openen van een Pro6PP (proef)account.
De 'nl_fourpp' parameter. Geef hier de 4 cijfers van de postcode van waaruit de omringende postcodes gezocht worden.

Er zijn optionele parameters:
De 'range' parameter. Dit is de gewenste omtrek waarin gezocht wordt - in meters. Zonder opgave is dit 5000m.
De 'per_page' parameter. Het maximaal aantal postcodes als resultaat. Zonder opgave is dit 10.

In plaats van het gewenste resultaat kunnen er ook foutmeldingen optreden. Deze foutmeldingen volgen deze vorm:

{'status': 'error',
 'results': [],
 'error': {'message': 'nl_fourpp not found'}
}

'Parameter nl_fourpp is required': Geef de parameter 'nl_fourpp' mee aan de webservice. Dit mag zowel in de URL (GET) als in de body (POST).
'Invalid nl_fourpp format': Het formaat dient te bestaan uit 4 cijfers.
'nl_fourpp not found': De opgevraagde postcode is niet bekend in de database.
'Parameter per_page expected int as datatype': Parameter 'per_page' dient een getal te bevatten.
'The value of per_page should be between 1 and 1000': Parameter 'per_page' dient een getal te bevatten tussen de 1 en 1000.
'Parameter range expected int as datatype': Parameter 'range' dient een getal te bevatten.
'The value of range should be between 1 and 1000': Parameter 'range' dient een omtrek (in meters) te bevatten tussen de 0 en 100000.

Algemene foutmeldingen zijn elders beschreven.