Appearance
2. 接口调用及授权
2.1 调用
调用说明
规范和协议
基于RESTful API接口规范,使用HTTPS 通信协议;
请求成功
返回信息采用http状态码,如果返回200,直接按接口对象返回
请求失败
如果报错,返回格式:
text
{
errCode:错误码,
errMessage:错误原因
}
错误码 | 错误原因 |
---|---|
DIS_ALLOWED_BUSINESS | 业务不允许 |
ILLEGAL_PARAMETER | 非法参数 |
SERVER_ERROR | 空指针异常 |
UNEXPECTED | 系统异常未知异常 |
2.2 授权
目前考虑采用阿里云应用授权,以减少相关的开发和调试工作,阿里云网关体系比较成熟稳定,并且有详尽的文档说明,以减少后期的对接工作量
采用阿里应用网关授权,参考文档:https://help.aliyun.com/document_detail/185549.html
2.3 请求限制
访问限制【后期可能增加这方面的限制,提前注意请求次数和频率】
提供白名单
2.4 注意
提供接口联系人,方便以后接口升级,及时通知
如果超出限制,及时做一些通知