对外 API 接口，请把握这3 条原则，16 个小点

Posted 2022-11-29 HelloWorld搬运工

tags:

篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了对外 API 接口，请把握这3 条原则，16 个小点相关的知识，希望对你有一定的参考价值。

对外API接口设计

安全性
- 1、创建appid,appkey和appsecret
- 2、Token：令牌（过期失效）
- 3、Post请求
- 4、客户端IP白名单（可选）
- 5、单个接口针对IP限流（令牌桶限流，漏桶限流，计数器限流）
- 6、记录接口请求日志
- 7、采用Https
- 8、数据合法性校验
- 9、密码查询(加缓存，key使用客户号)
- 10、接口调用失败告警
- 11、高可用：服务器集群部署（2-3）
- 12、变更轨迹，保存上次密码？
- 13、查询密码和交易密码是否分两条？
幂等性
数据规范
- 版本控制
- 响应状态码规范
- 统一响应数据格式

安全性

1、创建appid,appkey和appsecret

appid：应用的唯一标识
appkey：公钥=账号
appsecret：私钥=密码

1、设计一个认证系统，专用于创建第三方接入应用的账号信息，用于生成appid,appkey和appsecret，然后发appkey和appsecret给第三方接入应用，用于做认证

ps：appkey和appsecret成对出现的机制，目的在于首次验证（类似登录场景），用来申请一个token，之后请求数据请求，就直接带token请求服务端认证即可。

2、第三方接入应用自行注册，需要校验企业信息合法性（暂不考虑）

2、Token：令牌（过期失效）

1、第三方接入应用获取第一步中的appkey和appsecret

2、请求认证系统获取nonce随机数，服务端在缓存中存放下nonce

3、客户端拿到这个随机数后将其与appsecret拼接生appsecretStr，然后调用生成签名方法，传入appsecretStr，appkey，nonce，url（备注：可转大写，转小写，追加特殊字符，然后加密）进行非可逆加密（MD5/SHA1等），生成签名A。接着构造请求把签名放到请求头signature，post请求体中放入参数：appkey，nonce，timestamp，url根据request.getRequestURI()获取，调用认证接口

4、认证系统获取请求后，查询根据appkey查询缓存中的nonce，判断是否存在，不存在则提示不合法请求；判断是否相等，不等则为恶意请求。

判断timestamp的时效性，防止恶意请求：数据包中的客户端时间戳字段，然后用服务器当前时间去减客户端时间，看结果是否在一个区间内。

先根据appkey查询数据库，判断是否存在，如不存在则提示不合法用户；反之，查出appsecret，按照客户端的签名加密方式，进行加密，生成签名B，比较A和B，如果一样则生成token，失效缓存中的nonce，返回token。