Autocomplete Danimarca
BetaAutocomplete a Danish address.
https://api.pro6pp.nl/v2/autocomplete/dkPanoramica
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.
- 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.
ParametriQuery string
The address's postal code which consists of four digits.
- Esempio
6430- Pattern
^[0-9]{4}$
The address's settlement (city, town, village, or hamlet).
- Esempio
Stevning
The address's street name.
- Esempio
Stevningnorvej
The address's street number and premise (extension/addition).
The address's street number.
- Esempio
19
The address's premise.
- Esempio
A
Risposte
| Campo | Tipo | Valore di esempio | Descrizione |
|---|---|---|---|
| country | string | "Denmark" | English name of the country: "Denmark". |
| countryCode | string | "DK" | ISO 3166-1 alpha-2 code of the country: "DK". |
| postalCode | string | "6430" | The four-digit postal code (postnummer), such as "8000". |
| settlement | string | "Stevning" | The supplementary town name (supplerende bynavn) of the address, or the name of its postal district (postnummernavn) where it has none. |
| street | string | "Stevningnorvej" | The name of the street the address is on. |
| streetNumber | number | 19 | The house number, without the premise. |
| lat | numberNullable | 55.00166 | Latitude of the address access point (adgangspunkt) in WGS84 decimal degrees; null when the dataset holds no location for the address. |
| lng | numberNullable | 9.81503 | Longitude of the address access point (adgangspunkt) in WGS84 decimal degrees; null when the dataset holds no location for the address. |
| region | string | "Region Southern Denmark" | The region the address lies in, by its English name, such as "Central Denmark Region". |
| province | string | "South Jutland" | The province (landsdel) the address lies in, by its English name, such as "East Jutland". |
| municipality | string | "Sønderborg" | The municipality (kommune) the address lies in. |
| premise | string | "A" | The letter that follows the house number, such as "A" in "12A"; absent when the address has none. |
{
"country": "Denmark",
"countryCode": "DK",
"lat": 55.00166,
"lng": 9.81503,
"municipality": "Sønderborg",
"postalCode": "6430",
"premise": "A",
"province": "South Jutland",
"region": "Region Southern Denmark",
"settlement": "Stevning",
"street": "Stevningnorvej",
"streetNumber": 19
}Errori
Campi di una risposta di errore
| Campo | Tipo | Descrizione |
|---|---|---|
| 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"
}
]
}Esempi di codice
curl "https://api.pro6pp.nl/v2/autocomplete/dk?postalCode=6430&settlement=Stevning&street=Stevningnorvej&streetNumber=19&premise=A&authKey=YOUR_API_KEY"La invitiamo a richiedere codice di esempio nel linguaggio di programmazione che preferisce.
Passo dopo passo
Seguendo i passaggi seguenti, crei un semplice modulo per provare la funzionalità Danimarca Autocomplete.
Creare la pagina HTML
Iniziamo creando una pagina HTML vuota con una struttura web minima. Crei un nuovo file
.htmldenominatopro6pp_danimarca_autocomplete.html. Aggiunga il seguente codice tra i tag<body>e</body>. Questo codice aggiunge i campi di input per l'inserimento dell'indirizzo.<form class="form" id="form"> <div>Call</div> <div> <label for="postalCode">postalCode:</label> <input id="postalCode" class="postalCode" placeholder="6430"/> <label for="settlement">settlement:</label> <input id="settlement" class="settlement" placeholder="Stevning"/> <label for="street">street:</label> <input id="street" class="street" placeholder="Stevningnorvej"/> <label for="streetNumberAndPremise">streetNumberAndPremise:</label> <input id="streetNumberAndPremise" class="streetNumberAndPremise" placeholder=""/> <label for="streetNumber">streetNumber:</label> <input id="streetNumber" class="streetNumber" placeholder="19"/> <label for="premise">premise:</label> <input id="premise" class="premise" placeholder="A"/> </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>Aggiungere l'interazione
Aggiunga il seguente codice JavaScript in un file separato
pro6pp_danimarca_autocomplete.js. Gli IDs e i nomi delle classi (Class) degli elementi HTML devono corrispondere a quelli indicati in questo file JavaScript per ottenere i risultati corretti.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, settlement: document.getElementById("settlement").value, street: document.getElementById("street").value, authKey: authKey }; const optionalQueryParams = [ "streetNumberAndPremise", "streetNumber", "premise", ]; for (const name of optionalQueryParams) { const value = document.getElementById(name).value; if (value !== "") { queryParams[name] = value; } } let encodedUrl = new URL(`${BASE_URL}/autocomplete/dk`); 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); } });Farlo funzionare
Colleghi il file JavaScript all'interno di
pro6pp_danimarca_autocomplete.htmlsubito prima del tag di chiusura</body>.... <script src="pro6pp_danimarca_autocomplete.js"></script> </body> </html>Per accedere al servizio web Pro6PP è necessario richiedere la Sua chiave di autorizzazione personale. La chiave Le viene inviata via e-mail subito dopo la registrazione. Sostituisca il segnaposto
AUTH_KEYindicato sopra con la Sua chiave di autorizzazione personale.Se non ha ancora un account, si registri per una prova gratuita di 2 mesi. Dopo aver creato l'account, vada in Dettagli abbonamento e copi la Sua
AUTH_KEY. Questa chiave Le servirà per autenticare le Sue richieste.Vederlo in azione
Una volta completati i passaggi precedenti, è il momento di eseguire il modulo in locale nel Suo browser. Ora dovrebbe avere due file nella stessa cartella del Suo computer:
pro6pp_danimarca_autocomplete.html- la pagina HTML con il modulo.pro6pp_danimarca_autocomplete.js- il file JavaScript che gestisce l'interazione.
Ora può aprire il file HTML nel Suo browser semplicemente facendo doppio clic su di esso nel gestore file (ad es. Finder su macOS o File Explorer su Windows). In alternativa, può aprirlo manualmente nel browser utilizzando il percorso completo
file:///. Ad esempio:file:///C:/Users/YourName/Documents/pro6pp_danimarca_autocomplete.html file:///Users/yourname/Desktop/pro6pp_danimarca_autocomplete.htmlUna volta aperta la pagina, inizi a digitare nei campi del modulo e prema Submit per visualizzare la risposta dell'API nella sezione "Full Response".