Dokumentation API v1

Empfehlen

Geben Sie bei einem oder mehreren Anfangsbuchstaben eines Ortes eine Liste von Ortsnamen an. Die Ausgabe ist alphabetisch sortiert.
Nachdem du einen Ort ausgewählt hast, kannst du auch Vorschläge für den Namen der Straße an diesem Ort machen.

Wenn mehr als ein nl_fourpps zurückgegeben werden, zeigt die Postleitzahl an der ersten Stelle das Zentrum an, die anderen sind in numerischer Reihenfolge.


Vorschlag Teil 1: Suche nach einer Unterkunft

Es ist möglich, sowohl in Den Haag als auch in Den Haag zu suchen. Das Feld "official_city" gibt in beiden Fällen "s-Gravenhage" an.

Akzente und Satzzeichen können ebenfalls weggelassen werden.

Obligatorische Parameter

  • Stadt: Geben Sie einen oder mehrere Anfangsbuchstaben einer niederländischen Stadt ein.

Optionale Parameter

  • per_page: die maximale Anzahl der daraus resultierenden Stellen. Standardmäßig ist dies 10.

Ergebnisbeispiel

undefined/v1/suggest?auth_key=YOUR_AUTH_KEY&per_page=2&nl_city=bergen

Diese Anwendung liefert das folgende Ergebnis:

{
  "status": "ok",
  "results": [
    {
      "province": "Limburg",
      "municipality": "Bergen",
      "city_key": "bergenbergenlimburg",
      "city": "Bergen (Bergen, Limburg)",
      "official_city": "Bergen",
      "nl_fourpps": "5854",
      "lat": 51.60137,
      "lng": 6.05422
    },
    {
      "province": "Noord-Holland",
      "municipality": "Bergen",
      "city_key": "bergenbergennoordholland",
      "city": "Bergen (Bergen, Noord-Holland)",
      "official_city": "Bergen",
      "nl_fourpps": "1860,1861,1862",
      "lat": 52.66891,
      "lng": 4.70604
    }
  ]
}

Vorschlag Teil 2: Finden Sie eine Straße in der Stadt.

Einige Ortsnamen und/oder Ortsnamen sind gebräuchlicher. Diese Zusatzinformationen sind in Klammern hinter dem Ortsnamen angegeben. Um die Straßennamen am richtigen Ort zu finden, wird der Ort dann durch den eindeutigen city_key identifiziert. Beachten Sie, dass die Gültigkeit von city_key begrenzt ist. In der Praxis ist der Schlüssel mindestens 24 Stunden lang gültig.

Obligatorische Parameter

  • city_key: Geben Sie die eindeutige Identifikation eines niederländischen Ortes ein, die in Schritt 1 bestimmt wird.
  • street: Geben Sie einen oder mehrere Anfangsbuchstaben einer niederländischen Straße an dem durch den city_key identifizierten Ort ein.

Optionale Parameter

  • streetnumber: Geben Sie eine Hausnummer ein, um die genaue Postleitzahl für diese Hausnummer in der Straße zu erhalten.
  • Erweiterung: Geben Sie einen Hausnummernzusatz ein, um dadurch die genaue Postleitzahl für diese Hausnummer in der Straße zu erhalten.
  • per_page: die maximale Anzahl von Straßen als Ergebnis. Standardmäßig ist dies 10.

Ergebnisbeispiel

undefined/v1/suggest?auth_key=YOUR_AUTH_KEY&per_page=2&street=a&city_key=agZwcm82cHByJQsSDENpdHlTdWdnZXN0MiITYmVyZ2VuYmVyZ2VubGltYnVyZwwa

Diese Anwendung liefert das folgende Ergebnis:

{
  "status": "ok",
  "results": [
    {
      "street": "Acaciastraat",
      "nl_sixpps": "5854GX",
      "lat": 51.59995,
      "lng": 6.05188
    },
    {
      "street": "Aijen",
      "nl_sixpps": "5854PP,5854PR",
      "lat": 51.58311,
      "lng": 6.0428
    }
  ]
}

Fehlermeldungen

  • Parameter city is required
    Geben Sie dem Webservice den Parameter'city'. Dies kann sowohl in der URL (GET) als auch im Body (POST) erfolgen.
  • Parameter per_page expected int as datatype
    Der Parameter'per_page' muss eine Zahl enthalten.
  • The value of per_page should be between 1 and 1000
    Der Parameter'per_page' muss eine Zahl zwischen 1 und 1000 enthalten.
  • city not found
    Es gibt keine bekannte Position, die mit den angegebenen Buchstaben beginnt.
  • invalid city_key
    Der city_key ist unbekannt.
  • street not found
    Es gibt keine bekannte Straße, die mit den angegebenen Buchstaben beginnt.
  • Specify either nl_city or city_key
    Ein Parameter fehlt.

Beispielcode


Die Methode suggest wird in diesen gebrauchsfertigen Beispielen demonstriert:

Wir empfehlen Ihnen, Mustercode in Ihrer bevorzugten Sprache anzufordern. In der Zwischenzeit sollten Sie sich die Autovervollständigung ansehen, die bereits in vielen Sprachen demonstriert wurde.

Schritt-für-Schritt Beispiel in JavaScript


Schritt 1: Erstellen der HTML-Seite

Wir beginnen damit, eine leere HTML-Seite mit einer minimalen Webseitenstruktur zu erstellen.

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

Laden Sie unsere JavaScript-Bibliothek suggest.js herunter, die es uns ermöglicht, den Pro6PP-Webservice in diese Webseite zu integrieren. Kopieren Sie es in den gleichen Ordner, in dem Sie die obige Webseite gespeichert haben.

Füge den folgenden Code zwischen den Tags <body und </body hinzu.

Es fügt die Eingabefelder für die Eingabe der Adresse hinzu.

<form action="#" class="address">
  City: <input class="city" /> <span class="city_message"></span><br />
  Street: <input class="street" />
  <span class="street_message"></span>
</form>

Schritt 2: Interaktion hinzufügen

Füge den folgenden Code zwischen den Tags <head> und </head> hinzu. Es schlägt mögliche Ortsnamen vor, während der Benutzer tippt.

<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="suggest.js"></script>
<script>
  var pro6pp_auth_key = 'YOUR AUTH_KEY';
  $(document).ready(function() {
    $('.address').applySuggest();
  });
</script>

Schritt 3: Lass es funktionieren

Um auf den Pro6PP-Webservice zuzugreifen, müssen Sie Ihren persönlichen Autorisierungsschlüssel anfordern. Dieser Schlüssel wird dir sofort nach signing up per E-Mail zugesandt.

Ersetzen Sie die obige temporäre Angabe YOUR AUTH_KEY durch Ihren persönlichen Autorisierungsschlüssel.

Schritt 4: Sehen Sie es in Aktion

Öffnen Sie suggest.html in Ihrem Browser. Es ist gebrauchsfertig!
Funktioniert es nicht? Versuchen Sie, den vorgefertigten Beispielcode von der Seite example code herunterzuladen.