Suggest Danmark

Beta

Foreslå et dansk adressefelt.

GEThttps://api.pro6pp.nl/v2/suggest/dk/settlement

Oversigt

Returns settlement suggestions for a partly typed settlement.

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.

settlementstring

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

Eksempel
Vejle
postalCodestring

The address's postal code which consists of four digits.

Eksempel
7100
Mønster
^[0-9]{4}$
maxResultsinteger

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

Standard
10
Min.
1
Maks.
999
cursorstring

The page to return, the variables for the next/previous pages can be found in the results Link header.

Svar

200Settlement suggestions, or an empty array when nothing matchesListe over resultater
FeltTypeEksempelværdiBeskrivelse
settlementstring"Vejle"

The settlement.

municipalitystring"Hedensted"

The municipality (kommune).

provincestring"East Jutland"

The province (landsdel).

regionstring"Central Denmark Region"

The region.

latnumber55.708

Latitude of the settlement at its lowest postal code, or at the postal code the request names.

lngnumber9.53

Longitude of the settlement at its lowest postal code, or at the postal code the request names.

Eksempel på svar
[
  {
    "lat": 55.708,
    "lng": 9.53,
    "municipality": "Hedensted",
    "province": "East Jutland",
    "region": "Central Denmark Region",
    "settlement": "Vejle"
  },
  {
    "lat": 55.708,
    "lng": 9.53,
    "municipality": "Vejle",
    "province": "South Jutland",
    "region": "Region Southern Denmark",
    "settlement": "Vejle"
  },
  {
    "lat": 55.708,
    "lng": 9.53,
    "municipality": "Vejle",
    "province": "South Jutland",
    "region": "Region Southern Denmark",
    "settlement": "Vejle Enge"
  }
]

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/suggest/dk/settlement?settlement=Vejle&postalCode=7100&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 Danmark 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_danmark_suggest.html. Tilføj følgende kode mellem <body> og </body> tags. Den tilføjer inputfelter til indtastning af adressen.

    pro6pp_danmark_suggest.html
    <form class="form" id="form">
      <div>Call</div>
      <div>
        <label for="settlement">settlement:</label>
        <input id="settlement" class="settlement" placeholder="Vejle"/>
        <label for="postalCode">postalCode:</label>
        <input id="postalCode" class="postalCode" placeholder="7100"/>
        <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>
  2. Tilføj interaktion

    Tilføj følgende JavaScript-kode i en separat pro6pp_danmark_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_danmark_suggest.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 = [
                "settlement",
                "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/dk/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);
        }
    });
  3. Få det til at fungere

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

    pro6pp_danmark_suggest.html
      ...
      <script src="pro6pp_danmark_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_danmark_suggest.html - HTML-siden
    • pro6pp_danmark_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å filstier
    file:///C:/Users/YourName/Documents/pro6pp_danmark_suggest.html
    file:///Users/yourname/Desktop/pro6pp_danmark_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«.