Autocomplete Tyskland
BetaUdfyld automatisk en tysk adresse.
https://api.pro6pp.nl/v2/autocomplete/deOversigt
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.
ParametreQuerystreng
The address's postal code which consists of five digits.
- Eksempel
86975- Mønster
^[0-9]{5}$
The address's settlement (city, town, village, or hamlet).
- Eksempel
Bernbeuren
The address's street name.
- Eksempel
Schwabenstraße
The address's street number and premise (extension/addition).
The address's street number.
- Eksempel
3
The address's premise.
- Eksempel
a
Svar
| Felt | Type | Eksempelværdi | Beskrivelse |
|---|---|---|---|
| country | string | "Germany" | English name of the country: "Germany". |
| countryCode | string | "DE" | ISO 3166-1 alpha-2 code of the country: "DE". |
| postalCode | string | "86975" | The five-digit postal code (Postleitzahl), such as "10117". |
| settlement | string | "Bernbeuren" | The municipality (Gemeinde) the address lies in; the same value as municipality. |
| street | string | "Schwabenstraße" | The name of the street the address is on. |
| streetNumber | number | 3 | The house number, without the premise. |
| premise | string | "a" | The suffix that follows the house number, such as "a" in "12a" or "1" in "12/1"; absent when the address has none. |
| lat | numberKan være null | 47.74026 | Latitude of the address in WGS84 decimal degrees; null when the dataset holds no location for the address. |
| lng | numberKan være null | 10.77167 | Longitude of the address in WGS84 decimal degrees; null when the dataset holds no location for the address. |
| state | string | "Bayern" | The federal state (Bundesland) the address lies in. |
| district | string | "Landkreis Weilheim-Schongau" | The rural district (Landkreis) the address lies in; absent in a district-free city (kreisfreie Stadt) or a city-state. |
| municipality | string | "Bernbeuren" | The municipality (Gemeinde) the address lies in; the same value as settlement. |
{
"country": "Germany",
"countryCode": "DE",
"district": "Landkreis Weilheim-Schongau",
"lat": 47.74026,
"lng": 10.77167,
"municipality": "Bernbeuren",
"postalCode": "86975",
"premise": "a",
"settlement": "Bernbeuren",
"state": "Bayern",
"street": "Schwabenstraße",
"streetNumber": 3
}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/de?postalCode=86975&settlement=Bernbeuren&street=Schwabenstra%C3%9Fe&streetNumber=3&premise=a&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 Tyskland 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_tyskland_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="86975"/> <label for="settlement">settlement:</label> <input id="settlement" class="settlement" placeholder="Bernbeuren"/> <label for="street">street:</label> <input id="street" class="street" placeholder="Schwabenstraße"/> <label for="streetNumberAndPremise">streetNumberAndPremise:</label> <input id="streetNumberAndPremise" class="streetNumberAndPremise" placeholder=""/> <label for="streetNumber">streetNumber:</label> <input id="streetNumber" class="streetNumber" placeholder="3"/> <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>Tilføj interaktion
Tilføj følgende JavaScript-kode i en separat
pro6pp_tyskland_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, 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/de`); 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_tyskland_autocomplete.htmllige før du lukker</body>-tagget.... <script src="pro6pp_tyskland_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_tyskland_autocomplete.html- HTML-sidenpro6pp_tyskland_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_tyskland_autocomplete.html file:///Users/yourname/Desktop/pro6pp_tyskland_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«.