概述
<h3 id="user-content-access">一、接入流程</h3>
1、联系服务商获取以下信息：
`接口地址`、`公司代码`、`api账号`、`api密码`
2、参考[【SDK】- PHP](doc:80FMDoEu)，调试接口
<br/>
### 二、接口通用信息
1、每次调用接口必须指定 `模块` 和 `服务`，这是服务端确定一个接口的必要的信息，在具体的接口文档里的《模块/服务》部分会指定这两个字段
2、由于服务端通过 `模块` 和 `服务` 两个字段确定调用接口，所以接口请求地址是固定的，在具体的接口文档里，地址全部用 http://xxx.xxx.com/api/v1 表示；真实的接口请求地址，请用 [接入流程](#user-content-access) 拿到的 `接口地址` 替换
<br/>
### 三、数据格式协议
1、请求和响应均采用 json 作为数据交换格式
2、请求数据的最外层字段固定，具体的接口文档里的《请求参数》部分将只对 `data` 字段里的数据做说明。请求最外层固定格式如下:
```json
{
"company_code": "xx",
"user_account": "xx",
"user_pass": "xx",
"module": "common",
"service": "demo",
"data": {
"param_1": "a",
"param_2": "b"
}
}
```
请求最外层字段说明:
|字段名|类型|描述|
|-|-|-|
|company_code|string|公司代码|
|user_account|string|api账号|
|user_pass|string|api密码|
|module|string|模块，详见具体接口文档里的《模块/服务》部分|
|service|string|服务，详见具体接口文档里的《模块/服务》部分|
|data|object|请求参数，详见具体接口文档里的《请求参数》部分|
3、响应数据的最外层字段固定，具体的接口文档里的《响应参数》部分将只对 `data` 字段里的数据做说明。响应最外层固定格式如下:
```json
{
"code": 200,
"message": "接口测试调用成功,传入的参数见data",
"errors": [],
"module": "Common",
"service": "demo",
"response_time": "2021-05-05 23:25:06",
"data": []
}
```
响应最外层字段说明:
|字段名|类型|描述|
|-|-|-|
|code|int|响应代码，详见下文 [响应代码对照表](#user-content-code_map)|
|message|string|错误信息|
|errors|array|错误详细详情|
|module|string|模块|
|service|string|服务|
|response_time|datetime|响应的服务器时间|
|data|object \| array|响应数据，详见具体接口文档里的《响应参数》部分|
<br/>
<h3 id="user-content-code_map">四、响应代码对照表</h3>
|响应代码|原因|
|-|-|
|100|参数错误|
|101|授权信息错误|
|102|系统不支持该模块|
|103|系统不支持该服务|
|104|系统未安装验证模块|
|105|系统未安装验证器|
|200|正确响应|
|300|服务执行时发生错误，错误信息见返回的“错误信息”字段|
|400|数据不存在|
|500|服务器内部错误|