cobra CRM

REST-API verwenden

Authentifizierung

Sofern Sie den »JWT Bearer Token« als Authentifizierungsmethode nutzen, müssen Sie zunächst diesen Token abrufen.

Bitte beachten Sie

Den API-Key können Sie in den CXM WEB CONNECT Einstellungen erstellen. Diesen API-Key und den zu erstellenden Token müssen Sie im Header mitgeben; Benutzername und Passwort werden dann nicht mehr benötigt. Dies gilt für alle Requests im weiteren Verlauf. Siehe unsere Beispiele.

POST /api/token

Beispiel Header:

{
    "ApiKey": "myApiKey",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "Accept-Encoding": "gzip, deflate, br"
}

Beispiel Body:

{
    "userName": "webApiUser", 
    "password": "myPassword" 
}

Beispiel Response:

{
  "success": true,
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJUZXN0IiwibmJmIjoxNjExMDU3NDQxLCJleHAiOjE2MTEwNTc1NjEsImlhdCI6MTYxMTA1NzQ0MSwiaXNzIjoiY29icmEgV2ViIEFQSSIsImF1ZCI6IldlYkFwaVVzZXIifQ.gLWhrGYajUpRHGdL2Sp02USwlq8lnMM4U8C0zQjPZ2o"
}

JWT Bearer Token abrufen mit Postman

  • Öffnen Sie das Programm »Postman«.
  • Optional: Legen Sie eine neue Kollektion mit dem Namen »cobra CXM WEBCONNECT« an.
  • Klicken Sie auf die Schaltfläche »New« und erstellen Sie eine neue Abfrage durch den Befehl »HTTP«.
Postman add request
  • Benennen Sie die neue Abfrage mit »JWT Bearer Token abrufen«. 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 »Post«-Befehl fest.

  • Tragen Sie die relevante Zieleadresse mit dem definierten Port ein. Die Form entspricht: »http://host:port/api/token« bzw. »https://host:port/api/token«.

Postman post request Zieladresse
  • Wechseln Sie in das Register »Headers«.
  • Tragen Sie hier den Namen und Wert der Schnittstelle ein.
Postman Headers API Key
  • Klicken Sie auf das Register »Body«.
  • Wählen Sie hier als Eigenschaft »raw« und in zweiter Stufe »JSON«.
  • Tragen Sie den Nutzernamen und das zugehörige Passwort gemäß der Form ein:
{
  "userName": "cobra",
  "password": "cobra"
}
Postman Body raw JSON
  • Klicken Sie auf »Send«.

Sie erhalten als Antwort Ihren »JWT Bearer Token«.

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

Bitte beachten Sie

Für alle weiteren Abfragen benötigen Sie immer Ihren API-Key und den erstellten Token. Ihr Benutzername und Passwort ist nicht mehr erforderlich.

Zurück
Endpunkte anlegen