Extern

/v1/certificates/external

Verwende dieses Edge, um deine Zertifikate der Zertifizierungsstelle (Certificate Authority, CA) hochzuladen, abzurufen, zu löschen und zurückzusetzen.

Bevor du beginnst

Zum Hochladen und löschen aller Zertifikate musst du ein admin-Konto verwenden.

Abrufen

Führe GET-Aufrufe für diesen Endpunkt aus, um ein im WhatsApp Business API-Client gespeichertes CA-Zertifikat abzurufen.

Beispiel

Anfrage:

GET /v1/certificates/external/ca

Antwort:

Content-Type: text/plain
Content-Length: content-size

certificate

Wenn kein CA-Zertifikat vorhanden ist, wird ein 404-Antwortcode ohne Text zurückgegeben.

Hochladen

Führe POST-Aufrufe aus, um ein CA-Zertifikat hochzuladen. Stelle sicher, dass das hochgeladene Zertifikat die folgenden Abschnitte in einer Datei und in der hier gezeigten Reihenfolge enthält:

1. Privater Schlüssel
2. Zertifikat
3. Eines oder mehrere CA-Zwischenzertifikate: Der WhatsApp Business API-Client benötigt mindestens ein CA-Zwischenzertifikat, um den Upload durchführen zu können.

Beispiel

Verwende zum Hochladen des Zertifikats auf den WhatsApp Business API-Client die folgende API-Anfrage mit Content-Type vom Typ text/plain.

POST /v1/certificates/external
  Content-Type: text/plain
  Content-Length: content-size

certificate

In cURL lautet der Befehl wie folgt:

curl -X POST \
  https://your-webapp-hostname:your-webapp-port/v1/certificates/external \
  -H 'Authorization: Bearer your-auth-token' \
  -H 'Content-Type: text/plain' \
  --data-binary @your-path-to-certificate.pem 

Wenn bereits ein Zertifikat vorhanden ist, wird es überschrieben. Nachdem das Zertifikat hochgeladen wurde, musst du den Webserver neu starten, also alle Instanzen des Webapp-Containers.

Achte unbedingt darauf, nur gültige Zertifikate (gültig und korrekt formatiert) für die Aktualisierung zu verwenden. Andernfalls kann der Webserver nicht neu gestartet werden (da der API-Endpunkt nicht verfügbar ist). In diesem Fall muss die Situation manuell behoben werden.

Die Antwort auf den API-Aufruf sieht folgendermaßen aus:

null

Zurücksetzen

Wenn das Zertifikat beim Hochladen eines CA-Zertifikats in den WhatsApp Business API-Client aus irgendeinem Grund ungültig ist, wird der Webapp-Container beim Neustart nicht gestartet, da der API-Endpunkt nicht verfügbar ist. Um diesen Fehler zu beheben, musst du die Datenbanktabelle certs löschen.

So löschst du die certs-Datenbanktabelle:

1. Beende den Webapp-Container:
   

   docker stop your-webapp-container-id

2. Stelle in der Befehlszeile über Docker eine Verbindung zu MySQL her:

   docker exec -it your-mysql-container-id mysql -uroot -p

3. Gib dein MySQL-Passwort ein, wenn du dazu aufgefordert wirst (aus mysql.conf).
4. Überprüfe, ob die certs-Tabelle existiert:

   show tables in waweb;

5. Lösche die certs-Tabelle:

   drop table waweb.certs;

6. Verlasse MySQL:

   exit;

7. Starte den Webapp-Container neu:

   docker restart your-webapp-container-id

8. Melde dich mit den oben beschriebenen Schritten erneut bei MySQL an, um zu überprüfen, ob die certs-Tabelle jetzt vorhanden ist.

Löschen

Das Löschen von Zertifikaten wird nicht unterstützt. Falls wir einen Anwendungsfall übersehen haben, können wir diese Funktion in einer zukünftigen Version hinzufügen.