Die Endpunkteinrichtung für eine Adressabfrage

Im folgenden Beispiel tätigen wir eine Adressabfrage, die geordnet nach Firmennamen ist und uns die ersten drei Einträge der Datenbank anzeigt. Als Sicherheitsabfrage verwenden wir die von uns empfohlene »JWT Bearer Token«-Abfrage.

GET /api/adressen

Beispiel Request URL:

http(s)://host:port/api/Adressen?FilterExpression=Firma%20like%20%27A%25%27&OrderBy=Firma%20DESC&Top=5

Beispiel Response:

[
  {
    "ID": 1234,
    "Firma": "Altenkirchen",
    "Nachname": "Klonen",
    "Vorname": "Karl",
    "Geburtstag": "1981-12-12T00:00:00"
  },
  {
    "ID": 5678,
    "Firma": "ABC Nachhilfe",
    "Nachname": "Mustermann",
    "Vorname": "Max",
    "Geburtstag": "1990-02-18T00:00:00"
  }
]

Den Endpunkt einrichten in CXM WEB CONNECT

• Öffnen Sie Ihr cobra CXM WEB CONNECT zur Konfiguration.
• Wechseln Sie in das Register »Endpunkte«.
• Klicken Sie auf »Neuer Endpunkt«.
• Vergeben Sie einen passenden Namen und wählen Sie als Tabelle »Adressen« aus.
• Vergeben Sie die Berechtigungen »Lesen« und »Schreiben«.

• Klicken Sie auf das »+«-Symbol, um die Zeile zu erweitern und die Berechtigungen für einzelne Felder der Tabelle zu setzen.

• Klicken Sie auf »Übernehmen«, wenn Sie die Konfiguration abgeschlossen haben. Starten Sie ggf. den cobra CXM WEB CONNECT Dienst neu, um die Änderungen wirksam werden zu lassen.

Die Adressen abrufen mit Postman

• Öffnen Sie das Programm »Postman«.
• Klicken Sie auf die Schaltfläche »New« und erstellen Sie eine neue Abfrage durch den Befehl »HTTP«.

• Benennen Sie die neue Abfrage mit »Adressabfrage Firmenname absteigend Top 3«. Bewegen Sie den Mauszeiger in die Kopfzeile, so erscheint eine Auswahl des relevanten Textteiles. Klicken Sie auf diesen, können Sie einen neuen Titel vergeben.
• Legen Sie die neue Abfrage als »Get«-Befehl fest.
• Tragen Sie die relevante Zieleadresse mit dem definierten Port ein. Die Form entspricht: »http://host:port/api/adressen« bzw. »https://host:port/api/adressen«.

• Wechseln Sie in das Register »Headers«.
• Tragen Sie hier den Namen und Wert der Schnittstelle ein.

• Klicken Sie auf das Register »Authorization«.
• Wählen Sie »Bearer Token« als Typ der Authentifizierung aus.
• Tragen Sie Ihren »JWT Bearer Token« ein. Wie Sie Ihren »JWT Bearer Token« abrufen können, siehe hier.

Sie haben erfolgreich die Abfrage für Adressen eingerichtet.

Im Weiteren wollen wir die Abfrage verfeinern und die Adressabfrage absteigend geordnet nach Firmennamen abfragen. Außerdem möchten wir nur die ersten drei Einträge der Datenbank einsehen.

• Wechseln Sie in das Register »Params«.
• Setzen Sie den Parameter »Orderby« in der Spalte »Key« ein und setzen Sie den Wert »Firma desc« in der Spalte »Value«.
• Tragen Sie den Parameter »top« in der Spalte »Key« ein und setzen Sie den Wert »3« in der Spalte »Value«.
• Aktivieren Sie die Parameter durch Klicken der Checkboxen in der Spalte »Query«.

• Klicken Sie auf »Send«.

Sie erhalten als Antwort Ihre »Adressen«, absteigend nach Firmennamen geordnet und die ersten drei Einträge der Datenbank.

• Klicken Sie auf »Save«, um Ihre angelegte Abfrage zu speichern.