API 接口管理 架构 api接口设计

提供给第三方的业务接口应该如何设计呢？需要从哪些方面考虑？以及如何实现这些方面？

1、标准化

　　RESTful 

2、安全性

　　1）请求token（防止接口被第三方调用）

　　　　token作为调用系统的凭证。token可以设置一次有效（安全性最高，完全防止接口被第三方调用），不过推荐设置时效性，减少获取获取token接口的请求频率。 token建议放在请求头上，这样可以跟业务参数完全区分开。

　　　　获取token一般会涉及的几个参数：appId、appKey、timestamp、nonce(requestId)、sign

　　　　appId和appKey通过开发平台申请和下发，appId即应用Id，是请求方的全局唯一的标识，一个appId对应一个客户，appKey需要高度保密，用于接口加密时拼装appKey作为加密串，不作为网络传输。

　　　　timestamp是时间戳，目的是为了减轻DOS攻击。防止请求被拦截后一直尝试请求接口。服务器设置时间戳阀值（5s），如果请求时间戳和服务器时间超过阀值，则响应失败。

　　　　nonce(requestId)是随机值，目的是为了增加sign的多变性，也可以保护接口的幂等性，相邻的两次请求nonce不允许重复，如果重复则认为是重复提交，响应失败。（将每次请求的nonce参数存储到缓存中，每次请求去缓存中查询是否存在，如果存在则认为是非法请求）

　　　　sign是参数签名，将appId，nonce，timestamp，还有其余非空请求参数，按照字母升序排列，然后使用URL键值对的格式（key1=value1&key2=value2）拼接起来，最后再拼接上appKey，组成待签名串；然后进行md5加密生成签名（或其他不可逆加密方式（如RSA2），有的情况要求先对待签名串进行UrlEncode，然后再加密生成签名）

　　　　请求携带appId和sign，只有拥有合法的身份appId和正确的签名sign才放行。

　　

　　2）客户端IP白名单（防止接口被第三方调用）

　　　　为了提高应用访问的安全性。开发者可以通过IP白名单功能设置能够合法访问服务端API的IP列表（获取API访问凭证相关接口除外），