Range Österreich

Beta

Liefert die österreichischen Postleitzahlen im Umkreis einer bestimmten Postleitzahl.

GEThttps://api.pro6pp.nl/v2/range/at

Übersicht

Returns the postal codes within a range of a postal code or settlement.

  • postalCode or settlement is required. When both are supplied, postalCode is used.
  • An ambiguous settlement returns HTTP 400.

ParameterQuery-String

authKeystringErforderlich

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.

postalCodestringKann null sein
Muster
^[0-9]{4}$
settlementstring

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

Beispiel
Eisenstadt
searchRangeinteger

The range to search, in meters. Maximum 100000.

Beispiel
10000
Standard
5000
Min.
1
Max.
100000
maxResultsinteger

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

Beispiel
3
Standard
10
Min.
1
Max.
999
includeInitialPostalCodeboolean

Option whether to include the initial postal code in /v2/range calls. If the value is True, then the initial postal code is included in the search.

Standard
false

Antworten

200Postcodes within range, or an empty array when nothing matchesListe der Ergebnisse
FeldTypBeispielwertBeschreibung
postalCodestring"7000"

The 4-digit postal code.

distanceinteger50

Straight-line distance in metres from the requested postal code or settlement, rounded to whole metres.

latnumber47.84627

Representative latitude of the postal code.

lngnumber16.52752

Representative longitude of the postal code.

Beispielhafte Antwort
[
  {
    "postalCode": "7000",
    "distance": 50,
    "lat": 47.84627,
    "lng": 16.52752
  },
  {
    "postalCode": "7062",
    "distance": 7879,
    "lat": 47.80246,
    "lng": 16.61038
  }
]

Fehler

Felder einer Fehlerantwort
FeldTypBeschreibung
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.

400Ungültige Anfrage
MISSING_PARAMETER

Neither postalCode nor settlement is supplied.

MISSING_PARAMETER
{
  "error_id": "MISSING_PARAMETER",
  "errors": [
    {
      "message": "Required parameter postalCode is missing",
      "help": "https://pro6pp.nl/docs/v2/redoc#operation/public_api.v2_generic.range.router.at",
      "parameter": "postalCode"
    },
    {
      "message": "Required parameter settlement is missing",
      "help": "https://pro6pp.nl/docs/v2/redoc#operation/public_api.v2_generic.range.router.at",
      "parameter": "settlement"
    }
  ]
}
INVALID_PARAMETER_TYPE

A value has the wrong type, such as a non-integer searchRange.

INVALID_PARAMETER_TYPE
{
  "error_id": "INVALID_PARAMETER_TYPE",
  "errors": [
    {
      "message": "parameter: searchRange has invalid 5km, should be integer",
      "help": "https://pro6pp.nl/docs/v2/redoc#operation/public_api.v2_generic.range.router.at",
      "parameter": "searchRange"
    }
  ]
}
INVALID_VALUE

A value is malformed or out of bounds, or the postalCode or settlement origin cannot be found.

INVALID_VALUE
{
  "error_id": "INVALID_VALUE",
  "errors": [
    {
      "message": "value is invalid",
      "help": "https://pro6pp.nl/docs/v2/redoc#operation/public_api.v2_generic.range.router.at",
      "parameter": "postalCode",
      "value": "invalid"
    }
  ]
}
MULTIPLE_RESULTS_FOUND

The settlement is ambiguous.

MULTIPLE_RESULTS_FOUND
{
  "error_id": "MULTIPLE_RESULTS_FOUND",
  "errors": [
    {
      "message": "Multiple results found",
      "help": "https://pro6pp.nl/docs/v2/redoc#operation/public_api.v2_generic.range.router.at"
    }
  ]
}
401Nicht autorisiert
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"
    }
  ]
}

Codebeispiele

curl "https://api.pro6pp.nl/v2/range/at?settlement=Eisenstadt&searchRange=10000&maxResults=3&authKey=YOUR_API_KEY"

Wir ermutigen Sie, Beispielcode in der von Ihnen bevorzugten Sprache anzufordern.

Schritt für Schritt

Richten Sie ein Schnellformular ein, um die Österreich Range-Funktionalität auszuprobieren, indem Sie die folgenden Schritte ausführen.

  1. Erstellen der HTML-Seite

    Wir beginnen mit der Erstellung einer leeren HTML-Seite, die eine minimale Webseitenstruktur enthält. Erstellen Sie eine neue Datei .html mit dem Namen pro6pp_österreich_range.html. Fügen Sie den folgenden Code zwischen den Tags <body> und </body> hinzu. Es fügt die Eingabefelder für die Adresseingabe hinzu.

    pro6pp_österreich_range.html
    <form class="form" id="form">
      <div>Call</div>
      <div>
        <label for="postalCode">postalCode:</label>
        <input id="postalCode" class="postalCode" placeholder=""/>
        <label for="settlement">settlement:</label>
        <input id="settlement" class="settlement" placeholder="Eisenstadt"/>
        <label for="searchRange">searchRange:</label>
        <input id="searchRange" class="searchRange" placeholder="10000"/>
        <label for="maxResults">maxResults:</label>
        <input id="maxResults" class="maxResults" placeholder="3"/>
        <label for="includeInitialPostalCode">includeInitialPostalCode:</label>
        <input id="includeInitialPostalCode" class="includeInitialPostalCode" 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. Interaktion hinzufügen

    Fügen Sie den folgenden JavaScript-Code in eine separate pro6pp_österreich_range.js-Datei ein. Die IDs und Klassennamen der HTML-Elemente sollten mit den in dieser JavaScript-Datei angegebenen übereinstimmen, um die richtigen Ergebnisse zu erhalten.

    pro6pp_österreich_range.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 = [
                "postalCode",
                "settlement",
                "searchRange",
                "maxResults",
                "includeInitialPostalCode",
            ];
            for (const name of optionalQueryParams) {
                const value = document.getElementById(name).value;
                if (value !== "") {
                    queryParams[name] = value;
                }
            }
    
            let encodedUrl = new URL(`${BASE_URL}/range/at`);
            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. Umsetzung in die Praxis

    Verknüpfen Sie die JavaScript-Datei innerhalb des pro6pp_österreich_range.html direkt vor dem Schließen des </body>-Tags.

    pro6pp_österreich_range.html
      ...
      <script src="pro6pp_österreich_range.js"></script>
     </body>
    </html>

    Um auf den Pro6PP-Webdienst zuzugreifen, müssen Sie Ihren persönlichen Autorisierungsschlüssel anfordern. Dieser Schlüssel wird Ihnen direkt nach der Anmeldung per E-Mail zugeschickt. Ersetzen Sie den obigen Platzhalter AUTH_KEY durch Ihren persönlichen Autorisierungsschlüssel.

    Wenn Sie noch kein Konto haben, melden Sie sich für einen kostenlosen 2 Monate Test an. Nachdem Sie Ihr Konto erstellt haben, gehen Sie zu Ihren Abonnementdetails und kopieren Sie Ihren AUTH_KEY. Sie benötigen diesen Schlüssel, um Ihre Anfragen zu authentifizieren.

  4. In Aktion sehen

    Wenn Sie die vorherigen Schritte abgeschlossen haben, ist es an der Zeit, das Formular lokal in Ihrem Browser auszuführen. Sie sollten nun zwei Dateien im selben Ordner auf Ihrem Computer haben:

    • pro6pp_österreich_range.html - die HTML-Seite mit dem Formular.
    • pro6pp_österreich_range.js - die JavaScript-Datei, die die Interaktion steuert.

    Sie können die HTML-Datei nun in Ihrem Browser öffnen, indem Sie einfach in Ihrem Datei-Explorer (z. B. Finder unter macOS oder Datei-Explorer unter Windows) auf die Datei doppelklicken. Alternativ können Sie die Datei auch manuell im Browser mit dem vollständigen file:///-Pfad öffnen. Zum Beispiel:

    Beispiel für Dateipfade
    file:///C:/Users/YourName/Documents/pro6pp_österreich_range.html
    file:///Users/yourname/Desktop/pro6pp_österreich_range.html

    Sobald die Seite geöffnet ist, geben Sie die Daten in die Formularfelder ein und klicken Sie auf Senden, um die API-Antwort im Abschnitt „Vollständige Antwort“ anzuzeigen.