Suggest Belgio

Panoramica

ParametriQuery string

Risposte

[
  {
    "languageCode": "nl",
    "lat": 50.628,
    "lng": 6.038,
    "municipality": "Eupen",
    "municipalityTranslations": [
      {
        "lang": "nl",
        "name": "Eupen"
      },
      {
        "lang": "fr",
        "name": "Eupen"
      },
      {
        "lang": "de",
        "name": "Eupen"
      }
    ],
    "postcodes": [
      "4700"
    ],
    "postname": "Eupen",
    "province": "Luik",
    "provinceTranslations": [
      {
        "lang": "nl",
        "name": "Luik"
      },
      {
        "lang": "fr",
        "name": "Liège"
      },
      {
        "lang": "de",
        "name": "Lüttich"
      }
    ],
    "region": "Wallonië",
    "regionTranslations": [
      {
        "lang": "nl",
        "name": "Wallonië"
      },
      {
        "lang": "fr",
        "name": "Wallonie"
      },
      {
        "lang": "de",
        "name": "Wallonie"
      }
    ],
    "settlement": "Eupen",
    "settlementTranslations": [
      {
        "lang": "nl",
        "name": "Eupen"
      },
      {
        "lang": "de",
        "name": "Eupen"
      }
    ]
  }
]

Errori

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

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

{
  "error_id": "INVALID_VALUE",
  "errors": [
    {
      "message": "value is invalid",
      "help": "https://pro6pp.nl/docs/v2/redoc",
      "parameter": "postalCode",
      "value": "invalid"
    }
  ]
}

{
  "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/suggest/be/settlement?settlement=Eupen&postalCode=4700&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à Belgio Suggest.

1. Creare la pagina HTML

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

   pro6pp_belgio_suggest.htmlCopi

   <form class="form" id="form">
     <div>Call</div>
     <div>
       <label for="settlement">settlement:</label>
       <input id="settlement" class="settlement" placeholder="Eupen"/>
       <label for="languageCode">languageCode:</label>
       <input id="languageCode" class="languageCode" placeholder=""/>
       <label for="postalCode">postalCode:</label>
       <input id="postalCode" class="postalCode" placeholder="4700"/>
       <label for="maxResults">maxResults:</label>
       <input id="maxResults" class="maxResults" placeholder=""/>
       <label for="cursor">cursor:</label>
       <input id="cursor" class="cursor" 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>

   Mostri il codice completo

2. Aggiungere l'interazione

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

   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 = [
               "settlement",
               "languageCode",
               "postalCode",
               "maxResults",
               "cursor",
           ];
           for (const name of optionalQueryParams) {
               const value = document.getElementById(name).value;
               if (value !== "") {
                   queryParams[name] = value;
               }
           }
   
           let encodedUrl = new URL(`${BASE_URL}/suggest/be/settlement`);
           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);
       }
   });

   Mostri il codice completo

3. Farlo funzionare

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

   pro6pp_belgio_suggest.htmlCopi

     ...
     <script src="pro6pp_belgio_suggest.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_belgio_suggest.html - la pagina HTML con il modulo.
   • pro6pp_belgio_suggest.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 esempioCopi

   file:///C:/Users/YourName/Documents/pro6pp_belgio_suggest.html
   file:///Users/yourname/Desktop/pro6pp_belgio_suggest.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".