IMS

协议

zeuz 基础 API 使用 JSON-HTTP 数据格式协议。

资讯：我是否需要 JSON-HTTP 数据格式协议？

如果您可以使用 SDK 下载中提供的封装之一或 Go SDK，就不需要使用 JSON-HTTP 数据格式协议访问 API。请参阅 API 简介，检查您是否可以使用这些选项，如果您可以使用这些选项之一，就无需直接访问 zeuz 基础 API。

在下列情况下，必须直接访问 zeuz 基础 API：

  • 您不使用 Unity、虚幻引擎或 Go 开发游戏。
  • 您想调用 zeuz API 为您的游戏建立工具，例如，将您的游戏集成到 CI/CD 管道中。

API 认证

如果您想直接访问 zeuz 基础 API，您必须将认证纳入您的脚本中。更多信息，请参阅下列文档：

API 请求格式

每个 API 请求必须包含下列字段：

字段类型描述
Session字符串识别会话的唯一值。
更多信息，请参阅 API 登录 中的 步骤 4 - 调用 auth_login 端点。
Time时间戳zeuz 格式的时间戳。
详情请参阅 时间处理。
ReqID字符串随机的、由客户端创建的请求 ID。ReqID、Time 和 Session 结合起来可创建 SignHash。
详情请参阅 签名哈希生成。
SignHash字符串您用来认证 API 请求的哈希密码，直至会话密钥过期 (会话密钥在创建后的 24 小时过期)。
Data对象包含 API 请求详情的数据对象。

请参阅 签名哈希生成，了解向 auth_check 端点发送包含上述字段的 JSON 数据包的代码示例。

API 响应格式

API 响应包含下列字段：

字段类型描述
Time时间戳zeuz 格式的时间戳。
详情请参阅 时间处理。
Error字符串报错文本。
Data对象包含响应的数据对象。

错误处理

zeuz API 在 JSON 响应的 Error 字段中返回自定义错误码，您可根据返回的错误码在函数中直接处理响应数据。

zeuz API 端点返回 HTTP 响应状态码。详情请参阅 HTTP 状态码定义。


2021年5月27日 该文档已更新并通过审校

最近更新时间： October 20, 2021 (260712b5)