# API调用
> `CNAPI`提供了一套通用的SDK接口规范,让你用更为简洁和现代化的方式调用接口服务。
每个API接口都会有一个接口调用地址(包括请求参数),因此可以通过传统curl的方式来调用接口,如果需要调试接口推荐使用`postman`。
>[danger] 注意,目前接口数量正在扩充中,你可以发送邮件到`guanchaohui@aliyun.com`反馈你需要的API接口
# 接口参数
`CNAPI`接口的参数包括系统级参数和应用级参数,所有的应用参数都统一使用下划线命名(字母小写)规范。无论是付费接口还是免费接口,都必须传入身份认证的系统传参(参考下面)。
如果不是特殊说明,`CNAPI`的接口默认都支持GET/POST请求。
# 身份认证(app_code)
`CNAPI`所有的API调用服务必须设置app_code值,用于接口调用的身份认证。
>[danger] app_code的值可以在用户中心“我的服务-->安全信息”的上方查询到,每个用户账号拥有一个唯一的AppCode值(请不要随意泄露)
目前支持使用两种方式进行身份认证:
1. 通过Header信息认证
在请求Header中添加的Authorization字段,配置值为“app_code + 半角空格 +app_code值”。
格式如下:
Authorization:app_code app_code值
2. 通过请求参数认证
你需要在请求Query中添加app_code参数,参数的值为用户app_code的值。
格式如下:
https://API接口地址?app_code=app_code值
>[info] 不一定是GET方式,POST参数一样可以支持
# 返回数据
所有的接口返回数据为JSON格式,通用规范如下:
|名称| 类型|说明|
|----|----|----|
|code|int|返回码,0表示成功其它表示失败|
|message|string|返回提示信息|
|data|object|返回数据|
>[info] 如果为付费接口,则当code为0的时候计费,其中data包含的数据请参考具体的接口说明。
# 接口预警
如果是付费接口,支持设置剩余调用次数预警。当到达设置的预警阈值的时候,会发送短信和邮件预警通知。注意及时续费,避免影响业务正常运行。
# 技术支持
如果在使用`CNAPI`的过程中有任何问题,或者需要反馈你需要的API接口可以发送邮件到`guanchaohui@aliyun.com`