接口统一说明
平台支持两种方式的鉴权,[客户端](doc:P6IVnzrg) 和 [服务端](doc:sVbHKOPu)。
## 请求响应及状态码
响应公共参数:
| 参数名 | 类型 | 必填 | 说明 |
| ------------ | ------------ | ------------ | ------------ | ------------ |
| code | int | 是 | 状态码 |
| message | String | 否 | 错误信息,code!=0时有值 |
| data | Object | 否 | 结果,code==0时有值且可为null |
请根据 code==0 来判断请求是否正常处理,然后再根据不同接口取相应的业务结果字段。
|状态码| 含义 |
| --- | -------- |
| 0 | 请求正常 |
| -1 | 参数不合法 |
| -2 | 认证失败 |
| -3 | 系统繁忙 |
| -4 | 获取超时 |
|1000|异常错误|
|1001|userNo已存在|
|2001|该酒店已生成激活码|
|4001|门店已存在|
|4002|门店不存在|
|5001|自动开具失败|
请求处理成功示例:
```json
{
"code":0,
"data":"开票成功"
}
```
请求处理失败示例:
```json
{
"code":-2,
"message":"认证失败"
}
```
## URL前缀
>w 沙箱测试环境:
http://proxy.yipiaoyun.cn/ 或 https://proxy.yipiaoyun.cn/
正式环境:
http://proxy.yipiaoyun.com/ 或 https://proxy.yipiaoyun.com/
## 回调
合作方需要提供回调通知的URL,开票助手在处理相关业务时,会发送回调通知。
为了安全起见,建议合作方进行安全认证,我们在回调时会采用jwt-token认证机制,在请求头Authorization中添加token,合作方校验通过后即可视为合法回调。当然,合作方也可以不对回调做安全认证。
jwt载荷约定如下(加密方式HMAC256):
|字段名|类型|说明|
|-----|-----|-----|
| appId |String|平台认证参数|
| appSecret |String|平台认证秘钥|
| issueAt| String | 发行时间(格式示例:yyyy-MM-dd HH:mm:ss),由合作方控制过期时间长短|
验证代码详见([AccessToken 认证工具](https://easydoc.xyz/#/s/46169128/TsmR7gA2/O6iMpCdu))