我们将弃用本地 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 表格。

删除

不支持删除证书。如果有忽略用例的情形,我们可能会在将来支持此操作。