Autocomplete Italien

Beta

Autovervollständigen einer italienischen Adresse.

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

Übersicht

Official German and Slovene settlement names match canonical Italian source addresses.

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.

Italian house numbers are the source's civic numbers (civico) and are returned as strings, such as "12", or "12R" for the red series that Genova, Firenze and Savona number apart from the black one. The exponent (esponente) of a house number, such as "A", "BIS" or "1", is its premise. Every address from the Italian dataset carries its source addressId; its buildingName is always null, as the source names no buildings.

  • When the fields describe several source addresses (two entrances of one house number, for instance), the response is a 400 that lists their addressId values; select one by its location and retry with addressId.
  • An addressId alone resolves that exact address. Fields sent along with it must match the selected address.

ParameterQuery-String

authKeystringErforderlich

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.

postalCodestring

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

Beispiel
20121
Muster
^[0-9]{5}$
settlementstring

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

Beispiel
Milano
streetstring

The address's street name.

Beispiel
Via Alessandro Manzoni
streetNumberAndPremisestring

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

streetNumberstring

The address's street number.

Beispiel
12
premisestring

The address's premise.

Beispiel
A
addressIdstring

The addressId of an address-level suggestion. It selects that one source address, including an address without a house number, and is required when the other fields describe several addresses. Any other field sent along with it is checked against the selected address.

Antworten

200Address found
FeldTypBeispielwertBeschreibung
countrystring"Italy"

English name of the country: "Italy".

countryCodestring"IT"

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

postalCodestring"20121"

The five-digit postal code (CAP), such as "00185".

settlementstring"Milano"

The town, village or hamlet (località) the address lies in, or the municipality's name where the dataset names none.

streetstring"Via Alessandro Manzoni"

The name of the street the address is on.

streetNumberstring"12"

The source house number (civico), with an "R" for the red series, such as "12" or "12R".

premisestring"A"

The exponent (esponente) that follows the house number, such as "A", "BIS" or "1"; absent when the address has none.

latnumberKann null sein45.46889

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

lngnumberKann null sein9.19162

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

regionstring"Lombardia"

The region (regione).

provincestring"Milano"

The province (provincia).

municipalitystring"Milano"

The municipality (comune).

addressIdstring"32037569"

The source id of the address; selects it on a later call.

buildingNamestringKann null seinnull

Always null; the source names no buildings.

Beispielhafte Antwort
{
  "country": "Italy",
  "countryCode": "IT",
  "postalCode": "20121",
  "settlement": "Milano",
  "street": "Via Alessandro Manzoni",
  "streetNumber": "12",
  "premise": "A",
  "lat": 45.46889,
  "lng": 9.19162,
  "region": "Lombardia",
  "province": "Milano",
  "municipality": "Milano",
  "addressId": "32037569",
  "buildingName": null
}

Fehler

Felder einer Fehlerantwort
FeldTypBeschreibung
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.

400Ungültige Anfrage
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"
    }
  ]
}
401Nicht autorisiert
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"
    }
  ]
}
404Kein Ergebnis
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"
    }
  ]
}

Codebeispiele

curl "https://api.pro6pp.nl/v2/autocomplete/it?postalCode=20121&settlement=Milano&street=Via+Alessandro+Manzoni&streetNumber=12&premise=A&authKey=YOUR_API_KEY"

Wir ermutigen Sie, Beispielcode in der von Ihnen bevorzugten Sprache anzufordern.

Schritt für Schritt

Richten Sie ein Schnellformular ein, um die Italien Autocomplete-Funktionalität auszuprobieren, indem Sie die folgenden Schritte ausführen.

  1. Erstellen der HTML-Seite

    Wir beginnen mit der Erstellung einer leeren HTML-Seite, die eine minimale Webseitenstruktur enthält. Erstellen Sie eine neue Datei .html mit dem Namen pro6pp_italien_autocomplete.html. Fügen Sie den folgenden Code zwischen den Tags <body> und </body> hinzu. Es fügt die Eingabefelder für die Adresseingabe hinzu.

    pro6pp_italien_autocomplete.html
    <form class="form" id="form">
      <div>Call</div>
      <div>
        <label for="postalCode">postalCode:</label>
        <input id="postalCode" class="postalCode" placeholder="20121"/>
        <label for="settlement">settlement:</label>
        <input id="settlement" class="settlement" placeholder="Milano"/>
        <label for="street">street:</label>
        <input id="street" class="street" placeholder="Via Alessandro Manzoni"/>
        <label for="streetNumberAndPremise">streetNumberAndPremise:</label>
        <input id="streetNumberAndPremise" class="streetNumberAndPremise" placeholder=""/>
        <label for="streetNumber">streetNumber:</label>
        <input id="streetNumber" class="streetNumber" placeholder="12"/>
        <label for="premise">premise:</label>
        <input id="premise" class="premise" placeholder="A"/>
        <label for="addressId">addressId:</label>
        <input id="addressId" class="addressId" placeholder="" readonly/>
      </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. Interaktion hinzufügen

    Fügen Sie den folgenden JavaScript-Code in eine separate pro6pp_italien_autocomplete.js-Datei ein. Die IDs und Klassennamen der HTML-Elemente sollten mit den in dieser JavaScript-Datei angegebenen übereinstimmen, um die richtigen Ergebnisse zu erhalten.

    pro6pp_italien_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 = {
                authKey: authKey
            };
            const optionalQueryParams = [
                "postalCode",
                "settlement",
                "street",
                "streetNumberAndPremise",
                "streetNumber",
                "premise",
                "addressId",
            ];
            for (const name of optionalQueryParams) {
                const value = document.getElementById(name).value;
                if (value !== "") {
                    queryParams[name] = value;
                }
            }
    
            let encodedUrl = new URL(`${BASE_URL}/autocomplete/it`);
            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. Umsetzung in die Praxis

    Verknüpfen Sie die JavaScript-Datei innerhalb des pro6pp_italien_autocomplete.html direkt vor dem Schließen des </body>-Tags.

    pro6pp_italien_autocomplete.html
      ...
      <script src="pro6pp_italien_autocomplete.js"></script>
     </body>
    </html>

    Um auf den Pro6PP-Webdienst zuzugreifen, müssen Sie Ihren persönlichen Autorisierungsschlüssel anfordern. Dieser Schlüssel wird Ihnen direkt nach der Anmeldung per E-Mail zugeschickt. Ersetzen Sie den obigen Platzhalter AUTH_KEY durch Ihren persönlichen Autorisierungsschlüssel.

    Wenn Sie noch kein Konto haben, melden Sie sich für einen kostenlosen 2 Monate Test an. Nachdem Sie Ihr Konto erstellt haben, gehen Sie zu Ihren Abonnementdetails und kopieren Sie Ihren AUTH_KEY. Sie benötigen diesen Schlüssel, um Ihre Anfragen zu authentifizieren.

  4. In Aktion sehen

    Wenn Sie die vorherigen Schritte abgeschlossen haben, ist es an der Zeit, das Formular lokal in Ihrem Browser auszuführen. Sie sollten nun zwei Dateien im selben Ordner auf Ihrem Computer haben:

    • pro6pp_italien_autocomplete.html - die HTML-Seite mit dem Formular.
    • pro6pp_italien_autocomplete.js - die JavaScript-Datei, die die Interaktion steuert.

    Sie können die HTML-Datei nun in Ihrem Browser öffnen, indem Sie einfach in Ihrem Datei-Explorer (z. B. Finder unter macOS oder Datei-Explorer unter Windows) auf die Datei doppelklicken. Alternativ können Sie die Datei auch manuell im Browser mit dem vollständigen file:///-Pfad öffnen. Zum Beispiel:

    Beispiel für Dateipfade
    file:///C:/Users/YourName/Documents/pro6pp_italien_autocomplete.html
    file:///Users/yourname/Desktop/pro6pp_italien_autocomplete.html

    Sobald die Seite geöffnet ist, geben Sie die Daten in die Formularfelder ein und klicken Sie auf Senden, um die API-Antwort im Abschnitt „Vollständige Antwort“ anzuzeigen.