Locator Belgien

Beta

Find postnumre i nærheden ud fra et postnummer eller en kombination af breddegrad og længdegrad.

GEThttps://api.pro6pp.nl/v2/locator/be

Oversigt

Returns your own list of postcodes ordered by distance from a postcode or a lat/lng origin.

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.

targetPostalCodesarray of stringPåkrævet

An array of postcodes (e.g: [1200, 2000, 9000]).

Eksempel
["1200","2000","9000"]
postalCodestring

The postcode (e.g: 1000), if both postalCode and lat/lng combination is given the lat/lng from the postalCode will be used.

Eksempel
1000
Mønster
^[0-9]{4}$
latnumber

The latitude.

lngnumber

The longitude.

orderBystring

The order in which to return the results: distance (default) or input (keeps the input ordering).

Standard
"distance"
maxResultsinteger

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

Standard
10
Min.
1
Maks.
999
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.
    • For trial purposes, this algorithm can be used with any subscription level for the following postcodes: 1000 (Brussels), 1020 (Laeken) and 1030 (Schaerbeek).
Standard
"straight"
En af
straightroad

Svar

200The supplied postcodes ordered from near to far, or an empty array when none matchListe over resultater
FeltTypeEksempelværdiBeskrivelse
distancenumber4638

Distance in metres from the origin, in a straight line or by road depending on the selected algorithm.

durationnumberikke i eksemplet

Driving time in minutes, included for the road algorithm.

latnumber50.846

Latitude of the postal code's centre point.

lngnumber4.425

Longitude of the postal code's centre point.

postalCodestring"1200"

The 4-digit postal code.

regionstring"Brussel"

The region (Gewest/Région).

provincestring"Brussel"

The province (Provincie/Province).

municipalitystring"Sint-Lambrechts-Woluwe"

The municipality (Gemeente/Commune).

settlementstring"Sint-Lambrechts-Woluwe"

The settlement the postal code lies in; when the postal code spans several settlements, one of them.

Eksempel på svar
[
  {
    "distance": 4638,
    "lat": 50.846,
    "lng": 4.425,
    "municipality": "Sint-Lambrechts-Woluwe",
    "postalCode": "1200",
    "province": "Brussel",
    "region": "Brussel",
    "settlement": "Sint-Lambrechts-Woluwe"
  },
  {
    "distance": 41520,
    "lat": 51.218,
    "lng": 4.402,
    "municipality": "Antwerpen",
    "postalCode": "2000",
    "province": "Antwerpen",
    "region": "Vlaanderen",
    "settlement": "Antwerpen"
  },
  {
    "distance": 50465,
    "lat": 51.052,
    "lng": 3.718,
    "municipality": "Gent",
    "postalCode": "9000",
    "province": "Oost-Vlaanderen",
    "region": "Vlaanderen",
    "settlement": "Gent"
  }
]

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
MISSING_PARAMETER

A parameter that other parameters depend on is missing. errors has one entry per missing parameter.

MISSING_PARAMETER
{
  "error_id": "MISSING_PARAMETER",
  "errors": [
    {
      "message": "Required parameter lat is missing",
      "help": "https://pro6pp.nl/docs/v2/redoc",
      "parameter": "lat"
    }
  ]
}
INVALID_PARAMETER_TYPE

A value has the wrong type, such as text for a number.

INVALID_PARAMETER_TYPE
{
  "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_VALUE

A required parameter is missing, or a value is malformed, out of bounds or cannot be found.

INVALID_VALUE
{
  "error_id": "INVALID_VALUE",
  "errors": [
    {
      "message": "value is invalid",
      "help": "https://pro6pp.nl/docs/v2/redoc",
      "parameter": "postalCode",
      "value": "invalid"
    }
  ]
}
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/locator/be?targetPostalCodes=1200%2C2000%2C9000&postalCode=1000&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 Belgien Locator -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_belgien_locator.html. Tilføj følgende kode mellem <body> og </body> tags. Den tilføjer inputfelter til indtastning af adressen.

    pro6pp_belgien_locator.html
    <form class="form" id="form">
      <div>Call</div>
      <div>
        <label for="targetPostalCodes">targetPostalCodes:</label>
        <input id="targetPostalCodes" class="targetPostalCodes" placeholder="1200,2000,9000"/>
        <label for="postalCode">postalCode:</label>
        <input id="postalCode" class="postalCode" placeholder="1000"/>
        <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>
  2. Tilføj interaktion

    Tilføj følgende JavaScript-kode i en separat pro6pp_belgien_locator.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_belgien_locator.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 = {
                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/be`);
            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_belgien_locator.html lige før du lukker </body>-tagget.

    pro6pp_belgien_locator.html
      ...
      <script src="pro6pp_belgien_locator.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_belgien_locator.html - HTML-siden
    • pro6pp_belgien_locator.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_belgien_locator.html
    file:///Users/yourname/Desktop/pro6pp_belgien_locator.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«.