Imgrender - 动态图片渲染

开始使用

开始使用

基础

POST https://api.imgrender.cn/open/v1/pics

动态传入渲染配置的API,仅支持POST方式请求

认证

为防止 API 被滥用,需使用 API_KEY 进行认证。在请求时,请求头中需添加 Authorization 字段,并按以下示例添加 API_KEY

Authorization: Apikey xxxx.xxxx

xxxx.xxxx 替换为真实有效的 API_KEY,即可通过验证。


公开 API_KEY(不定期失效、更新,仅用于调试):

183666749185461475.PLbfIpBpeMkpgbj1Tr+177Mv3Jo3wIIySyf8V5ZeDhs=

👉 公开 API_KEY 仅推荐用于调试!正式使用时,请添加公众号「DebugMe」留言免费获取独立、私有 API_KEY。

请求内容

请求头中除了签名认证的内容以外,需要添加Content-Type:application/json,渲染配置使用 JSON 格式在 请求体 Body 中传递。

如何编写渲染配置,请参考蓝图。下面是参考示例:

{
"width": 640,
"height": 1034,
"backgroundColor": "#d04c44",
"blocks": [
{
"x": 25,
"y": 25,
"width": 590,
"height": 820,
"borderColor": "#ffe6c0",
"borderWidth": 2
}
],
"texts": [
{
"text": "帅帅气气",
"x": 320,
"y": 187,
"font": "jiangxizhuokai",
"fontSize": 18,
"lineHeight": 18,
"color": "#ffe6c0",
"width": 320,
"lineNum": 1,
"baseLine": "middle",
"textAlign": "center"
}
],
"images": [],
"lines": []
}

响应

响应内容会按照以下JSON格式返回

{
"code": 0,
"message": "ok",
"data": "https://davinci.imgrender.cn/6e31cfcd683a36d0522a8cc34e244379.jpg?sign=xxx"
}
  • code:错误码,当错误码为 0 时,表示处理成功,其他值表示处理失败
  • message:提示信息,与code相对应,更多提示信息可查看错误码列表
  • data :返回的数据。当 code0 时,返回有效时长为5分钟的图片链接。

HTTP 状态码

2XX:只要请求成功通过网关到达渲染服务,渲染服务就只会返回 200,请通过错误码来处理。

错误码

codemessage解释
0OK成功
10001Internal Server Error.系统内部错误
10002Apikey is invalid.Apikey 校验失败,请检查请求头中的Authorization字段
20101Image download failed.图片下载失败,请检查提供的图片链接可访问
20102Convert image failed.图片解析失败,图片格式不正确,推荐使用 png / jpg格式的图片
20103Font loading failed.字体加载失败,请检查字体名配置是否为系统支持的字体
20104Font parsing failed.字体解析失败,字体格式错误,一般不会出现
Edit this page on GitHub