Range Paesi Bassi

Beta

Return Dutch postal codes within range of a given postal code.

GEThttps://api.pro6pp.nl/v2/range/nl

Panoramica

Returns the postal codes within a range of a postal code or settlement.

  • postalCode or settlement is required. When both are supplied, postalCode is used.
  • An ambiguous settlement returns HTTP 400.

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.

postalCodestring

Either the fourpp (e.g: 1000) or the sixpp (e.g: 1000AA) notation.

Esempio
1012
Pattern
^"?([0-9]{4})"?$|^"?([0-9]{4} ?[a-zA-Z]{2})"?$
settlementstring

The address's settlement (city, town, village, or hamlet).

Esempio
Amsterdam
municipalitystring

The address's municipality (only needed when there are multiple settlements by the same name to differentiate).

Esempio
Amsterdam
provincestring

The address's province (only needed when there are multiple settlements having the same municipality name, so there's a province needed to differentiate).

Esempio
Noord-Holland
searchRangeinteger

The range to search, in meters. Maximum 100000.

Esempio
10000
Predefinito
5000
Min
1
Max
100000
precisionstring

The precision for the returned results. Either sixpp or fourpp.

Predefinito
"fourpp"
Uno tra
fourppsixpp
maxResultsinteger

The amount of results returned, a number between 1 and 999. Default value is 10.

Predefinito
10
Min
1
Max
999
includeInitialPostalCodeboolean

Option whether to include the initial postal code in /v2/range calls. If the value is True, then the initial postal code is included in the search.

Predefinito
false

Risposte

200Postcodes within range, or an empty array when nothing matchesElenco di risultati
CampoTipoValore di esempioDescrizione
postalCodestring"1000"

The 4-digit postal code, or with precision sixpp the six-position postal code without a space, such as "1012AB".

distanceinteger223

Straight-line distance in metres from the requested postal code or settlement, rounded to whole metres.

latnumber52.375

Representative latitude of the postal code. For a 4-digit (fourpp) postal code that spans several settlements, this is the representative point of the dominant settlement (the one with the most addresses).

lngnumber4.899

Representative longitude of the postal code. For a 4-digit (fourpp) postal code that spans several settlements, this is the representative point of the dominant settlement (the one with the most addresses).

Risposta di esempio
[
  {
    "postalCode": "1000",
    "distance": 223,
    "lat": 52.375,
    "lng": 4.899
  },
  {
    "postalCode": "1001",
    "distance": 223,
    "lat": 52.375,
    "lng": 4.899
  },
  {
    "postalCode": "1002",
    "distance": 223,
    "lat": 52.375,
    "lng": 4.899
  },
  {
    "postalCode": "1003",
    "distance": 223,
    "lat": 52.375,
    "lng": 4.899
  },
  {
    "postalCode": "1005",
    "distance": 223,
    "lat": 52.375,
    "lng": 4.899
  },
  {
    "postalCode": "1006",
    "distance": 223,
    "lat": 52.375,
    "lng": 4.899
  },
  {
    "postalCode": "1007",
    "distance": 223,
    "lat": 52.375,
    "lng": 4.899
  },
  {
    "postalCode": "1008",
    "distance": 223,
    "lat": 52.375,
    "lng": 4.899
  },
  {
    "postalCode": "1009",
    "distance": 223,
    "lat": 52.375,
    "lng": 4.899
  },
  {
    "postalCode": "1014",
    "distance": 223,
    "lat": 52.375,
    "lng": 4.899
  }
]

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
MISSING_PARAMETER

Neither postalCode nor settlement is supplied.

MISSING_PARAMETER
{
  "error_id": "MISSING_PARAMETER",
  "errors": [
    {
      "message": "Required parameter postalCode is missing",
      "help": "https://pro6pp.nl/docs/v2/redoc#operation/public_api.v2_generic.range.router.nl",
      "parameter": "postalCode"
    },
    {
      "message": "Required parameter settlement is missing",
      "help": "https://pro6pp.nl/docs/v2/redoc#operation/public_api.v2_generic.range.router.nl",
      "parameter": "settlement"
    }
  ]
}
INVALID_PARAMETER_TYPE

A value has the wrong type, such as a non-integer searchRange.

INVALID_PARAMETER_TYPE
{
  "error_id": "INVALID_PARAMETER_TYPE",
  "errors": [
    {
      "message": "parameter: searchRange has invalid 5km, should be integer",
      "help": "https://pro6pp.nl/docs/v2/redoc#operation/public_api.v2_generic.range.router.nl",
      "parameter": "searchRange"
    }
  ]
}
INVALID_VALUE

A value is malformed or out of bounds, or the postalCode or settlement origin cannot be found.

INVALID_VALUE
{
  "error_id": "INVALID_VALUE",
  "errors": [
    {
      "message": "value is invalid",
      "help": "https://pro6pp.nl/docs/v2/redoc#operation/public_api.v2_generic.range.router.nl",
      "parameter": "postalCode",
      "value": "invalid"
    }
  ]
}
MULTIPLE_RESULTS_FOUND

The settlement is ambiguous; narrow it with municipality or province.

MULTIPLE_RESULTS_FOUND
{
  "error_id": "MULTIPLE_RESULTS_FOUND",
  "errors": [
    {
      "message": "Multiple results found",
      "help": "https://pro6pp.nl/docs/v2/redoc#operation/public_api.v2_generic.range.router.nl"
    }
  ]
}
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/range/nl?postalCode=1012&settlement=Amsterdam&municipality=Amsterdam&province=Noord-Holland&searchRange=10000&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à Paesi Bassi Range.

  1. Creare la pagina HTML

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

    pro6pp_paesi-bassi_range.html
    <form class="form" id="form">
      <div>Call</div>
      <div>
        <label for="postalCode">postalCode:</label>
        <input id="postalCode" class="postalCode" placeholder="1012"/>
        <label for="settlement">settlement:</label>
        <input id="settlement" class="settlement" placeholder="Amsterdam"/>
        <label for="municipality">municipality:</label>
        <input id="municipality" class="municipality" placeholder="Amsterdam"/>
        <label for="province">province:</label>
        <input id="province" class="province" placeholder="Noord-Holland"/>
        <label for="searchRange">searchRange:</label>
        <input id="searchRange" class="searchRange" placeholder="10000"/>
        <label for="precision">precision:</label>
        <input id="precision" class="precision" placeholder=""/>
        <label for="maxResults">maxResults:</label>
        <input id="maxResults" class="maxResults" placeholder=""/>
        <label for="includeInitialPostalCode">includeInitialPostalCode:</label>
        <input id="includeInitialPostalCode" class="includeInitialPostalCode" 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>
  2. Aggiungere l'interazione

    Aggiunga il seguente codice JavaScript in un file separato pro6pp_paesi-bassi_range.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_paesi-bassi_range.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 = {
                authKey: authKey
            };
            const optionalQueryParams = [
                "postalCode",
                "settlement",
                "municipality",
                "province",
                "searchRange",
                "precision",
                "maxResults",
                "includeInitialPostalCode",
            ];
            for (const name of optionalQueryParams) {
                const value = document.getElementById(name).value;
                if (value !== "") {
                    queryParams[name] = value;
                }
            }
    
            let encodedUrl = new URL(`${BASE_URL}/range/nl`);
            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_paesi-bassi_range.html subito prima del tag di chiusura </body>.

    pro6pp_paesi-bassi_range.html
      ...
      <script src="pro6pp_paesi-bassi_range.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_paesi-bassi_range.html - la pagina HTML con il modulo.
    • pro6pp_paesi-bassi_range.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_paesi-bassi_range.html
    file:///Users/yourname/Desktop/pro6pp_paesi-bassi_range.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".