Documentatie API v1

Afstand

Deze API oproep berekent de reisafstand en de tijd tussen twee postcodes.


Vereiste parameters

Geef een combinatie van beide Nederlandse 4PP:

  • from_nl_fourpp: Geef een Nederlandse postcode met 4 posities.
  • to_nl_fourpp: geef een Nederlandse postcode met de postcode 4 op.

of een combinatie van Nederlandse 6PP:

  • from_nl_sixpp: Geef een Nederlandse postcode voor het starten van de postcode.
  • to_nl_sixpp: geef een Nederlandse postcode met de postcode 6 op.

Note: Omdat de DTM tabel van elke 6PP postcode tot elke andere 6PP postcode erg groot zou zijn, zijn alleen de postcodes met een maximale afstand van 5 km opgenomen in de dataset. Als u wilt weten wat de reistijd of afstand tussen de postcodes verder uit elkaar ligt, keert u terug naar alleen de 4PP postcodes.

of Belgische postcodes:

  • from_be_fourpp: geef een Belgische start postcode op.
  • to_be_fourpp: geef een Belgische postcode op.

Optionele parameters

  • algorithm: kies een algoritme. road om de werkelijke reisafstand en tijd over werkelijke wegen te berekenen, of straight om de afstand in een rechte lijn te berekenen.

    Elk abonnement geeft toegang tot de afstand van de rechte lijn, maar het algoritme maakt gebruik van de rijtijd matrix (kortste route) waarvoor een "ontwikkelingsagentschap" of hoger abonnementsniveau vereist is wanneer deze via de API wordt gebruikt.

    Voor proefdoeleinden is een reeks postcodes toegestaan met elk abonnementsniveau: 1000..1098, 1100..1108 (Amsterdam), 3000..3089 (Rotterdam), 5600..5658 (Eindhoven).

Voorbeelden

Op de weg

In dit voorbeeld worden de reisafstand en tijd over de weg tussen twee Nederlandse postcodes verkregen.

GET https://api.pro6pp.nl/v1/distance?auth_key=YOUR_AUTH_KEY&from_nl_fourpp=5408&to_nl_fourpp=5652&algorithm=road HTTP/1.1
Content-Type: application/json; charset=utf-8


{
  "status": "ok",
  "results": {
    "distance": 36800,
    "duration": 24
  }
}

In een rechte lijn

In dit voorbeeld wordt de rechte lijnafstand tussen twee Belgische postcodes verkregen. Het gekozen uitvoerformaat is XML.

GET https://api.pro6pp.nl/v1/distance?auth_key=YOUR_AUTH_KEY&from_be_fourpp=2000&to_be_fourpp=4000&algorithm=straight&format=xml HTTP/1.1
Content-Type: application/xml; charset=utf-8


<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>ok</status>
  <results>
    <distance>105674</distance>
  </results>
</response>

Voorbeeldcode


De distance methode wordt gedemonstreerd in deze voorbeelden:

We moedigen u aan om een voorbeeldcode aan te vragen in de taal van uw voorkeur. In de tussentijd wilt u misschien kijken naar de autocomplete methode, die al in vele talen is gedemonstreerd.

Stap voor stap voorbeeld in JavaScript


Stap 1: bouw de HTML-pagina

We beginnen met het maken van een lege HTML-pagina met een minimale webpagina structuur.

<!DOCTYPE html>
<html>
  <head>
    <meta charset="UTF-8" />
    <title>Distance tutorial</title>
  </head>
  <body></body>
</html>

Download onze JavaScript-bibliotheek distance.js waarmee we de Pro6PP-webservice kunnen integreren in deze webpagina. Kopieer het in dezelfde map als waarin u de bovenstaande webpagina hebt opgeslagen.

Voeg de volgende code toe tussen de tags <body> en <body>.

Het voegt de invoervelden toe voor het invoeren van de coördinaten.

<form class="distance">
  From postcode: <input type="number" data-binding="from-nl-fourpp" /><br />
  To postcode: <input type="number" data-binding="to-nl-fourpp" /><br />
  <span data-binding="message"></span><br />
  Distance (meters): <input type="number" data-binding="distance" /> Duration (minutes):
  <input type="number" data-binding="duration" />
</form>

Stap 2: voeg interactie toe

Voeg de volgende code toe tussen de tags <head> en </head>. Het suggereert mogelijke plaatsnamen terwijl de gebruiker aan het typen is.

<script src="https://code.jquery.com/jquery-1.11.2.min.js"></script>
<link rel="stylesheet" href="https://code.jquery.com/ui/1.11.2/themes/smoothness/jquery-ui.css" />
<script src="https://code.jquery.com/ui/1.11.2/jquery-ui.min.js"></script>
<script src="distance.js"></script>
<script>
  var pro6ppAuthKey = 'YOUR AUTH_KEY';
  var algorithm = 'road'; // or 'straight'
  $(document).ready(function() {
    $('.distance').applyDistance({
      algorithm: algorithm,
      pro6ppAuthKey: pro6ppAuthKey,
    });
  });
</script>

Stap 3: laat het werken

Om toegang te krijgen tot de Pro6PP webservice, moet u uw persoonlijke autorisatiesleutel aanvragen. Deze sleutel wordt direct na signing up naar u gemaild.

Vervang de bovenstaande tijdelijke aanduiding YOUR AUTH_KEY door uw persoonlijke autorisatiesleutel.

Stap 4: zie het in actie

Open distance.html in uw browser. Het is klaar voor gebruik!
Werkt het niet? Probeer de kant-en-klare voorbeeldcode te downloaden op de pagina example code.