API 模块

此模块允许您通过 API 与应用程序进行通信。 在您的应用中实现 API 模块及 API 方法后，您将能够通过 Crowdin API 访问应用的 API 方法，以管理（即修改或删除）所需的应用数据。

访问权限

您可以将此模块的访问权限授予以下用户类别之一：

对于 Crowdin：

• 仅限我自己（即项目所有者）
• 所有项目成员
• 选定用户

对于 Crowdin Enterprise：

• 仅限组织管理员
• 组织项目中的所有用户
• 选定用户

结构

manifest.json

{
  "modules": {
    "api": [
      {
        "key": "your-api-module-key",
        "name": "API method name",
        "url": "/path",
        "method": "GET",
        "description": "Description of the API method",
        "documentationUrl": "/path/to/documentation"
      }
    ]
  }
}

属性

key	类型： string 必填： 是 描述： Crowdin 应用内的模块标识符。
name	类型： string 必填： 是 描述： API 方法名称。
url	类型： string 必填： 是 描述： 指向 API 方法的相对 URL。
method	类型： string 允许的值： GET, POST, PUT, PATCH, DELETE 必填： 是 描述： API 方法类型。
description	类型： string 描述： API 方法的描述。
documentationUrl	类型： string 描述： 指向 API 方法文档的相对 URL。