API 认证

是否需要设置 API 认证取决于您使用 API 的方式。如果您使用 Unity、虚幻引擎或 Go 开发您的游戏,您可以使用 zeuz SDK 中提供的封装或 Go SDK 来访问 zeuz 基础 API 的一些功能,且无需设置和使用 API 认证。详情请参阅 API 简介

如果您想访问一些封装和 Go SDK 不具备的功能,或者您不使用封装和 Go SDK 支持的开发工具或编程语言,您可以直接访问 zeuz 基础 API。这种情况下,您需要设置 API 认证。

概览 - 如何设置并使用 API 认证

zeuz 基础 API 使用 JSON-HTTP 数据格式协议和基于哈希的消息认证码 (HMAC) 进行认证。

认证流程

如需使用 zeuz 基础 API 登录 zeuz 并发送 API 请求,您需要对 API 请求进行认证。下列图片概述了 zeuz 基础 API 的认证流程:

图像:zeuz 基础 API 认证流程

图像:zeuz 基础 API 认证流程

请完成下列任务设置并使用 API 认证:

1. 确保可以访问与 zeuz 账号相关联的开发人员资料

  • 根据端点的授权级别,使用开发人员资料或 API 密钥来发送 API 请求。

    详情请参阅 授权

  • 使用开发人员资料来创建 API 密钥。

    如果您无法访问与 zeuz 账号相关联的开发人员资料,请创建一个开发人员资料。

    详情请参阅 开发人员

2. 按需生成 API 密钥

  • 如果您想从您的游戏或游戏以外的服务中调用 zeuz 基础 API (例如,管理负载),请生成一个 API 密钥。我们建议您为要执行的每项任务单独生成一个 API 密钥。

    详情请参阅 API 密钥

3. 登录 zeuz 并生成会话密钥

  • 编写脚本来登录 zeuz。

    如需指导,请参阅 API 登录 文档。

    注意:在脚本中,您必须生成几个哈希值来产出一个有效期为 24 小时的会话密钥。

    该会话密钥用于生成另一个名为“签名哈希”的哈希密码,进而用于认证您的 API 请求。

4. 生成用于附在 API 请求上的签名哈希

  • 编写脚本,用您在上述任务 3. 登录 zeuz 并生成会话密钥 中生成的会话密钥生成另一个名为“签名哈希”的哈希密码。

    注意:签名哈希是您 API 请求的认证凭证。

    详情请参阅 签名哈希生成

    关于涵盖任务 3. 登录 zeuz 并生成会话密钥 和任务 4. 生成签名哈希并附在 API 请求上 的完整工作示例,请参阅 示例代码

5. 将签名哈希附在 API 请求上

  • 关于涵盖该任务的完整工作示例,请参阅 示例代码

6. 根据设置需要重新生成签名哈希

  • 为确保 API 请求的成功,请根据需要重新生成签名哈希。

    关于会话密钥 24 小时过期的处理建议,请参阅 设计考量错误处理


2021年8月9日 该文档已更新并通过审校:添加认证流程图

2021年5月12日 该文档已创建并通过审校


最近更新时间: October 20, 2021 (a2bd85e4)