通用说明
更新时间:2025-01-23
API认证机制
AI开放能力采用access_token认证机制。access_token是用户的访问令牌,承载了用户的身份、权限等信息。 要获取access_token,您需要在控制台上先创建应用,并获取到应用的API Key和Secret Key(以下分别简称为AK和SK)。
获取到AK和SK后,您有两种方式获取access_token:
- 代码形式→适用于有计算机基础的用户,或已开始开始将接口能力集成到业务中的用户
- 在线调试工具(推荐)→可快速调试接口效果
获取到access_token后,您需要将其拼接到调用接口服务的请求URL里。服务端接收到正确的access_token,则通过鉴权认证,并为您返回接口的业务信息。
整体流程图如下图。进一步的细节请参考鉴权认证机制。
请求参数说明
- 请求体格式化:Content-Type为
application/json
,通过json
格式化请求体。 - Base64编码:请求的图片需经过
Base64编码
,图片的base64编码指将图片数据编码成一串字符串,使用该字符串代替图像地址。您可以首先得到图片的二进制,然后用Base64格式编码即可。需要注意的是,图片的base64编码是不包含图片头的,如data:image/jpg;base64,
- 图片格式:现支持PNG、JPG、JPEG、BMP,不支持GIF图片
请求参数包括如下3种:
参数类型 | 说明 |
---|---|
URL参数 | 主要包括鉴权信息access_token,放在URL的query里 |
Header | Content-Type:application/json |
Body | 用于放置每个接口的请求,请参考具体接口的API文档 |
响应参数说明
响应主要关注响应body。
如调用成功,body里会包含调用所需的响应数据;如调用失败,也会在body里返回错误码和错误描述信息。
通信协议
为保证安全性,建议通过HTTPS调用。