接入必读

基础 URL

Imgrender 的 API 是围绕 REST 组织的。我们的 API 具有可预测、面向资源的 URL。

imgrender 所有 API 都以以下 URL 作为基础：

https://api.imgrender.net/open/

数据格式

所有 HTTP 请求头部的 Content-Type 类型为 application/json。

所有请求和响应内容的格式均为 JSON。

所有的请求 URL 和请求包体内容都区分大小写。

认证方式

imgrender 使用 api key 对请求进行鉴权。请在所有请求的请求头中添加鉴权字段：

X-API-Key: 应用密钥

应用密钥的获取方式请参考 应用密钥管理

版本控制

imgrender 采用语义化版本号表示 API 的版本，例如 v1、v2。

版本号位于 URL Path 中，包含版本号的完整 URL 示例：

https://api.imgrender.net/open/v1/

imgrender 会尽力保证 API 的兼容性：

• API 变更是兼容的，则 API 版本号不变。

• API 变更无法兼容时，则会新增版本号，并在一定时间范围内保留旧版本 API。例如：v1 -> v2