# poster-open-doc

**Repository Path**: buzzxu/poster-open-doc

## Basic Information

- **Project Name**: poster-open-doc
- **Description**: 海报系统对外接口文档
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2023-09-05
- **Last Updated**: 2025-09-15

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README


## 海报开放接口

## 接口请求域名

| 环境  | 地址          |
|------|-------------|
| 测试 |      |

## 接口鉴权

所有接口的入参，需要传递以下参数

| 参数名 | 类型  |是否必填  |  描述          |
|------|------|------|-------------|
| appkey | string   |是     |与雪王建店约定的字符串|
| timestamp | int   |是     |当前请求时间的时间戳(以秒为单位)|
| sign | string   |是     |签名值|
| data | string   |是     |各接口需要的参数，JSON格式字符串|

例如，我们有一个接口 POST http://xx/open/test ，参照接口文档中描述需要参数列表,那么最后调用的时候应该是类似:

```
POST http://proxy.xingchenga.xyz/open/test
Content-Type: application/json

{
  "appkey": "xwjd",
  "timestamp": 1684484437,
  "sign": "1215318a88b0562f0dac2b4c26bd3d195b105ebe",
  "data": "{\"shopCode\":\"911703\",\"customerName\":\"陈X\",\"customerPhone\":\"1585****1234\",\"designBlueprint\":[\"\",\"\"],\"siteMap\":[\"\",\"\"],\"shopType\":\"堂食店\",\"blueprintArea\":\"27.26\",\"decorationArea\":\"27.26\",\"companyName\":\"xx公司\",\"companyLeader\":\"袁xx\",\"designer\":\"王*\",\"province\":\"安徽省\",\"city\":\"宿州市\",\"district\":\"埇桥区\",\"address\":\"华府春天南门 106房\"}"
}
```
其中:
1. data是接口要求的业务参数，json格式的字符串
2. sign 是由appkey + appsecret(双方约定的密钥) + data + timestamp进行拼接之后再进行sha1加密得到的字符串。 


## 返回参数定义
所有接口的返回参数，都依照以下参数定义

| 参数名 | 类型  |是否必传  |  描述          |
|------|------|------|-------------|
| code | int   |是     |状态，默认成功=200，参照 [系统类错误](#错误代码)和各个接口的业务错误代码|
| error | boolean   |是     |是否有异常，默认false，没有异常|
| message | string   |否     |返回信息，如果 error = true,必传|
| data | object   |是     |参照各个接口返回参数说明|

例如:
```
{
  "code": 200,
  "error": false,
  "data": {
    "workOrderNumber": "P1547284990918688"
  }
}

```
## 接口目录

### [1. 门店](https://gitee.com/buzzxu/poster-open-doc/tree/master/%E9%97%A8%E5%BA%97) 
#### [1.1. 主信息推送](https://gitee.com/buzzxu/poster-open-doc/blob/master/%E9%97%A8%E5%BA%97/%E9%97%A8%E5%BA%97%E4%B8%BB%E4%BF%A1%E6%81%AF%E6%8E%A8%E9%80%81.md) 
### [2. 授权](https://gitee.com/buzzxu/poster-open-doc/tree/master/%E6%8E%88%E6%9D%83) 
#### [2.1. 登录转发](https://gitee.com/buzzxu/poster-open-doc/blob/master/%E6%8E%88%E6%9D%83/%E7%99%BB%E5%BD%95%E8%BD%AC%E5%8F%91.md) 


## 错误代码

### 系统类错误

| 错误码  | 描述          |
|------|-------------|
| 500 | 发生未知错误  |
| 1000 | 参数错误        |
| 1001 | 参数不能为空      |
| 1002 | 参数格式错误      |
| 1003 | 参数service错误 |
| 1004 | 参数method错误  |
| 1005 | 密钥已过期       |
| 1006 | 无权限,被拒绝访问   |
| 1007 | 验签失败        |
| 1008 | 签名失败        |
| 1009 | 请求时间过期      |
| 1010 | 参数解析失败      |
| 1011 | 返回数据序列化失败   |
| 1012 | 重复请求        |