Autocomplete Spanje

Bèta

Een Spaans adres automatisch aanvullen.

OpenAPI-referentie
GEThttps://api.pro6pp.nl/v2/autocomplete/es

Overzicht

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.

Spanish house numbers are the source's labels and are returned as strings, such as "1", "03" or "S-N" (sin número). A padded number is a different address from its unpadded spelling. Every address from the Spanish dataset carries its source addressId; its buildingName is always null, as the source names no buildings.

  • When the fields describe several source addresses (two portals 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.

ParametersQuerystring

authKeystringVereist

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 which consists of five digits.

Voorbeeld
28001
Patroon
^[0-9]{5}$
settlementstring

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

Voorbeeld
Madrid
streetstring

The address's street name.

Voorbeeld
Calle goya
streetNumberAndPremisestring

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

streetNumberstring

The address's street number.

Voorbeeld
1
premisestring

The address's premise.

Voorbeeld
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.

Antwoorden

200Address found
VeldTypeVoorbeeldwaardeBeschrijving
countrystring"Spain"

English name of the country: "Spain".

countryCodestring"ES"

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

postalCodestring"28001"

The five-digit postal code (código postal), such as "28013".

settlementstring"Madrid"

The town or village (población) the address lies in, or the municipality's name where the dataset names none.

streetstring"Calle goya"

The name of the street the address is on.

streetNumberstring"1"

The source house number, such as "1", "03" or "S-N".

premisestring"A"

The extension that follows the house number, such as "A"; absent when the address has none.

latnumberKan null zijn40.42575

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

lngnumberKan null zijn-3.68961

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

statestring"Comunidad de Madrid"

The autonomous community (comunidad autónoma).

provincestring"Madrid"

The province (provincia).

municipalitystring"Madrid"

The municipality (municipio).

addressIdstring"13.PV.MUN_280790852100"

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

buildingNamestringKan null zijnnull

Always null; the source names no buildings.

Voorbeeld antwoord
{
  "addressId": "13.PV.MUN_280790852100",
  "buildingName": null,
  "country": "Spain",
  "countryCode": "ES",
  "lat": 40.42575,
  "lng": -3.68961,
  "municipality": "Madrid",
  "postalCode": "28001",
  "premise": "A",
  "province": "Madrid",
  "settlement": "Madrid",
  "state": "Comunidad de Madrid",
  "street": "Calle goya",
  "streetNumber": "1"
}

Fouten

Velden van een foutantwoord
VeldTypeBeschrijving
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.

400Ongeldig verzoek
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"
    }
  ]
}
401Niet geautoriseerd
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"
    }
  ]
}
404Geen resultaat
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"
    }
  ]
}

Codevoorbeelden

curl "https://api.pro6pp.nl/v2/autocomplete/es?postalCode=28001&settlement=Madrid&street=Calle+goya&streetNumber=1&premise=A&authKey=YOUR_API_KEY"

Wij moedigen u aan om voorbeeldcode aan te vragen in de taal van uw voorkeur.

Stap voor stap

Stel snel een formulier in om de functionaliteit Spanje Autocomplete uit te proberen door de onderstaande stappen te volgen.

  1. Bouw de HTML-pagina

    We beginnen met het maken van een lege HTML-pagina, die een minimale webpaginastructuur bevat. Voeg de volgende code toe tussen de tags <body> en </body>. Het voegt de invoervelden toe voor het invoeren van het adres. Maak een nieuw .html bestand met de naam {filename}}.

    pro6pp_spanje_autocomplete.html
    <form class="form" id="form">
      <div>Call</div>
      <div>
        <label for="postalCode">postalCode:</label>
        <input id="postalCode" class="postalCode" placeholder="28001"/>
        <label for="settlement">settlement:</label>
        <input id="settlement" class="settlement" placeholder="Madrid"/>
        <label for="street">street:</label>
        <input id="street" class="street" placeholder="Calle goya"/>
        <label for="streetNumberAndPremise">streetNumberAndPremise:</label>
        <input id="streetNumberAndPremise" class="streetNumberAndPremise" placeholder=""/>
        <label for="streetNumber">streetNumber:</label>
        <input id="streetNumber" class="streetNumber" placeholder="1"/>
        <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. Voeg interactie toe

    Voeg de volgende JavaScript-code toe in een apart {filename}}-bestand. De ID's en Class-namen van de HTML-elementen moeten overeenkomen met die in dit JavaScript-bestand om de juiste resultaten te krijgen.

    pro6pp_spanje_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/es`);
            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. Laat het werken

    Koppel het JavaScript-bestand binnen de pro6pp_spanje_autocomplete.html vlak voor het sluiten van de code </body>.

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

    Om toegang te krijgen tot de Pro6PP web service, moet u uw persoonlijke autorisatiesleutel aanvragen. Deze sleutel wordt direct na aanmelden naar u gemaild. Vervang de tijdelijke aanduiding AUTH_KEY door uw persoonlijke autorisatiesleutel.

    Als u nog geen account heeft, meldt u zich dan aan voor een gratis proefabonnement van 2 maanden. Nadat u uw account hebt aangemaakt, gaat u naar uw Abonnementsgegevens en kopieert u uw AUTH_KEY. U heeft deze sleutel nodig om uw aanvragen te verifiëren.

  4. Zie het in actie

    Als u de vorige stappen heeft uitgevoerd, is het tijd om het formulier lokaal in uw browser uit te voeren. U zou nu twee bestanden in dezelfde map op uw computer moeten hebben:

    • pro6pp_spanje_autocomplete.html - de HTML-pagina met het formulier.
    • pro6pp_spanje_autocomplete.js - het JavaScript-bestand dat de interactie afhandelt.

    U kunt het HTML-bestand nu openen in uw browser door er simpelweg dubbel op te klikken in uw bestandsverkenner (bijvoorbeeld Finder op macOS of File Explorer op Windows). U kunt het ook handmatig in de browser openen met het volledige file:/// pad. Bijvoorbeeld:

    Voorbeeld bestandspaden
    file:///C:/Users/YourName/Documents/pro6pp_spanje_autocomplete.html
    file:///Users/yourname/Desktop/pro6pp_spanje_autocomplete.html

    Zodra de pagina wordt geopend, begint u met het typen van de formuliervelden en drukt u op Submit om het API-antwoord te zien in het gedeelte “Full Response”.