Distance Italien

Beta

Køreafstand og -tid mellem to italienske postnumre.

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

Oversigt

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.

ParametreQuerystreng

authKeystringPåkrævet

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.

fromPostalCodestringPåkrævet

The postcode to start calculating from.

Eksempel
00185
toPostalCodestringPåkrævet

The postcode to calculate to.

Eksempel
20121
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.
Eksempel
road
Standard
"straight"
En af
straightroad

Svar

200Distance between the two postcodes
FeltTypeEksempelværdiBeskrivelse
distancenumber573039

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.

durationnumberKan være null361

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

Eksempel på svar
{
  "distance": 573039,
  "duration": 361
}

Fejl

Felter i et fejlsvar
FeltTypeBeskrivelse
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.

400Ugyldig anmodning
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"
    }
  ]
}
401Ikke autoriseret
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"
    }
  ]
}

Kodeeksempler

curl "https://api.pro6pp.nl/v2/distance/it?fromPostalCode=00185&toPostalCode=20121&algorithm=road&authKey=YOUR_API_KEY"

Vi opfordrer dig til at anmode om eksempelkode på det sprog, du foretrækker.

Trin for trin

Opret en hurtig formular for at afprøve Italien Distance -funktionaliteten ved at følge nedenstående trin.

  1. Opbyg HTML-siden

    Vi starter med at oprette en tom HTML-side, der indeholder en minimal websidestruktur. Opret en ny .html fil med navnet pro6pp_italien_distance.html. Tilføj følgende kode mellem <body> og </body> tags. Den tilføjer inputfelter til indtastning af adressen.

    pro6pp_italien_distance.html
    <form class="form" id="form">
      <div>Call</div>
      <div>
        <label for="fromPostalCode">fromPostalCode:</label>
        <input id="fromPostalCode" class="fromPostalCode" placeholder="00185"/>
        <label for="toPostalCode">toPostalCode:</label>
        <input id="toPostalCode" class="toPostalCode" placeholder="20121"/>
        <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. Tilføj interaktion

    Tilføj følgende JavaScript-kode i en separat pro6pp_italien_distance.js-fil. HTML-elementernes ID'er og klassenavne skal stemme overens med dem, der er angivet i denne JavaScript-fil, for at få de korrekte resultater.

    pro6pp_italien_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/it`);
            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. Få det til at fungere

    Link JavaScript-filen inde i pro6pp_italien_distance.html lige før du lukker </body>-tagget.

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

    For at få adgang til Pro6PP-webservicen skal du anmode om din personlige autorisationsnøgle. Denne nøgle sendes til dig via e-mail lige efter tilmelding. Erstat ovenstående pladsholder AUTH_KEY med din personlige autorisationsnøgle.

    Hvis du ikke har en konto endnu, kan du tilmelde dig en gratis prøveperiode på 2 måneder. Når du har oprettet din konto, skal du gå til dine abonnementsoplysninger og kopiere din AUTH_KEY. Du skal bruge denne nøgle til at godkende dine anmodninger.

  4. Se det i aktion

    Når du har gennemført de foregående trin, er det tid til at køre formularen lokalt i din browser. Du bør nu have to filer i den samme mappe på din computer:

    • pro6pp_italien_distance.html - HTML-siden
    • pro6pp_italien_distance.js - den JavaScript-fil, der håndterer interaktionen.

    Du kan nu åbne HTML-filen i din browser ved blot at dobbeltklikke på den i din filudforsker (f.eks. Finder på macOS eller File Explorer på Windows). Alternativt kan du åbne den manuelt i browseren ved at bruge den fulde file:///-sti. For eksempel:

    Eksempel på filstier
    file:///C:/Users/YourName/Documents/pro6pp_italien_distance.html
    file:///Users/yourname/Desktop/pro6pp_italien_distance.html

    Når siden åbnes, skal du begynde at skrive i formularfelterne og trykke på Submit for at se API-svaret blive vist i afsnittet »Full Response«.