开始使用
生成 API key

生成 API key#

只有成功注册后,才能生成和使用 API key。对于尚未注册的情况,请参考创建项目指南中的相应步骤进行操作。

预备知识#

API key:为应用程序或用户提供一个唯一标识,使其能够与 API 进行交互。

Secret Key: 与 API key 配合使用,通过增加一道安全令牌来提供额外的安全保证。

Passphrase: 用于在 OKX 服务端加密 Secret Key,提供额外的安全防范。另外查看 Secret Key、修改 API 信息也会用到 Passphrase。

生成新的 API key#

请按照以下步骤操作来生成 API key。

  1. 在需要创建 API key 的项目处点击管理按钮。

图片

  1. 点击创建 API key 按钮。

图片

  1. 输入 API key 的名称和 Passphrase,点击创建生成相应的 API key。

图片

提示
Passphrase 是使用 API 的必要条件。一旦 Passphrase 丢失,将无法再使用 API key。请牢记密码短语。

恭喜!你已成功创建了 API key。

图片

查看 Secret Key#

在向 API 发起请求时,需要提供 API key 和 Secret Key。

  1. 点击右侧的复制按钮,可查看你的 Secret Key。

图片

  1. 输入密码,点击确定

图片

  1. 点击复制按钮,可复制密钥。

图片

删除 API key#

  1. 若希望删除某个 API key,请点击删除 API key 执行删除操作。

图片

  1. 点击删除按钮,确定删除。

图片