Distance Grande-Bretagne

Bêta

Retourner la distance et le temps de trajet entre deux codes postaux britanniques.

Référence OpenAPI
GEThttps://api.pro6pp.nl/v2/distance/gb

Vue d'ensemble

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 may be outward, district or full precision.

Note: the GB country code denotes the United Kingdom (ISO 3166-1 GB). Coverage is currently limited to England; Scotland, Wales and Northern Ireland are not yet included and will be added as coverage expands.

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.

fromPostalCodestringObligatoire

The postcode to start calculating from.

Exemple
SW1A1AA
toPostalCodestringObligatoire

The postcode to calculate to.

Exemple
W1A1AA
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.
Exemple
road
Par défaut
"straight"
L'une des valeurs
straightroad

Réponses

200Distance between the two postcodes
ChampTypeValeur d'exempleDescription
distancenumber3798

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.

durationnumberPeut être null9

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

Exemple de réponse
{
  "distance": 3798,
  "duration": 9
}

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
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 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"
    }
  ]
}

Exemples de code

curl "https://api.pro6pp.nl/v2/distance/gb?fromPostalCode=SW1A1AA&toPostalCode=W1A1AA&algorithm=road&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é Grande-Bretagne Distance 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_grande-bretagne_distance.html. Ajoutez le code suivant entre les balises <body> et </body>. Cela ajoute les champs de saisie pour saisir l'adresse.

    pro6pp_grande-bretagne_distance.html
    <form class="form" id="form">
      <div>Call</div>
      <div>
        <label for="fromPostalCode">fromPostalCode:</label>
        <input id="fromPostalCode" class="fromPostalCode" placeholder="SW1A1AA"/>
        <label for="toPostalCode">toPostalCode:</label>
        <input id="toPostalCode" class="toPostalCode" placeholder="W1A1AA"/>
        <label for="algorithm">algorithm:</label>
        <input id="algorithm" class="algorithm" placeholder="road"/>
      </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_grande-bretagne_distance.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_grande-bretagne_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/gb`);
            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_grande-bretagne_distance.html fichier juste avant de fermer la balise </body>.

    pro6pp_grande-bretagne_distance.html
      ...
      <script src="pro6pp_grande-bretagne_distance.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_grande-bretagne_distance.html - la page HTML contenant le formulaire.
    • pro6pp_grande-bretagne_distance.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_grande-bretagne_distance.html
    file:///Users/yourname/Desktop/pro6pp_grande-bretagne_distance.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 ».