Suggest Deutschland

Übersicht

ParameterQuery-String

Antworten

[
  {
    "lat": 51.054,
    "lng": 13.726,
    "municipality": "Dresden",
    "postalCodes": [
      "01067"
    ],
    "settlement": "Dresden",
    "state": "Sachsen"
  }
]

Fehler

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

Codebeispiele

curl "https://api.pro6pp.nl/v2/suggest/de/settlement?settlement=Dresden&postalCode=01067&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 Deutschland Suggest-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_deutschland_suggest.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_deutschland_suggest.htmlKopieren

   <form class="form" id="form">
     <div>Call</div>
     <div>
       <label for="settlement">settlement:</label>
       <input id="settlement" class="settlement" placeholder="Dresden"/>
       <label for="postalCode">postalCode:</label>
       <input id="postalCode" class="postalCode" placeholder="01067"/>
       <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>

   Vollständigen Code anzeigen

2. Interaktion hinzufügen

   Fügen Sie den folgenden JavaScript-Code in eine separate pro6pp_deutschland_suggest.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_deutschland_suggest.jsKopieren

   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/de/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);
       }
   });

   Vollständigen Code anzeigen

3. Umsetzung in die Praxis

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

   pro6pp_deutschland_suggest.htmlKopieren

     ...
     <script src="pro6pp_deutschland_suggest.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_deutschland_suggest.html - die HTML-Seite mit dem Formular.
   • pro6pp_deutschland_suggest.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 DateipfadeKopieren

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