WhatsApp Business Platform On-Premises API

Anmeldung

/v1/users/login

Um dich beim WhatsApp Business API-Client authentifizieren zu können, musst du angemeldet sein. Um dich anzumelden, sendest du deinen Benutzernamen und dein Passwort per Standard-Authentifizierung und erhältst einen Bearer-Schlüssel als Antwort. Anschließend verwendest du diesen Bearer-Schlüssel für die Authentifizierung in Anfragen an den WhatsApp Business API-Endpunkt. Erfahre mehr über Authentifizierung, um die API zu verwenden.

Bevor du beginnst

Der WhatsApp Business API-Client verwendet ein Standardkonto mit dem Benutzernamen admin und dem Passwort secret. Dieses Konto kann nicht entfernt oder aus dem System gelöscht werden. Aus Sicherheitsgründen musst du das Administratorpasswort bei der ersten Anmeldung sofort ändern.

Passwortempfehlungen

Wir empfehlen, bei der Erstellung neuer Konten und beim Festlegen der Passwörter für neue Konten möglichst sichere Passwörter nach branchenüblichen Standards festzulegen.

Passwörter müssen zwischen 8 und 64 Zeichen lang sein und mindestens Folgendes enthalten:

  • Eine Ziffer
  • Einen Großbuchstaben
  • Einen Kleinbuchstaben
  • Eines der folgenden Sonderzeichen: !"#$%&\'()*+,-./:;<=>?@[]^_`{|}~

Die Passwortkomplexität wird bei der Erstellung neuer Konten und bei Passwortänderungen für vorhandene Konten erzwungen.

Erstellen

Bei der Anmeldung authentifizierst du dich mit der Standard-Authentifizierung (Benutzername und Passwort). Die Authorization wird im HTTP-Header festgelegt. Als type wird Basic angegeben, und credentials enthält einen base64-codierten String mit dem username und dem password, verknüpft mit einem Doppelpunkt (z. B. username:password).

Nachdem der WhatsApp Business API-Client deine Anmeldeanfrage erhalten hat, werden die Anmeldedaten validiert.

  • Im Erfolgsfall wird dein Schlüssel erstellt. Du findest den Schlüssel im token-Feld in der Antwort.
  • Im Fehlerfall wird ein Fehler zurückgegeben.

Beispiele

Erste Anmeldung

Aus Sicherheitsgründen musst du das Standardpasswort des Administrators mit dem new_password-Feld ändern, wenn du dich zum ersten Mal anmeldest. Wenn du versuchst, dich mit dem Standardpasswort und ohne Daten im new_password-Feld anzumelden, gibt das System einen Fehler zurück.

Unsere Empfehlungen findest du unter Passwörter. Deine erste Anmeldung sollte wie folgt aussehen:

  POST /v1/users/login
  Authorization: Basic base64(username:password)
  {
  "new_password": "new-password"
  }

Die cURL-Version sieht wie folgt aus:

curl -k -X POST https://your-webapp-hostname:your-webapp-port/v1/users/login \
  -w "\n%{http-code}\n" \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Basic base64(username:password)' \
  -d '{"new_password" : "new-password"}'

Standardanmeldung

Die Standardanmeldung für den Client der WhatsApp Business API sieht wie folgt aus:

POST /v1/users/login
Authorization: Basic base64(username:password)

Die cURL-Version sieht wie folgt aus:

curl -X POST \
  -H 'Authorization: Basic base64(username:password)' \
  -H 'Content-Type: application/json' \
  -d '{}' \
  https://your-webapp-hostname:your-webapp-port/v1/users/login

Wenn die Anfrage erfolgreich war, wird der Status 200 OK zusammen mit dem Schlüssel und dem Ablaufdatum des Schlüssels zurückgegeben. Alle erstellten Schlüssel laufen nach sieben Tagen ab. Die Antwort sieht in etwa wie folgt aus:

{
   "users": [{
      "token": "eyJhbGciOHlXVCJ9.eyJ1c2VyIjoNTIzMDE2Nn0.mEoF0COaO00Z1cANo",
      "expires_after": "2018-03-01 15:29:26+00:00"
   }]
}

Wenn die Anfrage nicht erfolgreich ist, wird der HTTP-Status 401 Unauthorized zurückgegeben. Dieser Fehler bedeutet normalerweise, dass die Kombination aus Benutzername und Passwort aus der Anmeldeanfrage ungültig war und der WhatsApp Business API-Client daher keinen Schlüssel erstellen kann.

Falls in der Antwort Fehler enthalten sind, findest du hier weitere Informationen: Fehlercodes des WhatsApp Enterprise-Client und HTTP-Statuscodes.

Zurückgegebene Felder

Feld Beschreibung

token

Erforderlich.

Authentifizierungsschlüssel für alle weiteren Aufrufe an die WhatsApp Business API. Sende den Schlüssel im Autorisierungsheader im folgenden Format:
Authorization: Bearer <authentication-token>

expires_after

Erforderlich.

Zeitstempel mit dem Ablaufdatum des Schlüssels. Schlüssel sind standardmäßig sieben Tage lang gültig.

Mehr erfahren