Autocomplete Germania

Beta

Autocomplete a German address.

GEThttps://api.pro6pp.nl/v2/autocomplete/de

Panoramica

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 streetNumberAndPremise field.
  • To validate if an address exists with a certain street number, use the streetNumber field.
  • To validate if an address exists with a certain premise, use both the streetNumber and premise fields.
  • Either streetNumberAndPremise or streetNumber is required. If both are given, only streetNumber is used.

ParametriQuery string

authKeystringObbligatorio

Every request needs an API key, which you can get in the portal.

When you call the API from a browser, visitors can see your API key. Limit it to your own domains in the portal, or send the requests through your own server so the key stays hidden.

postalCodestringObbligatorio

The address's postal code which consists of five digits.

Esempio
86975
Pattern
^[0-9]{5}$
settlementstringObbligatorio

The address's settlement (city, town, village, or hamlet).

Esempio
Bernbeuren
streetstringObbligatorio

The address's street name.

Esempio
Schwabenstraße
streetNumberAndPremisestring

The address's street number and premise (extension/addition).

streetNumberstring

The address's street number.

Esempio
3
premisestring

The address's premise.

Esempio
a

Risposte

200Address found
CampoTipoValore di esempioDescrizione
countrystring"Germany"

English name of the country: "Germany".

countryCodestring"DE"

ISO 3166-1 alpha-2 code of the country: "DE".

postalCodestring"86975"

The five-digit postal code (Postleitzahl), such as "10117".

settlementstring"Bernbeuren"

The municipality (Gemeinde) the address lies in; the same value as municipality.

streetstring"Schwabenstraße"

The name of the street the address is on.

streetNumbernumber3

The house number, without the premise.

premisestring"a"

The suffix that follows the house number, such as "a" in "12a" or "1" in "12/1"; absent when the address has none.

latnumberNullable47.74026

Latitude of the address in WGS84 decimal degrees; null when the dataset holds no location for the address.

lngnumberNullable10.77167

Longitude of the address in WGS84 decimal degrees; null when the dataset holds no location for the address.

statestring"Bayern"

The federal state (Bundesland) the address lies in.

districtstring"Landkreis Weilheim-Schongau"

The rural district (Landkreis) the address lies in; absent in a district-free city (kreisfreie Stadt) or a city-state.

municipalitystring"Bernbeuren"

The municipality (Gemeinde) the address lies in; the same value as settlement.

Risposta di esempio
{
  "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
}

Errori

Campi di una risposta di errore
CampoTipoDescrizione
error_idstring

The reason the request failed, such as INVALID_VALUE. The response lists the reasons this operation returns.

errorsarray of object

One entry per problem found in the request.

errors[].messagestring

A readable explanation of the problem, in English.

errors[].helpstring

A link to the documentation section that covers the problem.

errors[].parameterany

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[].valueany

The value the request sent for parameter, when it has one.

400Richiesta non valida
MISSING_PARAMETER

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.

MISSING_PARAMETER
{
  "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_VALUE

A value is malformed, or does not match the address that addressId selects.

INVALID_VALUE
{
  "error_id": "INVALID_VALUE",
  "errors": [
    {
      "message": "value is invalid",
      "help": "https://pro6pp.nl/docs/v2/redoc",
      "parameter": "postalCode",
      "value": "invalid"
    }
  ]
}
401Non autorizzato
UNAUTHORIZED

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.

UNAUTHORIZED
{
  "error_id": "UNAUTHORIZED",
  "errors": [
    {
      "message": "No authorization token provided",
      "help": "https://pro6pp.nl/docs/v2/redoc#section/Authentication"
    }
  ]
}
404Nessun risultato
NO_RESULTS_FOUND

No result matches the parameters the request sent.

NO_RESULTS_FOUND
{
  "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/de?postalCode=86975&settlement=Bernbeuren&street=Schwabenstra%C3%9Fe&streetNumber=3&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à Germania Autocomplete.

  1. Creare la pagina HTML

    Iniziamo creando una pagina HTML vuota con una struttura web minima. Crei un nuovo file .html denominato pro6pp_germania_autocomplete.html. Aggiunga il seguente codice tra i tag <body> e </body>. Questo codice aggiunge i campi di input per l'inserimento dell'indirizzo.

    pro6pp_germania_autocomplete.html
    <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>
  2. Aggiungere l'interazione

    Aggiunga il seguente codice JavaScript in un file separato pro6pp_germania_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.

    pro6pp_germania_autocomplete.js
    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);
        }
    });
  3. Farlo funzionare

    Colleghi il file JavaScript all'interno di pro6pp_germania_autocomplete.html subito prima del tag di chiusura </body>.

    pro6pp_germania_autocomplete.html
      ...
      <script src="pro6pp_germania_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_KEY indicato 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.

  4. 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_germania_autocomplete.html - la pagina HTML con il modulo.
    • pro6pp_germania_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:

    Percorsi file di esempio
    file:///C:/Users/YourName/Documents/pro6pp_germania_autocomplete.html
    file:///Users/yourname/Desktop/pro6pp_germania_autocomplete.html

    Una volta aperta la pagina, inizi a digitare nei campi del modulo e prema Submit per visualizzare la risposta dell'API nella sezione "Full Response".