Infer Frankrijk
AlphaMogelijke Franse adressen uit een string voorstellen.
https://api.pro6pp.nl/v2/infer/frOverzicht
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: premise suggestions.direct: full address suggestions, with or without a premise.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.
ParametersQuerystring
String to generate suggestions from.
- Voorbeeld
Gap, Avenue Jean Jaurès, 16 bis
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.
- Standaard
"relevance"- Een van
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
Antwoorden
| Veld | Type | Beschrijving |
|---|---|---|
| cities | array of objectKan null zijn | 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 objectKan null zijn | 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 | stringKan null zijn | 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 | stringKan null zijn | Additional context information |
| suggestions[].count | stringKan null zijn | 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": "final",
"suggestions": [
{
"label": "Avenue Jean Jaurès, 16, bis, 05000, Gap",
"value": {
"addition": "bis",
"city": "Gap",
"lat": 44.55476,
"lng": 6.0742,
"postcode": "05000",
"street": "Avenue Jean Jaurès",
"street_number": 16
}
}
]
}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/infer/fr?query=Gap%2C+Avenue+Jean+Jaur%C3%A8s%2C+16+bis&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 Frankrijk Infer 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="query">query:</label> <input id="query" class="query" placeholder="Gap, Avenue Jean Jaurès, 16 bis"/> <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>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 = { 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/fr`); 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_frankrijk_infer.htmlvlak voor het sluiten van de code</body>.... <script src="pro6pp_frankrijk_infer.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_frankrijk_infer.html- de HTML-pagina met het formulier.pro6pp_frankrijk_infer.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_frankrijk_infer.html file:///Users/yourname/Desktop/pro6pp_frankrijk_infer.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”.