我們即將停用內部部署 API。詳情請參閱內部部署 API 停用文件,並從中了解如何轉用新一代雲端 API。

外部資源

/v1/certificates/external

使用此關係連線來上載、擷取、刪除和重設您的認證機構 (CA) 證書。

準備工作

您必須使用 admin 帳戶來上載及刪除所有證書。

擷取

如要擷取儲存在 WhatsApp Business API 用戶端的 CA 證書,請向此端點發出 GET 呼叫。

範例

要求:

GET /v1/certificates/external/ca

回應:

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

certificate

如果未有找到 CA 證書,系統便會傳回沒有正文的 404 回應代碼。

上載

發出 POST 呼叫以上載 CA 證書。請確保您在單一檔案中上載的證書包含以下部分,而且跟從以下次序:

  1. 私人密鑰
  2. 證書
  3. 一份或多份中級 CA 證書:WhatsApp Business API 用戶端需要最少一份中級 CA 證書,否則上載動作會失敗。

範例

如要將證書上載至 WhatsApp Business API 用戶端,請使用以下 API 要求,其中包含 text/plainContent-Type

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

certificate

如要使用 cURL,指令將如下所示:

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 

如果證書已存在,系統便會覆寫舊證書。上載證書後,您必須重新啟動網頁伺服器,即是所有網頁應用程式容器實例。

請務必多加小心,確保只上載有效(即適當和正確)的證書。否則,網頁伺服器會無法重新啟動(由於 API 端點會關閉),並需要您手動干預才可恢復狀態

API 呼叫的回應如下所示:

null

重設

將 CA 證書上載至 WhatsApp Business API 用戶端時,如果證書因某種原因失效,由於 API 端點將會關閉,網頁應用程式容器無法在重新啟動後運行。如要恢復狀態,您需要刪除 certs 資料庫表格。

如要刪除 certs 資料庫表格,請按照下列步驟操作:

  1. 停止使用網頁應用程式容器:
    docker stop your-webapp-container-id
  2. 透過指令行的 Docker 連接至 MySQL:
    docker exec -it your-mysql-container-id mysql -uroot -p
  3. 在系統提示時,輸入您的 MySQL 密碼(依照 mysql.conf)。
  4. 查看 certs 表格是否存在:
    show tables in waweb;
  5. 刪除 certs 表格:
    drop table waweb.certs;
  6. 退出 MySQL:
    exit;
  7. 重新開啟網頁應用程式容器:
    docker restart your-webapp-container-id
  8. 按照上述步驟再次登入 MySQL,確保現在已有 certs 表格。

刪除

系統不支援刪除證書。如果我們忽略了任何使用案例,可能會在日後支援相應的功能。