api设计

一、开始开发

1、基本信息

• appid

• appsecret

• accesstoken

2、采用HTTPS协议、Json数据格式、UTF8编码

• 域名：https://api.example.com

3、版本号

如 v1

二、数据库

1、接口权限控制

• 是否有调用的权限，对不同人进行控制。

2、api调用的日志

3、api调用的错误日志

三、接口

分类：一般按模块分类比较好

功能：创建，更新，删除。

四、回调模式

1、主动回调

2、被动回调

三、单点登录

authkey

电商用的ticket

四、日志

五、其他功能

1、回调模式

• 腾讯的通知内容 （成功回调到特定接口）

• 数据格式为json

六、附录：

1、全局错误返回码

2、加密方式 （api接入说明）