Infer Tyskland

Alpha

Foreslå mulige tyske adresser fra en streng.

GEThttps://api.pro6pp.nl/v2/infer/de

Oversigt

Resolves a single query string into complete or probable addresses and returns a list of ranked suggestions. Each suggestion includes a stage indicating the current resolution step or completion status.

Stage meanings:

  • empty: returned on an empty query.
  • mixed: settlement and street suggestions.
  • postcode: postal code suggestions.
  • street_number: street number suggestions.
  • addition: street number addition suggestions.
  • direct: full address suggestions, with or without an addition.
  • final: a fully validated and structured address.

Street and settlement name matching:

  • One or two characters match names from the start (prefix).
  • Three or more characters match anywhere in the name: gebouw also finds Klokgebouw.
  • Matches are ranked by quality: the exact name first, then names the query starts, then matches beginning at a word boundary, then mid-word matches. Ties within a rank go to the name covering the most addresses.
  • When the names containing the query leave suggestion slots free, close matches fill them below the exact matches, absorbing typos.

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.

querystringPåkrævet

String to generate suggestions from.

Eksempel
Dresden, Am Bram
limitinteger

Maximum number of suggestions to return. Must be between 1 and 1000 when provided; omitting the parameter uses the default page size.

Min.
1
Maks.
1000
sortstring

Sort mixed city and street suggestions by relevance (default) or distance. Distance sorting requires the Infer Extended (infer::location) capability. Distance sorting uses lat and lng when provided. Otherwise, it uses the approximate location derived from the request IP. If that location is unavailable, suggestions are sorted by relevance.

Standard
"relevance"
En af
relevancedistance
latnumber

Latitude of the origin used for distance sorting. When providing coordinates, include both lat and lng.

Min.
-90
Maks.
90
lngnumber

Longitude of the origin used for distance sorting. When providing coordinates, include both lat and lng.

Min.
-180
Maks.
180

Svar

200Address suggestions for the query
FeltTypeBeskrivelse
citiesarray of objectKan være null

Settlements matching the query, returned only in the mixed stage when any match.

cities[].labelstring

The settlement name.

cities[].exactboolean

False for a fuzzy match; left out for an exact one

cities[].matched_valuestring

The value a fuzzy match found, in lowercase

cities[].diff_positionsarray of integer

The 0-based positions in the query that differ from the fuzzy match

stagestring

The current stage of address inference

streetsarray of objectKan være null

Streets matching the query, returned only in the mixed stage when any match.

streets[].labelstring

The street name.

streets[].subtitlestring

The settlement the street lies in, with its postal code when it has one

streets[].countstringKan være null

How many settlements ("3 places") or postal codes ("2 postcodes") the street name occurs in, when more than one.

streets[].exactboolean

False for a fuzzy match; left out for an exact one

streets[].matched_valuestring

The value a fuzzy match found, in lowercase

streets[].diff_positionsarray of integer

The 0-based positions in the query that differ from the fuzzy match

suggestionsarray of object

Suggestions for the next part of the address; in the mixed stage, the matching settlements and streets in ranked order.

suggestions[].labelstring

Human-readable label for the suggestion

suggestions[].subtitlestringKan være null

Additional context information (e.g., postal code)

suggestions[].countstringKan være null

Number of results for this suggestion (e.g., "2 postcodes")

suggestions[].valuestring | object

Canonical selection string or structured address data for address-detail suggestions.

suggestions[].exactboolean

False for a fuzzy match; left out for an exact one

suggestions[].matched_valuestring

The value a fuzzy match found, in lowercase

suggestions[].diff_positionsarray of integer

The 0-based positions in the query that differ from the fuzzy match

Eksempel på svar
{
  "stage": "street",
  "suggestions": [
    {
      "label": "Am Bramschkontor",
      "subtitle": "01067"
    }
  ]
}

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/infer/de?query=Dresden%2C+Am+Bram&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 Tyskland Infer -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_tyskland_infer.html. Tilføj følgende kode mellem <body> og </body> tags. Den tilføjer inputfelter til indtastning af adressen.

    pro6pp_tyskland_infer.html
    <form class="form" id="form">
      <div>Call</div>
      <div>
        <label for="query">query:</label>
        <input id="query" class="query" placeholder="Dresden, Am Bram"/>
        <label for="limit">limit:</label>
        <input id="limit" class="limit" placeholder=""/>
        <label for="sort">sort:</label>
        <input id="sort" class="sort" placeholder=""/>
        <label for="lat">lat:</label>
        <input id="lat" class="lat" placeholder=""/>
        <label for="lng">lng:</label>
        <input id="lng" class="lng" 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_tyskland_infer.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_tyskland_infer.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 = {
                query: document.getElementById("query").value,
                authKey: authKey
            };
            const optionalQueryParams = [
                "limit",
                "sort",
                "lat",
                "lng",
            ];
            for (const name of optionalQueryParams) {
                const value = document.getElementById(name).value;
                if (value !== "") {
                    queryParams[name] = value;
                }
            }
    
            let encodedUrl = new URL(`${BASE_URL}/infer/de`);
            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_tyskland_infer.html lige før du lukker </body>-tagget.

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