Distance Francia

Beta

Return driving distance and time between two French postcodes.

GEThttps://api.pro6pp.nl/v2/distance/fr

Panoramica

Returns the distance between a start and a destination postcode. With the road algorithm the distance is over the road in meters and includes the car drive time in minutes.

Both postcodes must be 5 digits long.

ParametriQuery string

authKeystringObbligatorio

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.

fromPostalCodestringObbligatorio

The postcode to start calculating from.

Esempio
01000
toPostalCodestringObbligatorio

The postcode to calculate to.

Esempio
01100
algorithmstring

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 road depends on your subscription level.
Esempio
straight
Predefinito
"straight"
Uno tra
straightroad

Risposte

200Distance between the two postcodes
CampoTipoValore di esempioDescrizione
distancenumber32932

Distance in metres between the two postal codes: over the road network for the road algorithm, in a straight line otherwise; 0 for the same postal code.

durationnumberNullablenon presente nell'esempio

Driving time in whole minutes, rounded down, for the road algorithm; absent for the straight algorithm.

Risposta di esempio
{
  "distance": 32932
}

Errori

Campi di una risposta di errore
CampoTipoDescrizione
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.

400Richiesta non valida
INVALID_VALUE

A postal code is missing, malformed or cannot be found, or algorithm is not straight or road.

INVALID_VALUE
{
  "error_id": "INVALID_VALUE",
  "errors": [
    {
      "message": "Input should be 'straight' or 'road'",
      "help": "https://pro6pp.nl/docs/v2/redoc",
      "parameter": "algorithm",
      "value": "fast"
    }
  ]
}
401Non autorizzato
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"
    }
  ]
}

Esempi di codice

curl "https://api.pro6pp.nl/v2/distance/fr?fromPostalCode=01000&toPostalCode=01100&algorithm=straight&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à Francia Distance.

  1. Creare la pagina HTML

    Iniziamo creando una pagina HTML vuota con una struttura web minima. Crei un nuovo file .html denominato pro6pp_francia_distance.html. Aggiunga il seguente codice tra i tag <body> e </body>. Questo codice aggiunge i campi di input per l'inserimento dell'indirizzo.

    pro6pp_francia_distance.html
    <form class="form" id="form">
      <div>Call</div>
      <div>
        <label for="fromPostalCode">fromPostalCode:</label>
        <input id="fromPostalCode" class="fromPostalCode" placeholder="01000"/>
        <label for="toPostalCode">toPostalCode:</label>
        <input id="toPostalCode" class="toPostalCode" placeholder="01100"/>
        <label for="algorithm">algorithm:</label>
        <input id="algorithm" class="algorithm" placeholder="straight"/>
      </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. Aggiungere l'interazione

    Aggiunga il seguente codice JavaScript in un file separato pro6pp_francia_distance.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.

    pro6pp_francia_distance.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 = {
                fromPostalCode: document.getElementById("fromPostalCode").value,
                toPostalCode: document.getElementById("toPostalCode").value,
                authKey: authKey
            };
            const optionalQueryParams = [
                "algorithm",
            ];
            for (const name of optionalQueryParams) {
                const value = document.getElementById(name).value;
                if (value !== "") {
                    queryParams[name] = value;
                }
            }
    
            let encodedUrl = new URL(`${BASE_URL}/distance/fr`);
            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. Farlo funzionare

    Colleghi il file JavaScript all'interno di pro6pp_francia_distance.html subito prima del tag di chiusura </body>.

    pro6pp_francia_distance.html
      ...
      <script src="pro6pp_francia_distance.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_KEY indicato 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.

  4. 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_francia_distance.html - la pagina HTML con il modulo.
    • pro6pp_francia_distance.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:

    Percorsi file di esempio
    file:///C:/Users/YourName/Documents/pro6pp_francia_distance.html
    file:///Users/yourname/Desktop/pro6pp_francia_distance.html

    Una volta aperta la pagina, inizi a digitare nei campi del modulo e prema Submit per visualizzare la risposta dell'API nella sezione "Full Response".