Autocomplete Espagne

Bêta

Autocomplétion d'une adresse espagnole.

Référence OpenAPI
GEThttps://api.pro6pp.nl/v2/autocomplete/es

Vue d'ensemble

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.

ParamètresChaîne de requête

authKeystringObligatoire

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.

Exemple
28001
Motif
^[0-9]{5}$
settlementstring

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

Exemple
Madrid
streetstring

The address's street name.

Exemple
Calle goya
streetNumberAndPremisestring

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

streetNumberstring

The address's street number.

Exemple
1
premisestring

The address's premise.

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

Réponses

200Address found
ChampTypeValeur d'exempleDescription
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.

latnumberPeut être null40.42575

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

lngnumberPeut être null-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.

buildingNamestringPeut être nullnull

Always null; the source names no buildings.

Exemple de réponse
{
  "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"
}

Erreurs

Champs d'une réponse d'erreur
ChampTypeDescription
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.

400Requête invalide
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 autorisé
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"
    }
  ]
}
404Aucun résultat
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"
    }
  ]
}

Exemples de code

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

Nous vous encourageons à demander un exemple de code dans votre langue préférée.

Pas à pas

Créez un formulaire rapide pour tester la fonctionnalité Espagne Autocomplete en suivant les étapes ci-dessous.

  1. Créez la page HTML

    Nous commençons par créer une page HTML vide, contenant une structure de page web minimale. Créez un nouveau fichier .html nommé pro6pp_espagne_autocomplete.html. Ajoutez le code suivant entre les balises <body> et </body>. Cela ajoute les champs de saisie pour saisir l'adresse.

    pro6pp_espagne_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. Ajoutez une interaction

    Ajoutez le code JavaScript suivant dans un fichier pro6pp_espagne_autocomplete.js séparé. Les ID et les noms de classe des éléments HTML doivent correspondre à ceux spécifiés dans ce fichier JavaScript afin d'obtenir des résultats corrects.

    pro6pp_espagne_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. Faites-le fonctionner

    Liez le fichier JavaScript à l'intérieur du pro6pp_espagne_autocomplete.html fichier juste avant de fermer la balise </body>.

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

    Pour accéder au service Web Pro6PP, vous devez demander votre clé d'autorisation personnelle. Cette clé vous est envoyée par e-mail juste après votre inscription. Remplacez l'espace réservé ci-dessus AUTH_KEY par votre clé d'autorisation personnelle.

    Si vous n'avez pas encore de compte, inscrivez-vous pour un essai gratuit de 2 mois. Après avoir créé votre compte, allez dans les détails de votre abonnement et copiez votre AUTH_KEY. Vous aurez besoin de cette clé pour authentifier vos demandes.

  4. Le voir en action

    Une fois que vous avez terminé les étapes précédentes, il est temps de exécuter le formulaire localement dans votre navigateur. Vous devriez maintenant avoir deux fichiers dans le même dossier sur votre ordinateur :

    • pro6pp_espagne_autocomplete.html - la page HTML contenant le formulaire.
    • pro6pp_espagne_autocomplete.js - le fichier JavaScript qui gère l'interaction.

    Vous pouvez maintenant ouvrir le fichier HTML dans votre navigateur en double-cliquant dans votre explorateur de fichiers (par exemple, Finder sous macOS ou Explorateur de fichiers sous Windows). Vous pouvez également l'ouvrir manuellement dans le navigateur en utilisant le chemin complet file:///. Par exemple, vous pouvez ouvrir le fichier en utilisant le chemin complet file:/// :

    Exemples de chemins d'accès aux fichiers
    file:///C:/Users/YourName/Documents/pro6pp_espagne_autocomplete.html
    file:///Users/yourname/Desktop/pro6pp_espagne_autocomplete.html

    Une fois la page ouverte, commencez à saisir les champs du formulaire et cliquez sur Submit pour voir la réponse de l'API s'afficher dans la section « Full Response ».