ops/promotion
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
promotion/README.MD

477 lines
12 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

### 推广系统接口文档
TODO：
广告添加 own字段
返回所有广告[status]
返回单条广告
图片上传接口
#### 1、获得公司列表
##### 接口地址
http://192.168.100.20:8888/company
##### 返回格式：json
##### 请求方式：get
##### 请求示范
http://192.168.100.20:8888/company?status=0
##### 请求参数说明
| 名称 | 类型 | 必填 | 说明 |
| ------ | ---- | ---- | ---------------------------------- |
| status | int | 否 | 0=未审批，1=审批通过，2=审批未通过 |
| id | int | 否 | 返回该id对应公司信息 |
| | | | 上述参数为空返回所有信息 |
##### 返回参数说明
| 名称 | 类型 | 必填 | 说明 |
| ---------- | ------ | ---- | ---------------- |
| id | int | 否 | 自动产生的公司ID |
| name | string | 是 | 公司名称 |
| contact | string | 是 | 联系人 |
| tel | int | 是 | 联系电话 |
| companyid | string | 是 | 公司标识 |
| companykey | string | 是 | 用于API认证 |
##### 返回示例
{
"code": 200,
"message": [
{
"appid": "zpoHY37u",
"appkey": "undefined",
"contact": "miles",
"id": "1006",
"name": "kingsome",
"status": 0,
"tel": "17771"
},
{
"appid": "5bOaA82t",
"appkey": "undefined",
"contact": "miles",
"id": "1007",
"name": "kingsome",
"status": 0,
"tel": "17771"
}
]
}
#### 2、新增公司信息
##### 接口地址
http://192.168.100.20:8888/company
##### 返回格式：json
##### 请求方式：post
##### 请求示范
http://192.168.100.20:8888/company?name=kings&contact=pt&tel=1234
##### 请求参数说明
| 名称 | 类型 | 必填 | 说明 |
| ------- | ------ | ---- | -------- |
| name | string | 是 | 公司名称 |
| contact | string | 是 | 联系人 |
| tel | string | 是 | 联系电话 |
##### 返回参数说明
| 名称 | 类型 | 必填 | 说明 |
| ---- | ---- | ---- | -------- |
| code | int | 是 | 返回状态 |
| | | | |
##### 返回示例
{
"code": 200
}
#### 3、更改公司信息
##### 接口地址
http://192.168.100.20:8888/company
##### 返回格式：json
##### 请求方式：put
##### 请求示范
http://192.168.100.20:8888/company?appid=zpoHY37u&appkey=undefined&contact=miles&id=1006&name=kingsome&status=1&tel=17771
##### 请求参数说明
| 名称 | 类型 | 必填 | 说明 |
| ------- | ------ | ---- | -------------- |
| name | string | 是 | 公司名称 |
| contact | string | 是 | 联系人 |
| tel | string | 是 | 联系电话 |
| id | int | 是 | 公司id(唯一值) |
| appid | string | 是 | 公司标识 |
| appkey | string | 是 | 认证用，暂无 |
| status | int | 是 | 审批状态 |
##### 返回参数说明
| 名称 | 类型 | 必填 | 说明 |
| ---- | ---- | ---- | -------- |
| code | int | 是 | 返回状态 |
| | | | |
##### 返回示例
{
"code": 200
}
#### 4、删除公司信息
##### 接口地址
http://192.168.100.20:8888/company
##### 返回格式：json
##### 请求方式：delete
##### 请求示范
http://192.168.100.20:8888/company?id=1006
##### 请求参数说明
| 名称 | 类型 | 必填 | 说明 |
| ---- | ---- | ---- | -------------- |
| id | int | 是 | 公司id(唯一值) |
##### 返回参数说明
| 名称 | 类型 | 必填 | 说明 |
| ---- | ---- | ---- | -------- |
| code | int | 是 | 返回状态 |
| | | | |
##### 返回示例
{
"code": 200
}
#### 5、返回位置服务信息
##### 接口地址
http://192.168.100.20:8888/location
##### 返回格式：json
##### 请求方式：get
##### 请求示范
http://192.168.100.20:8888/location
##### 请求参数说明
| 名称 | 类型 | 必填 | 说明 |
| ------ | ---- | ---- | ------ |
| gameid | int | 是 | 游戏ID |
##### 返回参数说明
| 名称 | 类型 | 必填 | 说明 |
| ------- | ---- | ---- | ------------ |
| code | int | 是 | 返回状态 |
| message | json | 是 | 所有位置信息 |
##### 返回示例
{
"code": 200,
"message": [
{
"area": 1,
"gameid": 1003,
"id": 1001,
"type": 1
}
]
}
#### 6、添加位置服务信息
##### 接口地址
http://192.168.100.20:8888/location
##### 返回格式：json
##### 请求方式：post
##### 请求示范
http://192.168.100.20:8888/location?area=1&type=1&gameid=1003
##### 请求参数说明
| 名称 | 类型 | 必填 | 说明 |
| ---- | ---- | ---- | ---------------------------------------- |
| area | int | 是 | 区域(1=首页，2=游戏中，3=结算页，4=关闭) |
| type | int | 是 | 类型（1=icon，2=banner，3=浮窗） |
| | int | 是 | 游戏ID |
##### 返回参数说明
| 名称 | 类型 | 必填 | 说明 |
| ---- | ---- | ---- | -------- |
| code | int | 是 | 返回状态 |
##### 返回示例
{
"code": 200
}
#### 7、删除位置服务信息
##### 接口地址
http://192.168.100.20:8888/location
##### 返回格式：json
##### 请求方式：delete
##### 请求示范
http://192.168.100.20:8888/location?id=1002
##### 请求参数说明
| 名称 | 类型 | 必填 | 说明 |
| ---- | ---- | ---- | -------------- |
| id | int | 是 | 需删除的位置ID |
##### 返回参数说明
| 名称 | 类型 | 必填 | 说明 |
| ---- | ---- | ---- | -------- |
| code | int | 是 | 返回状态 |
##### 返回示例
{
"code": 200
}
#### 8、添加广告信息
##### 接口地址
http://192.168.100.20:8888/ad
##### 返回格式：json
##### 请求方式：post
##### 请求示范
http://192.168.100.20:8888/ad?name=abc&gameid=1003&locationid=1&ad_title=hello&ad_body=hi world&ad_image=http://1&ad_url=http://2&companyid=2
##### 请求参数说明
| 名称 | 类型 | 必填 | 说明 |
| ---------- | -------- | ---- | --------------------------------------------------- |
| name | string | 是 | 广告名称 |
| gameid | int | 是 | 广告投放的游戏ID |
| locationid | int | 是 | 位置ID |
| ad_title | string | 是 | 广告标题 |
| ad_body | string | 是 | 广告正文 |
| ad_image | string | 是 | 头像链接 |
| ad_url | string | 是 | 跳转链接 |
| begin_time | datetime | 否 | 开始时间，默认是1999-01-01 |
| end_time | datetime | 否 | 结束时间，默认是3000-01-01 |
| ad_num | int | 否 | 投放次数，默认是-1(无限) |
| ad_sort | int | 否 | 优先级默认为0 |
| status | int | 否 | 默认为0（未审批），1=审批通过，2=审批未通过，3=暂停 |
| companyid | int | 是 | 广告提交公司 |
##### 返回参数说明
| 名称 | 类型 | 必填 | 说明 |
| ---- | ---- | ---- | -------- |
| code | int | 是 | 返回状态 |
##### 返回示例
{
"code": 200
}
#### 9、变更广告信息（审批）
##### 接口地址
http://192.168.100.20:8888/ad
##### 返回格式：json
##### 请求方式：put
##### 请求示范
http://192.168.100.20:8888/ad?name=abc&gameid=1003&locationid=1&ad_title=hello&ad_body=hi world&ad_image=http://1&ad_url=http://2&begin_time=2019-06-01&end_time=2019-12-01&ad_num=300&ad_sort=1&status=1&id=1001&companyid=2
##### 请求参数说明
#####
| 名称 | 类型 | 必填 | 说明 |
| ---------- | -------- | ---- | --------------------------------------------------- |
| id | int | 是 | 广告ID |
| name | string | 是 | 广告名称 |
| gameid | int | 是 | 广告投放的游戏ID |
| locationid | int | 是 | 位置ID |
| ad_title | string | 是 | 广告标题 |
| ad_body | string | 是 | 广告正文 |
| ad_image | string | 是 | 头像链接 |
| ad_url | string | 是 | 跳转链接 |
| begin_time | datetime | 是 | 开始时间，默认是1999-01-01 |
| end_time | datetime | 是 | 结束时间，默认是3000-01-01 |
| ad_num | int | 是 | 投放次数，默认是-1(无限) |
| ad_sort | int | 是 | 优先级默认为0 |
| status | int | 是 | 默认为0（未审批），1=审批通过，2=审批未通过，3=暂停 |
| companyid | int | 是 | 广告提交公司 |
##### 返回参数说明
| 名称 | 类型 | 必填 | 说明 |
| ---- | ---- | ---- | -------- |
| code | int | 是 | 返回状态 |
##### 返回示例
{
"code": 200
}
#### 10、删除广告信息
##### 接口地址
http://192.168.100.20:8888/ad
##### 返回格式：json
##### 请求方式：delete
##### 请求示范
http://192.168.100.20:8888/ad
##### 请求参数说明
| 名称 | 类型 | 必填 | 说明 |
| ---- | ---- | ---- | -------------- |
| id | int | 是 | 需删除的位置ID |
##### 返回参数说明
| 名称 | 类型 | 必填 | 说明 |
| ---- | ---- | ---- | -------- |
| code | int | 是 | 返回状态 |
##### 返回示例
{
"code": 200
}
#### 11、返回广告列表信息
##### 接口地址
http://192.168.100.20:8888/ad
##### 返回格式：json
##### 请求方式：get
##### 请求示范
http://192.168.100.20:8888/ad?id=1002
http://192.168.100.20:8888/ad?status=0
##### 请求参数说明
| 名称 | 类型 | 必填 | 说明 |
| --------- | ---- | ---- | ---------------------------------- |
| id | int | 否 | 广告ID，其优先级高于其他参数 |
| companyid | int | 否 | 公司ID，优先级高于status |
| status | int | 否 | 审批状态，都不填写返回所有广告信息 |
##### 返回参数说明
| 名称 | 类型 | 必填 | 说明 |
| ---- | ---- | ---- | -------- |
| code | int | 是 | 返回状态 |
##### 返回示例
{
"code": 200,
"message": {
"ad_body": "hi world",
"ad_image": "http://1",
"ad_num": 300,
"ad_sort": 1,
"ad_title": "hello",
"ad_url": "http://2",
"begin_time": "Sat, 01 Jun 2019 00:00:00 GMT",
"end_time": "Sun, 01 Dec 2019 00:00:00 GMT",
"id": 1002,
"name": "abc",
"status": 0
}
}
{
"code": 200,
"message": {
"ad_body": "hi world",
"ad_image": "http://1",
"ad_num": 300,
"ad_sort": 1,
"ad_title": "hello",
"ad_url": "http://2",
"begin_time": "Sat, 01 Jun 2019 00:00:00 GMT",
"end_time": "Sun, 01 Dec 2019 00:00:00 GMT",
"id": 1002,
"name": "abc",
"status": 0
}
}
Reference in New Issue View Git Blame Copy Permalink