跳转至

创建和管理API密钥

关于Joystick中的API密钥

  • 用REST API请求动态远程配置内容需要API密钥。
  • API密钥只能访问其创建所在环境的内容。
  • 在Joystick中,所有环境的API端点都是相同的。更改API密钥将确定从哪个环境检索内容。在下面的示例中,使用相同的端点获取"config-a",但是因为密钥不同,DEV将获取"v1"内容,而PROD将获取"v9"内容。请参阅配置内容管理以了解有关内容版本控制的更多信息。

API密钥示意图

Tip

我们建议您为每个代码环境创建一个Joystick环境(例如Dev、QA、Staging、Production),并提供单独的API密钥。

导航到API密钥管理

查看产品的所有环境时,选择要为其创建/管理API密钥的环境。

选择环境

进入环境后,点击"环境API密钥"选项卡。

选择环境API密钥选项卡

API密钥管理页面

您可以查看现有的API密钥、撤销它们或创建新的API密钥。

API密钥管理视图

创建API密钥

  • 点击"Create API Key For...."按钮,弹出对话框。输入API密钥的名称,然后点击"Create API Key"。
  • 创建API密钥后,您只会见到完整的API密钥一次。请将API密钥保存在安全的地方。我们不保存或访问此API密钥;它不能被恢复。如果您丢失了API密钥,将必须生成一个新的。

创建API密钥对话框

API密钥权限

类型 描述
只读 只读密钥可以请求并检索其创建所在环境的任何动态远程配置内容。
读写 读写API密钥具有在其可以访问的环境中创建新的配置修订版的权限。您可以使用此功能通过API以自动/编程方式更新内容。如果您想通过API更新内容,请联系我们的团队。

撤销API密钥

撤销API密钥后,它将立即被禁用。使用它进行的任何后续API调用都将返回401未授权。撤销API密钥是不可撤销的。请确保您撤销的密钥不再使用。

撤销API密钥对话框