本章节是针对开发接口相关内容的介绍，关于接口的调用没有什么特别的要求，和常规的http接口调用一样。下面的内容，将罗列出全局接口的一些参数、状态码、响应示例等内容说明，后面的具体章节就不在赘述了。

• 请求接口

请求接口只有通过购买源码、私有化部署或者是使用SaaS服务，才具有使用权限，等权限开通之后，可以通过管理端的开发者中心查询。获取到请求接口时，需要添加到对应接口的url前面，拼接成一个完整的请求地址。

• 请求头信息

请求头用于接口的签名、登录验证的操作。例如，在用户登录成功之后，需要将登录的token添加到请求头中，服务端根据请求头获取到登录信息。下面支出的所有请求头，在所有的接口请求时，必须携带上。

DeviceType: '设备类型',// 设备类型。如phone、pad、pc、unknow
DeviceBrand: '设备品牌',// 设备品牌。如：apple、huawei
OsName: '系统名称',// ios、android、windows、macos、linux、harmonyos
AppLanguage: '系统语言',// zh-CN、zh-Hans-CN 
AppVersion: '系统版本',// ios19 beta
AppName: '应用名称',// 程序应用名称，根据实际的项目名决定，要求必须是英文
AppApiVersion: '1.0.0',// 系统接口版本号
AppApiDeviceType: 'wechat_mp_mini',//应用端口
Authorization: 'Bearer ' + '登录token',// 登录token

如果是APP应用，要求DeviceType、DeviceBrand、AppLanguage、OsName、AppLanguage和AppVersion不能为空，如果是PC端能获取到则可以获取。

• 请求状态码

状态码一般分为两种，一种是http状态码，另外一种是业务状态码。http状态码主要是用在网络请求处理，而业务状态码码主要是针对接口返回的错误信息，不同的业务状态码表示不同的业务处理逻辑。网络请求状态码，请开发者自行通过开发者工具进行调试，业务状态码会通过填充到响应体中的code字段，根据code来处理即可。

WARNING

开发者一定要注意，在处理接口响应结果时，一定要把http状态码+业务状态码结合进行判断，否则可能会导致业务逻辑混乱。

常用的http状态码有：

状态码值	值说明
200	网络请求成功
401	当前请求需要用户鉴权，也就是需要登录后才能访问
422	表示当前请求中的参数不符合接口的规则，需要根据对应的接口文档进行传参
500	一般表示服务器内部错误，遇到这种情况可能需要重试或者联系平台人员进行处理

常用的业务状态码有：

状态码值	值说明
100	接口请求成功
101	接口业务处理失败，或者是不符合条件的网络请求

• 响应示例

所有的接口响应都会按照下面的格式进行返回，code字段为业务状态码，msg字段为业务状态码对应的提示信息，data字段为接口返回的数据。data可能是一个数组，也可能是一个对象，具体看接口文档。部分列表接口中存在page、size和total字段，分别表示当前页码、每一页的分页大小和总条数，items则是列表数组的key。后面关于列表的接口文档，就不在进行单独说明，开发者根据接口返回的格式，自行处理即可。

成功示例

{
	"data": {},
	"code": 100,
	"msg": "请求成功"
}

失败示例

{
	"data": {},
	"code": 101,
	"msg": "请求成功"
}