开发者 API
Joystick 开发者 API 允许您以编程方式访问和修改产品的配置资源和设置，包括产品中的任何环境、Webhooks、架构、配置等。这使强大的自动化、工作流和集成成为可能。
入门指南
- 申请访问权限。联系我们的团队为您的组织启用开发者 API 访问权限。
- 创建产品 API 密钥。
- 使用开发者 API！
功能示例
许多您通常需要通过 Joystick CMS 执行的功能现在可以通过 API 访问。
- 创建新配置。
- 更新配置。
- 在环境之间同步配置。
- 在环境之间创建配置推送请求。
- 查看多个环境中的配置。
管理 API 密钥
使用开发者 API 需要产品 API 密钥。产品 API 密钥只能访问 Joystick 中属于该产品的所有实体。用户必须拥有组织的"编辑者"或"所有者"权限才能管理产品 API 密钥。
导航到您的产品视图。点击右上角的"产品设置"。
点击管理产品 API 密钥
访问级别
| 访问级别 | 描述 |
|---|---|
| 只读 | 访问大多数 GET 端点。 |
| 基本访问 | 可以创建、更新、归档配置，同步配置，创建推送请求。无法修改、删除或归档其他实体。 |
| 完全访问 | 对所有实体拥有完全控制权，包括删除和归档的能力。 |
需要帮助？
如果您需要帮助或需要额外的访问权限，请联系我们的团队。
使用 API
产品 API 密钥可以与许多管理端点一起使用。它可用于管理您的产品、环境、配置内容、同步配置等。
请求
端点
完整端点列表请见：https://capi.getjoystick.com/developer-api。请求头
| 请求头 | 值 | 必需 | 备注 |
|---|---|---|---|
x-product-api-key |
您的产品 API 密钥 | 是 | 为您要操作的产品创建的 API 密钥。这与用于配置检索的 API 密钥不同。 |
故障排除
遇到问题？请通过 Discord 联系我们的团队，提出任何问题或请求。
注意事项
API 使用和安全性
- 产品 API 密钥请求计为 API 使用量的 3 倍。
- 产品 API 密钥具有风险，包括完全删除您的数据的可能性。请谨慎保护和使用您的产品 API 密钥。
- 除非您确定需要，否则不要创建密钥，尤其是完全访问密钥。
- 此功能可能会发生变更。