Autocomplete Belgien
BetaUdfyld automatisk en belgisk adresse.
https://api.pro6pp.nl/v2/autocomplete/beOversigt
Validates that an address with the provided fields exists, and provides additional information about it.
If you do not have all required parameters, use the suggest call to gather them first.
If the input identifies a unique address, all available information about that address is returned. The default street, settlement, province will be in the language spoken for that region. E.g: For settlement, province and region in Flanders the default is Dutch. In Wallonia the default language spoken is French, except for German speaking parts where the default is German.
- To validate if an address has either a street number or a premise, query through the
streetNumberAndPremisefield. - To validate if an address exists with a certain street number, use the
streetNumberfield. - To validate if an address exists with a certain premise, use both the
streetNumberandpremisefields. - Either
streetNumberAndPremiseorstreetNumberis required. If both are given, onlystreetNumberis used.
ParametreQuerystreng
The address's postal code which consists of four digits.
- Eksempel
1000- Mønster
^[0-9]{4}$
The address's street name.
- Eksempel
Anderlechtsesteenweg
The address's street number and premise (extension/addition).
The address's street number.
- Eksempel
144
The address's premise.
- Eksempel
The box identifier, excluding any prefixes such as "box", "bus", "bte", or "boîte". If provided, these prefixes will be automatically removed.
- Eksempel
bus b002
Svar
| Felt | Type | Eksempelværdi | Beskrivelse |
|---|---|---|---|
| country | string | "Belgium" | English name of the country: "Belgium". |
| countryCode | string | "BE" | ISO 3166-1 alpha-2 code of the country: "BE". |
| postalCode | string | "1000" | The four-digit postal code, such as "1000". |
| settlement | string | "Brussel" | The sub-municipality (deelgemeente/section) the address lies in, or the municipality itself where it has none, in the language of the address's region. |
| street | string | "Anderlechtsesteenweg" | The name of the street the address is on, in the language of the address's region. |
| streetNumber | number | 144 | The house number, without the premise or the box. |
| premise | string | ikke i eksemplet | The suffix that follows the house number, such as "A"; absent when the address has none. |
| box | string | "b002" | The box number of a unit inside the building, written after "bus" or "bte" in an address; absent when the address has no box. |
| boxPrefix | string | "bus" | The word the box is written with: "bus" in Dutch, "bte" in French, or "box" otherwise; absent when the address has no box. |
| lat | numberKan være null | 50.84534 | Latitude of the address point in WGS84 decimal degrees; null when the dataset holds no location for the address. |
| lng | numberKan være null | 4.34108 | Longitude of the address point in WGS84 decimal degrees; null when the dataset holds no location for the address. |
| municipality | string | "Brussel" | The municipality (Gemeente/Commune) the address lies in, in the language of the address's region. |
| province | string | "Brussel" | The province (Provincie/Province) the address lies in, in the language of the address's region; in the Brussels-Capital Region, which has no province, the region's name. |
| region | string | "Brussel" | The region (Gewest/Région) the address lies in: Flanders, Wallonia or Brussels-Capital, in the language of the address's region. |
| streetTranslations | array of object | [{"lang":"nl","name":"Anderlechtsesteenweg"},{"lang":"fr"... | The street name in each official language it has, listed Dutch, French, German. |
| streetTranslations[].lang | string | "nl" | ISO 639-1 code of the language of the name: "nl", "fr" or "de". |
| streetTranslations[].name | string | "Anderlechtsesteenweg" | The street name in that language. |
| settlementTranslations | array of object | [{"lang":"nl","name":"Brussel"},{"lang":"fr","name":"Brux... | The settlement name in each official language it has, listed Dutch, French, German. |
| settlementTranslations[].lang | string | "nl" | ISO 639-1 code of the language of the name: "nl", "fr" or "de". |
| settlementTranslations[].name | string | "Brussel" | The settlement name in that language. |
| municipalityTranslations | array of object | [{"lang":"nl","name":"Brussel"},{"lang":"fr","name":"Brux... | The municipality name in each official language it has, listed Dutch, French, German. |
| municipalityTranslations[].lang | string | "nl" | ISO 639-1 code of the language of the name: "nl", "fr" or "de". |
| municipalityTranslations[].name | string | "Brussel" | The municipality name in that language. |
| provinceTranslations | array of object | [{"lang":"nl","name":"Brussel"},{"lang":"fr","name":"Brux... | The province name in each official language it has, listed Dutch, French, German. |
| provinceTranslations[].lang | string | "nl" | ISO 639-1 code of the language of the name: "nl", "fr" or "de". |
| provinceTranslations[].name | string | "Brussel" | The province name in that language. |
| regionTranslations | array of object | [{"lang":"nl","name":"Brussel"},{"lang":"fr","name":"Brux... | The region name in each official language it has, listed Dutch, French, German. |
| regionTranslations[].lang | string | "nl" | ISO 639-1 code of the language of the name: "nl", "fr" or "de". |
| regionTranslations[].name | string | "Brussel" | The region name in that language. |
| countryTranslations | array of object | [{"lang":"nl","name":"België"},{"lang":"fr","name":"Belgi... | The country name in Dutch, French, German and English, in that order. |
| countryTranslations[].lang | string | "nl" | ISO 639-1 code of the language of the name: "nl", "fr", "de" or "en". |
| countryTranslations[].name | string | "België" | The country name in that language. |
{
"box": "b002",
"boxPrefix": "bus",
"country": "Belgium",
"countryCode": "BE",
"countryTranslations": [
{
"lang": "nl",
"name": "België"
},
{
"lang": "fr",
"name": "Belgique"
},
{
"lang": "de",
"name": "Belgien"
},
{
"lang": "en",
"name": "Belgium"
}
],
"lat": 50.84534,
"lng": 4.34108,
"municipality": "Brussel",
"municipalityTranslations": [
{
"lang": "nl",
"name": "Brussel"
},
{
"lang": "fr",
"name": "Bruxelles"
},
{
"lang": "de",
"name": "Brüssel"
}
],
"postalCode": "1000",
"province": "Brussel",
"provinceTranslations": [
{
"lang": "nl",
"name": "Brussel"
},
{
"lang": "fr",
"name": "Bruxelles"
},
{
"lang": "de",
"name": "Brüssel"
}
],
"region": "Brussel",
"regionTranslations": [
{
"lang": "nl",
"name": "Brussel"
},
{
"lang": "fr",
"name": "Bruxelles"
},
{
"lang": "de",
"name": "Brüssel"
}
],
"settlement": "Brussel",
"settlementTranslations": [
{
"lang": "nl",
"name": "Brussel"
},
{
"lang": "fr",
"name": "Bruxelles"
},
{
"lang": "de",
"name": "Brüssel"
}
],
"street": "Anderlechtsesteenweg",
"streetNumber": 144,
"streetTranslations": [
{
"lang": "nl",
"name": "Anderlechtsesteenweg"
},
{
"lang": "fr",
"name": "Rue d'Anderlecht"
}
]
}Fejl
Felter i et fejlsvar
| Felt | Type | Beskrivelse |
|---|---|---|
| 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 the request needs is missing, or the fields match several addresses. In that case parameter holds the missing parameter and the values to choose from.
A parameter the request needs is missing, or the fields match several addresses. In that case parameter holds the missing parameter and the values to choose from.
{
"error_id": "MISSING_PARAMETER",
"errors": [
{
"message": "Required parameter premise is missing. This address needs a premise alongside with the specified streetNumber: 1. Available premises for this address: a, b",
"help": "https://pro6pp.nl/docs/v2/redoc",
"parameter": [
"premise",
[
"a",
"b"
]
]
}
]
}INVALID_VALUEA value is malformed, or does not match the address that addressId selects.
A value is malformed, or does not match the address that addressId selects.
{
"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"
}
]
}NO_RESULTS_FOUNDNo result matches the parameters the request sent.
No result matches the parameters the request sent.
{
"error_id": "NO_RESULTS_FOUND",
"errors": [
{
"message": "No results found",
"help": "https://pro6pp.nl/docs/v2/redoc"
}
]
}Kodeeksempler
curl "https://api.pro6pp.nl/v2/autocomplete/be?postalCode=1000&street=Anderlechtsesteenweg&streetNumber=144&box=bus+b002&authKey=YOUR_API_KEY"Vi opfordrer dig til at anmode om eksempelkode på det sprog, du foretrækker.
Trin for trin
Opret en hurtig formular for at afprøve Belgien Autocomplete -funktionaliteten ved at følge nedenstående trin.
Opbyg HTML-siden
Vi starter med at oprette en tom HTML-side, der indeholder en minimal websidestruktur. Opret en ny
.htmlfil med navnetpro6pp_belgien_autocomplete.html. Tilføj følgende kode mellem<body>og</body>tags. Den tilføjer inputfelter til indtastning af adressen.<form class="form" id="form"> <div>Call</div> <div> <label for="postalCode">postalCode:</label> <input id="postalCode" class="postalCode" placeholder="1000"/> <label for="street">street:</label> <input id="street" class="street" placeholder="Anderlechtsesteenweg"/> <label for="streetNumberAndPremise">streetNumberAndPremise:</label> <input id="streetNumberAndPremise" class="streetNumberAndPremise" placeholder=""/> <label for="streetNumber">streetNumber:</label> <input id="streetNumber" class="streetNumber" placeholder="144"/> <label for="premise">premise:</label> <input id="premise" class="premise" placeholder=""/> <label for="box">box:</label> <input id="box" class="box" placeholder="bus b002"/> </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>Tilføj interaktion
Tilføj følgende JavaScript-kode i en separat
pro6pp_belgien_autocomplete.js-fil. HTML-elementernes ID'er og klassenavne skal stemme overens med dem, der er angivet i denne JavaScript-fil, for at få de korrekte resultater.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 = { postalCode: document.getElementById("postalCode").value, street: document.getElementById("street").value, authKey: authKey }; const optionalQueryParams = [ "streetNumberAndPremise", "streetNumber", "premise", "box", ]; for (const name of optionalQueryParams) { const value = document.getElementById(name).value; if (value !== "") { queryParams[name] = value; } } let encodedUrl = new URL(`${BASE_URL}/autocomplete/be`); 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); } });Få det til at fungere
Link JavaScript-filen inde i
pro6pp_belgien_autocomplete.htmllige før du lukker</body>-tagget.... <script src="pro6pp_belgien_autocomplete.js"></script> </body> </html>For at få adgang til Pro6PP-webservicen skal du anmode om din personlige autorisationsnøgle. Denne nøgle sendes til dig via e-mail lige efter tilmelding. Erstat ovenstående pladsholder
AUTH_KEYmed din personlige autorisationsnøgle.Hvis du ikke har en konto endnu, kan du tilmelde dig en gratis prøveperiode på 2 måneder. Når du har oprettet din konto, skal du gå til dine abonnementsoplysninger og kopiere din
AUTH_KEY. Du skal bruge denne nøgle til at godkende dine anmodninger.Se det i aktion
Når du har gennemført de foregående trin, er det tid til at køre formularen lokalt i din browser. Du bør nu have to filer i den samme mappe på din computer:
pro6pp_belgien_autocomplete.html- HTML-sidenpro6pp_belgien_autocomplete.js- den JavaScript-fil, der håndterer interaktionen.
Du kan nu åbne HTML-filen i din browser ved blot at dobbeltklikke på den i din filudforsker (f.eks. Finder på macOS eller File Explorer på Windows). Alternativt kan du åbne den manuelt i browseren ved at bruge den fulde
file:///-sti. For eksempel:file:///C:/Users/YourName/Documents/pro6pp_belgien_autocomplete.html file:///Users/yourname/Desktop/pro6pp_belgien_autocomplete.htmlNår siden åbnes, skal du begynde at skrive i formularfelterne og trykke på Submit for at se API-svaret blive vist i afsnittet »Full Response«.