Locator Niederlande
BetaSuche nach nahe gelegenen Postleitzahlen anhand einer Postleitzahl oder einer Kombination aus Breiten- und Längengrad.
https://api.pro6pp.nl/v2/locator/nlÜbersicht
Returns your own list of postcodes ordered by distance from a postcode or a lat/lng origin.
ParameterQuery-String
An array of 4PPs (e.g: ["1000", "1011", "1012"]).
- Beispiel
["1016","1012","1011"]
The 4PP(e.g: 1000), if both postalCode and lat/lng combination is given, the lat/lng from the postalCode will be used.
- Beispiel
1017- Muster
^"?([0-9]{4})"?$|^"?([0-9]{4} ?[a-zA-Z]{2})"?$
The latitude.
The longitude.
The order in which to return the results: distance (default) or input (keeps the input ordering).
- Standard
"distance"
The amount of results returned, a number between 1 and 999. Default value is 10.
- Standard
10- Min.
1- Max.
999
Specifies the algorithm for calculating distance and time.
Available Algorithms:
straight: Calculates the distance in a straight line.road: Calculates the actual traveling distance and time using the drive time matrix (shortest route) over the actual road network.- Availability of
roaddepends on your subscription level. - For trial purposes, this algorithm can be used with any subscription level for the following postcode ranges:
1000-1098,1100-1108(Amsterdam)3000-3089(Rotterdam)5600-5658(Eindhoven)
- Availability of
- Standard
"straight"- Einer von
straightroad
Antworten
| Feld | Typ | Beispielwert | Beschreibung |
|---|---|---|---|
| distance | number | 912 | Distance in metres from the origin, in a straight line or by road depending on the selected algorithm. |
| duration | number | nicht im Beispiel | Driving time in minutes, included for the road algorithm. |
| settlement | string | "Amsterdam" | The settlement (woonplaats) that covers most of the postal code area. |
| municipality | string | "Amsterdam" | The municipality (gemeente) of the settlement that covers most of the postal code area. |
| lat | number | 52.374 | Mean latitude of the six-position postal codes within the 4-digit postal code. |
| lng | number | 4.888 | Mean longitude of the six-position postal codes within the 4-digit postal code. |
| postalCode | string | "1016" | The 4-digit postal code. |
| province | string | "Noord-Holland" | The province (provincie). |
| areacode | string | "020" | The telephone area code of the settlement that covers most of the postal code area, such as "020". |
[
{
"areacode": "020",
"distance": 912,
"lat": 52.374,
"lng": 4.888,
"municipality": "Amsterdam",
"postalCode": "1016",
"province": "Noord-Holland",
"settlement": "Amsterdam"
},
{
"areacode": "020",
"distance": 1254,
"lat": 52.378,
"lng": 4.899,
"municipality": "Amsterdam",
"postalCode": "1012",
"province": "Noord-Holland",
"settlement": "Amsterdam"
},
{
"areacode": "020",
"distance": 1340,
"lat": 52.377,
"lng": 4.906,
"municipality": "Amsterdam",
"postalCode": "1011",
"province": "Noord-Holland",
"settlement": "Amsterdam"
}
]Fehler
Felder einer Fehlerantwort
| Feld | Typ | Beschreibung |
|---|---|---|
| error_id | string | The reason the request failed, such as |
| errors | array of object | One entry per problem found in the request. |
| errors[].message | string | A readable explanation of the problem, in English. |
| errors[].help | string | A link to the documentation section that covers the problem. |
| errors[].parameter | any | The parameter the problem is about. Usually its name; a list when several parameters are involved, or a name with the values to choose from when the request must select one. |
| errors[].value | any | The value the request sent for |
MISSING_PARAMETERA parameter that other parameters depend on is missing. errors has one entry per missing parameter.
A parameter that other parameters depend on is missing. errors has one entry per missing parameter.
{
"error_id": "MISSING_PARAMETER",
"errors": [
{
"message": "Required parameter lat is missing",
"help": "https://pro6pp.nl/docs/v2/redoc",
"parameter": "lat"
}
]
}INVALID_PARAMETER_TYPEA value has the wrong type, such as text for a number.
A value has the wrong type, such as text for a number.
{
"error_id": "INVALID_PARAMETER_TYPE",
"errors": [
{
"message": "parameter: lat has invalid 1,0, should be number",
"help": "https://pro6pp.nl/docs/v2/redoc",
"parameter": "lat"
}
]
}INVALID_VALUEA required parameter is missing, or a value is malformed, out of bounds or cannot be found.
A required parameter is missing, or a value is malformed, out of bounds or cannot be found.
{
"error_id": "INVALID_VALUE",
"errors": [
{
"message": "value is invalid",
"help": "https://pro6pp.nl/docs/v2/redoc",
"parameter": "postalCode",
"value": "invalid"
}
]
}UNAUTHORIZEDThe API key is missing, unknown, revoked or expired, its subscription is not active, the request does not match the key's allowlist, or the subscription does not include this call.
The API key is missing, unknown, revoked or expired, its subscription is not active, the request does not match the key's allowlist, or the subscription does not include this call.
{
"error_id": "UNAUTHORIZED",
"errors": [
{
"message": "No authorization token provided",
"help": "https://pro6pp.nl/docs/v2/redoc#section/Authentication"
}
]
}Codebeispiele
curl "https://api.pro6pp.nl/v2/locator/nl?targetPostalCodes=1016%2C1012%2C1011&postalCode=1017&authKey=YOUR_API_KEY"Wir ermutigen Sie, Beispielcode in der von Ihnen bevorzugten Sprache anzufordern.
Schritt für Schritt
Richten Sie ein Schnellformular ein, um die Niederlande Locator-Funktionalität auszuprobieren, indem Sie die folgenden Schritte ausführen.
Erstellen der HTML-Seite
Wir beginnen mit der Erstellung einer leeren HTML-Seite, die eine minimale Webseitenstruktur enthält. Erstellen Sie eine neue Datei
.htmlmit dem Namenpro6pp_niederlande_locator.html. Fügen Sie den folgenden Code zwischen den Tags<body>und</body>hinzu. Es fügt die Eingabefelder für die Adresseingabe hinzu.<form class="form" id="form"> <div>Call</div> <div> <label for="targetPostalCodes">targetPostalCodes:</label> <input id="targetPostalCodes" class="targetPostalCodes" placeholder="1016,1012,1011"/> <label for="postalCode">postalCode:</label> <input id="postalCode" class="postalCode" placeholder="1017"/> <label for="lat">lat:</label> <input id="lat" class="lat" placeholder=""/> <label for="lng">lng:</label> <input id="lng" class="lng" placeholder=""/> <label for="orderBy">orderBy:</label> <input id="orderBy" class="orderBy" placeholder=""/> <label for="maxResults">maxResults:</label> <input id="maxResults" class="maxResults" placeholder=""/> <label for="algorithm">algorithm:</label> <input id="algorithm" class="algorithm" placeholder=""/> </div> <div> <span style="color: red" class="message"></span> </div> <div> <button type="submit">Submit</button> </div> <br /> <div>Response</div> <br /> <div>Full Response</div> <pre class="jsonResponse"></pre> </form>Interaktion hinzufügen
Fügen Sie den folgenden JavaScript-Code in eine separate
pro6pp_niederlande_locator.js-Datei ein. Die IDs und Klassennamen der HTML-Elemente sollten mit den in dieser JavaScript-Datei angegebenen übereinstimmen, um die richtigen Ergebnisse zu erhalten.document.addEventListener("DOMContentLoaded", function() { const pro6ppAuthKey = "AUTH_KEY"; // Replace with your actual authorization key let messageSpan = document.querySelector(".message"); let jsonResponseSpan = document.querySelector(".jsonResponse"); const BASE_URL = "https://api.pro6pp.nl/v2"; function fetchAddress(authKey) { const queryParams = { targetPostalCodes: document.getElementById("targetPostalCodes").value, authKey: authKey }; const optionalQueryParams = [ "postalCode", "lat", "lng", "orderBy", "maxResults", "algorithm", ]; for (const name of optionalQueryParams) { const value = document.getElementById(name).value; if (value !== "") { queryParams[name] = value; } } let encodedUrl = new URL(`${BASE_URL}/locator/nl`); encodedUrl.search = new URLSearchParams(queryParams); fetch(encodedUrl) .then(async (response) => { const data = await response.json(); if (data) { messageSpan.textContent = ""; jsonResponseSpan.textContent = JSON.stringify(data, null, 2); } }) .catch((error) => { console.error("Error fetching: ", error); messageSpan.textContent = error.message; }); } const form = document.getElementById("form"); form.onsubmit = function (event) { event.preventDefault(); fetchAddress(pro6ppAuthKey); } });Umsetzung in die Praxis
Verknüpfen Sie die JavaScript-Datei innerhalb des
pro6pp_niederlande_locator.htmldirekt vor dem Schließen des</body>-Tags.... <script src="pro6pp_niederlande_locator.js"></script> </body> </html>Um auf den Pro6PP-Webdienst zuzugreifen, müssen Sie Ihren persönlichen Autorisierungsschlüssel anfordern. Dieser Schlüssel wird Ihnen direkt nach der Anmeldung per E-Mail zugeschickt. Ersetzen Sie den obigen Platzhalter
AUTH_KEYdurch Ihren persönlichen Autorisierungsschlüssel.Wenn Sie noch kein Konto haben, melden Sie sich für einen kostenlosen 2 Monate Test an. Nachdem Sie Ihr Konto erstellt haben, gehen Sie zu Ihren Abonnementdetails und kopieren Sie Ihren
AUTH_KEY. Sie benötigen diesen Schlüssel, um Ihre Anfragen zu authentifizieren.In Aktion sehen
Wenn Sie die vorherigen Schritte abgeschlossen haben, ist es an der Zeit, das Formular lokal in Ihrem Browser auszuführen. Sie sollten nun zwei Dateien im selben Ordner auf Ihrem Computer haben:
pro6pp_niederlande_locator.html- die HTML-Seite mit dem Formular.pro6pp_niederlande_locator.js- die JavaScript-Datei, die die Interaktion steuert.
Sie können die HTML-Datei nun in Ihrem Browser öffnen, indem Sie einfach in Ihrem Datei-Explorer (z. B. Finder unter macOS oder Datei-Explorer unter Windows) auf die Datei doppelklicken. Alternativ können Sie die Datei auch manuell im Browser mit dem vollständigen
file:///-Pfad öffnen. Zum Beispiel:file:///C:/Users/YourName/Documents/pro6pp_niederlande_locator.html file:///Users/yourname/Desktop/pro6pp_niederlande_locator.htmlSobald die Seite geöffnet ist, geben Sie die Daten in die Formularfelder ein und klicken Sie auf Senden, um die API-Antwort im Abschnitt „Vollständige Antwort“ anzuzeigen.