Suggest Espagne
BêtaSuggérer un champ d'adresse espagnol.
https://api.pro6pp.nl/v2/suggest/es/streetNumberVue d'ensemble
Returns street number suggestions for a partly typed streetNumber.
streetis required, with eitherpostalCodeorsettlement.
Each suggestion names one source address: addressId selects it in
autocomplete, also where several addresses share
the fields, and buildingName is the building's name where the source has one.
ParamètresChaîne de requête
The address's postal code which consists of five digits.
- Exemple
41001- Motif
^[0-9]{5}$
The address's settlement (city, town, village, or hamlet).
- Exemple
Sevilla
The address's street name.
- Exemple
Calle adolfo rodriguez jurado
The address's street number.
- Exemple
2
The address's street number and premise (extension/addition).
The address's premise.
- Exemple
The amount of results returned, a number between 1 and 999. Default value is 10.
- Par défaut
10- Min.
1- Max.
999
The page to return, the variables for the next/previous pages can be found in the results Link header.
Réponses
| Champ | Type | Valeur d'exemple | Description |
|---|---|---|---|
| lat | numberPeut être null | 37.38406 | Latitude of the address, from its premise where that has its own coordinate, otherwise from its house number. |
| lng | numberPeut être null | -5.99393 | Longitude of the address, from its premise where that has its own coordinate, otherwise from its house number. |
| postalCode | string | "41001" | The postal code of the address, such as "41001". |
| settlement | string | "Sevilla" | The settlement the address lies in. |
| state | string | "Andalucía" | The autonomous community (comunidad autónoma). |
| province | string | "Sevilla" | The province (provincia). |
| municipality | string | "Sevilla" | The municipality (municipio). |
| street | string | "Calle adolfo rodriguez jurado" | The street the address lies on. |
| streetNumber | string | "2" | The house number as text, such as "7" or "S-N" (sin número). |
| premiseRequired | boolean | false | Whether a premise must still be chosen to complete the address; present on a result without a premise, and false for every Spanish house number. |
| premise | string | absent de l'exemple | The entrance (portal) of the house number, such as "accA"; present only on a result that has one. |
| addressId | string | "01.41.MUN_410910481202" | The source id of the address; selects it in autocomplete. |
| buildingName | stringPeut être null | null | The building's name where the source has one. |
[
{
"postalCode": "41001",
"settlement": "Sevilla",
"street": "Calle adolfo rodriguez jurado",
"streetNumber": "2",
"premiseRequired": false,
"addressId": "01.41.MUN_410910481202",
"buildingName": null,
"lat": 37.38406,
"lng": -5.99393,
"state": "Andalucía",
"province": "Sevilla",
"municipality": "Sevilla"
},
{
"postalCode": "41001",
"settlement": "Sevilla",
"street": "Calle adolfo rodriguez jurado",
"streetNumber": "2",
"premise": "accA",
"addressId": "01.41.MUN_410910481195",
"buildingName": null,
"lat": 37.38409,
"lng": -5.99391,
"state": "Andalucía",
"province": "Sevilla",
"municipality": "Sevilla"
}
]Erreurs
Champs d'une réponse d'erreur
| Champ | Type | Description |
|---|---|---|
| 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 that other parameters depend on is missing. errors has one entry per missing parameter.
A parameter that other parameters depend on is missing. errors has one entry per missing parameter.
{
"error_id": "MISSING_PARAMETER",
"errors": [
{
"message": "Required parameter lat is missing",
"help": "https://pro6pp.nl/docs/v2/redoc",
"parameter": "lat"
}
]
}INVALID_PARAMETER_TYPEA value has the wrong type, such as text for a number.
A value has the wrong type, such as text for a number.
{
"error_id": "INVALID_PARAMETER_TYPE",
"errors": [
{
"message": "parameter: lat has invalid 1,0, should be number",
"help": "https://pro6pp.nl/docs/v2/redoc",
"parameter": "lat"
}
]
}INVALID_VALUEA required parameter is missing, or a value is malformed, out of bounds or cannot be found.
A required parameter is missing, or a value is malformed, out of bounds or cannot be found.
{
"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"
}
]
}Exemples de code
curl "https://api.pro6pp.nl/v2/suggest/es/streetNumber?street=Calle+adolfo+rodriguez+jurado&postalCode=41001&settlement=Sevilla&streetNumber=2&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 Suggest en suivant les étapes ci-dessous.
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
.htmlnommépro6pp_espagne_suggest.html. Ajoutez le code suivant entre les balises<body>et</body>. Cela ajoute les champs de saisie pour saisir l'adresse.<form class="form" id="form"> <div>Call</div> <div> <label for="street">street:</label> <input id="street" class="street" placeholder="Calle adolfo rodriguez jurado"/> <label for="postalCode">postalCode:</label> <input id="postalCode" class="postalCode" placeholder="41001"/> <label for="settlement">settlement:</label> <input id="settlement" class="settlement" placeholder="Sevilla"/> <label for="streetNumber">streetNumber:</label> <input id="streetNumber" class="streetNumber" placeholder="2"/> <label for="streetNumberAndPremise">streetNumberAndPremise:</label> <input id="streetNumberAndPremise" class="streetNumberAndPremise" placeholder=""/> <label for="premise">premise:</label> <input id="premise" class="premise" placeholder=""/> <label for="maxResults">maxResults:</label> <input id="maxResults" class="maxResults" placeholder=""/> <label for="cursor">cursor:</label> <input id="cursor" class="cursor" placeholder=""/> </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>Ajoutez une interaction
Ajoutez le code JavaScript suivant dans un fichier
pro6pp_espagne_suggest.jssé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.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 = { street: document.getElementById("street").value, authKey: authKey }; const optionalQueryParams = [ "postalCode", "settlement", "streetNumber", "streetNumberAndPremise", "premise", "maxResults", "cursor", ]; for (const name of optionalQueryParams) { const value = document.getElementById(name).value; if (value !== "") { queryParams[name] = value; } } let encodedUrl = new URL(`${BASE_URL}/suggest/es/streetNumber`); 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); } });Faites-le fonctionner
Liez le fichier JavaScript à l'intérieur du
pro6pp_espagne_suggest.htmlfichier juste avant de fermer la balise</body>.... <script src="pro6pp_espagne_suggest.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_KEYpar 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.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_suggest.html- la page HTML contenant le formulaire.pro6pp_espagne_suggest.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 completfile:///:file:///C:/Users/YourName/Documents/pro6pp_espagne_suggest.html file:///Users/yourname/Desktop/pro6pp_espagne_suggest.htmlUne 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 ».