Locator Luxemburg
BètaRetourneer postcodes in de buurt van een postcode of lengte-/breedtecombinatie.
https://api.pro6pp.nl/v2/locator/luOverzicht
Returns your own list of postcodes ordered by distance from a postcode or a lat/lng origin.
ParametersQuerystring
An array of 4PPs (e.g: ["1111", "1112", "1113"]).
- Voorbeeld
["8284","9660","2412"]
The postcode (e.g: 1110), if both postalCode and lat/lng combination is given, the lat/lng from the postalCode will be used.
- Voorbeeld
6750- Patroon
^[0-9]{4}$
The latitude.
The longitude.
The order in which to return the results: distance (default) or input (keeps the input ordering).
- Standaard
"distance"
The amount of results returned, a number between 1 and 999. Default value is 10.
- Standaard
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.
- Availability of
- Standaard
"straight"- Een van
straightroad
Antwoorden
| Veld | Type | Voorbeeldwaarde | Beschrijving |
|---|---|---|---|
| distance | number | 23818 | Distance in metres from the origin, in a straight line or by road depending on the selected algorithm. |
| duration | number | niet in voorbeeld | Driving time in minutes, included for the road algorithm. |
| settlement | string | "Luxembourg" | The village or town section the postal code lies in; when the postal code spans several, one of them. |
| municipality | string | "Luxembourg" | The municipality (commune). |
| lat | number | 49.588 | Latitude of the postal code's centre point. |
| lng | number | 6.14 | Longitude of the postal code's centre point. |
| postalCode | string | "2412" | The 4-digit postal code. |
| canton | string | "Luxembourg-ville" | The canton. |
| district | string | "Luxembourg" | The district, such as "Diekirch". |
[
{
"canton": "Luxembourg-ville",
"distance": 23818,
"district": "Luxembourg",
"lat": 49.588,
"lng": 6.14,
"municipality": "Luxembourg",
"postalCode": "2412",
"settlement": "Luxembourg"
},
{
"canton": "Capellen",
"distance": 28913,
"district": "Luxembourg",
"lat": 49.668,
"lng": 6.038,
"municipality": "Kehlen",
"postalCode": "8284",
"settlement": "Kehlen"
},
{
"canton": "Wiltz",
"distance": 46982,
"district": "Diekirch",
"lat": 49.901,
"lng": 5.883,
"municipality": "Esch-sur-Sûre",
"postalCode": "9660",
"settlement": "Insenborn"
}
]Fouten
Velden van een foutantwoord
| Veld | Type | Beschrijving |
|---|---|---|
| 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"
}
]
}Codevoorbeelden
curl "https://api.pro6pp.nl/v2/locator/lu?targetPostalCodes=8284%2C9660%2C2412&postalCode=6750&authKey=YOUR_API_KEY"Wij moedigen u aan om voorbeeldcode aan te vragen in de taal van uw voorkeur.
Stap voor stap
Stel snel een formulier in om de functionaliteit Luxemburg Locator uit te proberen door de onderstaande stappen te volgen.
Bouw de HTML-pagina
We beginnen met het maken van een lege HTML-pagina, die een minimale webpaginastructuur bevat. Voeg de volgende code toe tussen de tags
<body>en</body>. Het voegt de invoervelden toe voor het invoeren van het adres. Maak een nieuw.htmlbestand met de naam{filename}}.<form class="form" id="form"> <div>Call</div> <div> <label for="targetPostalCodes">targetPostalCodes:</label> <input id="targetPostalCodes" class="targetPostalCodes" placeholder="8284,9660,2412"/> <label for="postalCode">postalCode:</label> <input id="postalCode" class="postalCode" placeholder="6750"/> <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>Voeg interactie toe
Voeg de volgende JavaScript-code toe in een apart
{filename}}-bestand. De ID's en Class-namen van de HTML-elementen moeten overeenkomen met die in dit JavaScript-bestand om de juiste resultaten te krijgen.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/lu`); 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); } });Laat het werken
Koppel het JavaScript-bestand binnen de
pro6pp_luxemburg_locator.htmlvlak voor het sluiten van de code</body>.... <script src="pro6pp_luxemburg_locator.js"></script> </body> </html>Om toegang te krijgen tot de Pro6PP web service, moet u uw persoonlijke autorisatiesleutel aanvragen. Deze sleutel wordt direct na aanmelden naar u gemaild. Vervang de tijdelijke aanduiding
AUTH_KEYdoor uw persoonlijke autorisatiesleutel.Als u nog geen account heeft, meldt u zich dan aan voor een gratis proefabonnement van 2 maanden. Nadat u uw account hebt aangemaakt, gaat u naar uw Abonnementsgegevens en kopieert u uw
AUTH_KEY. U heeft deze sleutel nodig om uw aanvragen te verifiëren.Zie het in actie
Als u de vorige stappen heeft uitgevoerd, is het tijd om het formulier lokaal in uw browser uit te voeren. U zou nu twee bestanden in dezelfde map op uw computer moeten hebben:
pro6pp_luxemburg_locator.html- de HTML-pagina met het formulier.pro6pp_luxemburg_locator.js- het JavaScript-bestand dat de interactie afhandelt.
U kunt het HTML-bestand nu openen in uw browser door er simpelweg dubbel op te klikken in uw bestandsverkenner (bijvoorbeeld Finder op macOS of File Explorer op Windows). U kunt het ook handmatig in de browser openen met het volledige
file:///pad. Bijvoorbeeld:file:///C:/Users/YourName/Documents/pro6pp_luxemburg_locator.html file:///Users/yourname/Desktop/pro6pp_luxemburg_locator.htmlZodra de pagina wordt geopend, begint u met het typen van de formuliervelden en drukt u op Submit om het API-antwoord te zien in het gedeelte “Full Response”.