Infer Pays-Bas
AlphaSuggérer des adresses néerlandaises possibles à partir d'une chaîne de caractères.
https://api.pro6pp.nl/v2/infer/nlVue d'ensemble
Resolves a single query string into complete or probable addresses and returns a list of ranked suggestions.
Each suggestion includes a stage indicating the current resolution step or completion status.
Stage meanings:
empty: returned on an empty query.mixed: settlement and street suggestions.postcode: postal code suggestions.street_number: street number suggestions.addition: street number addition suggestions.direct: full address suggestions, with or without an addition.final: a fully validated and structured address.
Street and settlement name matching:
- One or two characters match names from the start (prefix).
- Three or more characters match anywhere in the name:
gebouwalso findsKlokgebouw. - Matches are ranked by quality: the exact name first, then names the query starts, then matches beginning at a word boundary, then mid-word matches. Ties within a rank go to the name covering the most addresses.
- When the names containing the query leave suggestion slots free, close matches fill them below the exact matches, absorbing typos.
ParamètresChaîne de requête
String to generate suggestions from.
- Exemple
Amstel, 1, Amsterdam
Maximum number of suggestions to return. Must be between 1 and 1000 when provided; omitting the parameter uses the default page size.
- Min.
1- Max.
1000
Sort mixed city and street suggestions by relevance (default) or distance.
Distance sorting requires the Infer Extended (infer::location) capability.
Distance sorting uses lat and lng when provided. Otherwise, it uses the
approximate location derived from the request IP. If that location is
unavailable, suggestions are sorted by relevance.
- Par défaut
"relevance"- L'une des valeurs
relevancedistance
Latitude of the origin used for distance sorting. When providing coordinates,
include both lat and lng.
- Min.
-90- Max.
90
Longitude of the origin used for distance sorting. When providing coordinates,
include both lat and lng.
- Min.
-180- Max.
180
Réponses
| Champ | Type | Description |
|---|---|---|
| cities | array of objectPeut être null | Settlements matching the query, returned only in the mixed stage when any match. |
| cities[].label | string | The settlement name. |
| cities[].exact | boolean | False for a fuzzy match; left out for an exact one |
| cities[].matched_value | string | The value a fuzzy match found, in lowercase |
| cities[].diff_positions | array of integer | The 0-based positions in the query that differ from the fuzzy match |
| stage | string | The current stage of address inference |
| streets | array of objectPeut être null | Streets matching the query, returned only in the mixed stage when any match. |
| streets[].label | string | The street name. |
| streets[].subtitle | string | The settlement the street lies in, with its postal code when it has one |
| streets[].count | stringPeut être null | How many settlements ("3 places") or postal codes ("2 postcodes") the street name occurs in, when more than one. |
| streets[].exact | boolean | False for a fuzzy match; left out for an exact one |
| streets[].matched_value | string | The value a fuzzy match found, in lowercase |
| streets[].diff_positions | array of integer | The 0-based positions in the query that differ from the fuzzy match |
| suggestions | array of object | Suggestions for the next part of the address; in the mixed stage, the matching settlements and streets in ranked order. |
| suggestions[].label | string | Human-readable label for the suggestion |
| suggestions[].subtitle | stringPeut être null | Additional context information |
| suggestions[].count | stringPeut être null | Number of results for this suggestion |
| suggestions[].value | string | object | Canonical selection string or structured address data for address-detail suggestions. |
| suggestions[].exact | boolean | False for a fuzzy match; left out for an exact one |
| suggestions[].matched_value | string | The value a fuzzy match found, in lowercase |
| suggestions[].diff_positions | array of integer | The 0-based positions in the query that differ from the fuzzy match |
{
"stage": "addition",
"suggestions": [
{
"label": "Amstel, 10, 1017AA, Amsterdam",
"value": {
"addition": null,
"city": "Amsterdam",
"lat": 52.36694,
"lng": 4.89424,
"postcode": "1017AA",
"street": "Amstel",
"street_number": 10
}
},
{
"label": "Amstel, 16, 1017AA, Amsterdam",
"value": {
"addition": null,
"city": "Amsterdam",
"lat": 52.36693,
"lng": 4.89452,
"postcode": "1017AA",
"street": "Amstel",
"street_number": 16
}
},
{
"label": "Amstel, 10, A, 1017AA, Amsterdam",
"value": {
"addition": "A",
"city": "Amsterdam",
"lat": 52.36697,
"lng": 4.89425,
"postcode": "1017AA",
"street": "Amstel",
"street_number": 10
}
},
{
"label": "Amstel, 10, B, 1017AA, Amsterdam",
"value": {
"addition": "B",
"city": "Amsterdam",
"lat": 52.36697,
"lng": 4.89425,
"postcode": "1017AA",
"street": "Amstel",
"street_number": 10
}
},
{
"label": "Amstel, 10, C, 1017AA, Amsterdam",
"value": {
"addition": "C",
"city": "Amsterdam",
"lat": 52.36697,
"lng": 4.89425,
"postcode": "1017AA",
"street": "Amstel",
"street_number": 10
}
},
{
"label": "Amstel, 10, D, 1017AA, Amsterdam",
"value": {
"addition": "D",
"city": "Amsterdam",
"lat": 52.36697,
"lng": 4.89425,
"postcode": "1017AA",
"street": "Amstel",
"street_number": 10
}
},
{
"label": "Amstel, 10, E, 1017AA, Amsterdam",
"value": {
"addition": "E",
"city": "Amsterdam",
"lat": 52.36697,
"lng": 4.89425,
"postcode": "1017AA",
"street": "Amstel",
"street_number": 10
}
}
]
}Erreurs
Champs d'une réponse d'erreur
| Champ | Type | Description |
|---|---|---|
| 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"
}
]
}Exemples de code
curl "https://api.pro6pp.nl/v2/infer/nl?query=Amstel%2C+1%2C+Amsterdam&authKey=YOUR_API_KEY"Nous vous encourageons à demander un exemple de code dans votre langue préférée.
Pas à pas
Créez un formulaire rapide pour tester la fonctionnalité Pays-Bas Infer en suivant les étapes ci-dessous.
Créez la page HTML
Nous commençons par créer une page HTML vide, contenant une structure de page web minimale. Créez un nouveau fichier
.htmlnommépro6pp_pays-bas_infer.html. Ajoutez le code suivant entre les balises<body>et</body>. Cela ajoute les champs de saisie pour saisir l'adresse.<form class="form" id="form"> <div>Call</div> <div> <label for="query">query:</label> <input id="query" class="query" placeholder="Amstel, 1, Amsterdam"/> <label for="limit">limit:</label> <input id="limit" class="limit" placeholder=""/> <label for="sort">sort:</label> <input id="sort" class="sort" placeholder=""/> <label for="lat">lat:</label> <input id="lat" class="lat" placeholder=""/> <label for="lng">lng:</label> <input id="lng" class="lng" 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>Ajoutez une interaction
Ajoutez le code JavaScript suivant dans un fichier
pro6pp_pays-bas_infer.jsséparé. Les ID et les noms de classe des éléments HTML doivent correspondre à ceux spécifiés dans ce fichier JavaScript afin d'obtenir des résultats corrects.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 = { query: document.getElementById("query").value, authKey: authKey }; const optionalQueryParams = [ "limit", "sort", "lat", "lng", ]; for (const name of optionalQueryParams) { const value = document.getElementById(name).value; if (value !== "") { queryParams[name] = value; } } let encodedUrl = new URL(`${BASE_URL}/infer/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); } });Faites-le fonctionner
Liez le fichier JavaScript à l'intérieur du
pro6pp_pays-bas_infer.htmlfichier juste avant de fermer la balise</body>.... <script src="pro6pp_pays-bas_infer.js"></script> </body> </html>Pour accéder au service Web Pro6PP, vous devez demander votre clé d'autorisation personnelle. Cette clé vous est envoyée par e-mail juste après votre inscription. Remplacez l'espace réservé ci-dessus
AUTH_KEYpar votre clé d'autorisation personnelle.Si vous n'avez pas encore de compte, inscrivez-vous pour un essai gratuit de 2 mois. Après avoir créé votre compte, allez dans les détails de votre abonnement et copiez votre
AUTH_KEY. Vous aurez besoin de cette clé pour authentifier vos demandes.Le voir en action
Une fois que vous avez terminé les étapes précédentes, il est temps de exécuter le formulaire localement dans votre navigateur. Vous devriez maintenant avoir deux fichiers dans le même dossier sur votre ordinateur :
pro6pp_pays-bas_infer.html- la page HTML contenant le formulaire.pro6pp_pays-bas_infer.js- le fichier JavaScript qui gère l'interaction.
Vous pouvez maintenant ouvrir le fichier HTML dans votre navigateur en double-cliquant dans votre explorateur de fichiers (par exemple, Finder sous macOS ou Explorateur de fichiers sous Windows). Vous pouvez également l'ouvrir manuellement dans le navigateur en utilisant le chemin complet
file:///. Par exemple, vous pouvez ouvrir le fichier en utilisant le chemin completfile:///:file:///C:/Users/YourName/Documents/pro6pp_pays-bas_infer.html file:///Users/yourname/Desktop/pro6pp_pays-bas_infer.htmlUne fois la page ouverte, commencez à saisir les champs du formulaire et cliquez sur Submit pour voir la réponse de l'API s'afficher dans la section « Full Response ».