Suggest Storbritannien

Oversigt

ParametreQuerystreng

Svar

[
  {
    "postalCodes": [
      "N1 3DH",
      "N1 3DT"
    ],
    "street": "Shepperton Road",
    "settlement": "Barnsbury",
    "lat": 51.538,
    "lng": -0.088,
    "district": "Hackney"
  }
]

Fejl

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

Kodeeksempler

curl "https://api.pro6pp.nl/v2/suggest/gb/street?street=Shepperton+Road&postalCode=N1+3DH&settlement=Barnsbury&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 Storbritannien Suggest -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_storbritannien_suggest.html. Tilføj følgende kode mellem <body> og </body> tags. Den tilføjer inputfelter til indtastning af adressen.

   pro6pp_storbritannien_suggest.htmlKopiér

   <form class="form" id="form">
     <div>Call</div>
     <div>
       <label for="street">street:</label>
       <input id="street" class="street" placeholder="Shepperton Road"/>
       <label for="postalCode">postalCode:</label>
       <input id="postalCode" class="postalCode" placeholder="N1 3DH"/>
       <label for="settlement">settlement:</label>
       <input id="settlement" class="settlement" placeholder="Barnsbury"/>
       <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>

   Vis hele koden

2. Tilføj interaktion

   Tilføj følgende JavaScript-kode i en separat pro6pp_storbritannien_suggest.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_storbritannien_suggest.jsKopiér

   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 = [
               "street",
               "postalCode",
               "settlement",
               "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/gb/street`);
           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);
       }
   });

   Vis hele koden

3. Få det til at fungere

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

   pro6pp_storbritannien_suggest.htmlKopiér

     ...
     <script src="pro6pp_storbritannien_suggest.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_storbritannien_suggest.html - HTML-siden
   • pro6pp_storbritannien_suggest.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å filstierKopiér

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