API

当前云词的 Open API 还处于测试阶段，如遇到任何问题欢迎提交反馈。

云词 API 允许开发者使用 HTTP 请求以编程方式与其云词帐户和服务进行交互。

通过 API，开发者可以导出文案、管理文案、管理团队、管理项目等。

如下是一个示例请求

curl --request GET \
     --url https://api.yundict.com/teams/{teamName}/projects/{projectName}/keys/export?type=json \
     --header "X-Api-Token: {token}" \

端点

所有 API 都通过 HTTPS 访问，访问域名为：

https://api.yundict.com

认证

云词 API 的所有请求都必须在 Header 种包含 X-Api-Token 参数。您可以从云词帐户设置中 “帐户设置 > API Tokens” 中找到。

请妥善保管您的 API Token，不要泄露给他人。

如果您的 API Token 已被泄露，可以通过单击 “重新生成 API Token” 按钮重置，也可以使用 “删除 API Token” 按钮删除即可。

速率限制

我们限制每秒最多发送 3 次请求，当超出速率限制时，会返回错误，状态为 “429 Too Many Requests”：

{
  "error": {
    "code": "too_many_requests",
    "message": "Rate limit exceeded"
  }
}

SDK

我们提供了一些 SDK，可以帮助您更快的接入云词 API，并且所有 SDK 都是开源的，您可以在 GitHub 上找到。

• JavaScript SDK