我們即將停用內部部署 API。請參閱我們的內部部署 API 停用文件以取得詳細資訊,並瞭解如何轉移到我們的新一代雲端 API。

外部

/v1/certificates/external

使用此關係連線上傳、擷取、刪除和重設憑證授權單位(CA)憑證。

準備工作

您必須使用 admin 帳號上傳及刪除所有憑證。

擷取

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

範例

要求:

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 資料表現已存在。

刪除

不支援刪除憑證。如果日後有使用案例通過審查,我們將會支援此功能。