Locator Svizzera
BetaReturn near postcodes from a postcode or latitude/longitude combination.
https://api.pro6pp.nl/v2/locator/chPanoramica
Returns your own list of postcodes ordered by distance from a postcode or a lat/lng origin.
ParametriQuery string
An array of postcodes (e.g: [6003, 3011, 1003]).
- Esempio
["6003","3011","1003"]
The postcode (e.g: 8001), if both postalCode and lat/lng combination is given the lat/lng from the postalCode will be used.
- Esempio
8001- Pattern
^[0-9]{4}$
The latitude.
The longitude.
The order in which to return the results: distance (default) or input (keeps the input ordering).
- Predefinito
"distance"
The amount of results returned, a number between 1 and 999. Default value is 10.
- Predefinito
10- Min
1- Max
999
Specifies the algorithm for calculating distance and time.
Available Algorithms:
straight: Calculates the distance in a straight line.road: Calculates the actual traveling distance and time using the drive time matrix (shortest route) over the actual road network.- Availability of
roaddepends on your subscription level. - For trial purposes, this algorithm can be used with any subscription level for the following postcodes:
4146(Hochwald),4147(Aesch) and4148(Pfeffingen).
- Availability of
- Predefinito
"straight"- Uno tra
straightroad
Risposte
| Campo | Tipo | Valore di esempio | Descrizione |
|---|---|---|---|
| distance | number | 40379 | Distance in metres from the origin, in a straight line or by road depending on the selected algorithm. |
| duration | number | non presente nell'esempio | Driving time in minutes, included for the road algorithm. |
| lat | number | 47.049 | Latitude of the postal code's centre point. |
| lng | number | 8.299 | Longitude of the postal code's centre point. |
| postalCode | string | "6003" | The 4-digit postal code. |
| state | string | "Luzern" | The canton (Kanton). |
| region | string | "Central Switzerland" | The greater region (Grossregion). |
| district | string | "Luzern-Stadt" | The district (Bezirk). |
| settlement | string | "Luzern" | The municipality (Gemeinde) the postal code lies in; when the postal code spans several, one of them. |
[
{
"distance": 40379,
"district": "Luzern-Stadt",
"lat": 47.049,
"lng": 8.299,
"postalCode": "6003",
"region": "Central Switzerland",
"settlement": "Luzern",
"state": "Luzern"
},
{
"distance": 95378,
"district": "Bern-Mittelland",
"lat": 46.948,
"lng": 7.447,
"postalCode": "3011",
"region": "Espace Mittelland",
"settlement": "Bern",
"state": "Bern"
},
{
"distance": 173384,
"district": "Lausanne",
"lat": 46.52,
"lng": 6.632,
"postalCode": "1003",
"region": "Région lémanique",
"settlement": "Lausanne",
"state": "Vaud"
}
]Errori
Campi di una risposta di errore
| Campo | Tipo | Descrizione |
|---|---|---|
| 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"
}
]
}Esempi di codice
curl "https://api.pro6pp.nl/v2/locator/ch?targetPostalCodes=6003%2C3011%2C1003&postalCode=8001&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à Svizzera Locator.
Creare la pagina HTML
Iniziamo creando una pagina HTML vuota con una struttura web minima. Crei un nuovo file
.htmldenominatopro6pp_svizzera_locator.html. Aggiunga il seguente codice tra i tag<body>e</body>. Questo codice aggiunge i campi di input per l'inserimento dell'indirizzo.<form class="form" id="form"> <div>Call</div> <div> <label for="targetPostalCodes">targetPostalCodes:</label> <input id="targetPostalCodes" class="targetPostalCodes" placeholder="6003,3011,1003"/> <label for="postalCode">postalCode:</label> <input id="postalCode" class="postalCode" placeholder="8001"/> <label for="lat">lat:</label> <input id="lat" class="lat" placeholder=""/> <label for="lng">lng:</label> <input id="lng" class="lng" placeholder=""/> <label for="orderBy">orderBy:</label> <input id="orderBy" class="orderBy" placeholder=""/> <label for="maxResults">maxResults:</label> <input id="maxResults" class="maxResults" placeholder=""/> <label for="algorithm">algorithm:</label> <input id="algorithm" class="algorithm" 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>Aggiungere l'interazione
Aggiunga il seguente codice JavaScript in un file separato
pro6pp_svizzera_locator.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.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 = { targetPostalCodes: document.getElementById("targetPostalCodes").value, authKey: authKey }; const optionalQueryParams = [ "postalCode", "lat", "lng", "orderBy", "maxResults", "algorithm", ]; for (const name of optionalQueryParams) { const value = document.getElementById(name).value; if (value !== "") { queryParams[name] = value; } } let encodedUrl = new URL(`${BASE_URL}/locator/ch`); 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); } });Farlo funzionare
Colleghi il file JavaScript all'interno di
pro6pp_svizzera_locator.htmlsubito prima del tag di chiusura</body>.... <script src="pro6pp_svizzera_locator.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_KEYindicato 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.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_svizzera_locator.html- la pagina HTML con il modulo.pro6pp_svizzera_locator.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:file:///C:/Users/YourName/Documents/pro6pp_svizzera_locator.html file:///Users/yourname/Desktop/pro6pp_svizzera_locator.htmlUna volta aperta la pagina, inizi a digitare nei campi del modulo e prema Submit per visualizzare la risposta dell'API nella sezione "Full Response".