开发者 API

通过相同的经过验证的合约实现链接操作的自动化。

Gods.ly API 遵循已发布的 OpenAPI 规范。自动化工具与仪表盘一样,都会经过工作区检查、输入验证、重试保护和状态规则的处理。

开放式集成
01

打字合同

文档中记录的端点和示例清晰地说明了受支持的请求和响应。

02

范围限定访问

API 密钥元数据会明确记录权限,且绝不会返回存储的明文密钥。

03

可预见的错误

标准错误响应会说明无效字段的原因,并包含一个用于联系支持的请求 ID。

重试,且不生成重复项

创建请求时可以包含一个唯一的重试键。如果连接超时,可以再次发送相同的请求,而无需重复发布同一资产。

版本检查可防止某次更新在用户不知情的情况下覆盖来自其他用户或进程的更新内容。

将每个工作区分开

凭据与身份和工作区相关联。服务器会对每个请求的成员身份、权限、所有权和当前状态进行验证。

仅凭另一个工作区的标识符,永远无法查看或修改该资源。

在不造成隐性破坏的情况下实现演进

生成的客户端和模式兼容性检查可在构建过程中显示合约的变更。新增字段仍保持安全,而破坏性变更则需要提供带版本号的迁移路径。

在开发者工作区中创建和管理具有作用域的 API 密钥。撤销未使用的密钥,并将有效的密钥保存在可信环境中。

常见问题

各支队伍在开始前会问些什么。

有没有生成的客户端?

是的。API 文档中包含了受支持的客户端示例以及当前的 OpenAPI 契约。

在哪里可以管理 API 凭据?

使用开发者工作区创建作用域密钥、查看其权限,并在集成停用时撤销访问权限。

从实际的工作流程开始

开放式集成

继续