hongze_open_api/swagger/swagger.json

{
    "swagger": "2.0",
    "info": {
        "title": "弘则开放API接口",
        "description": "这是弘则开放API接口文档 \u003cbr/\u003e\u003cbr/\u003e\u003cb\u003e1、参数格式与调用方式：\u003c/b\u003e\u003cbr/\u003e（1）接口传输的所有参数使用 UTF8 编码格式，包括签名。接口调用方式请以接口定义的方式进行调用。\u003cbr/\u003e（2）接口地址（测试）：http://8.136.199.33:8608/api/\u003cbr/\u003e（3）如果是POST请求，那么header头请以Content-Type: application/json的方式请求\u003cbr/\u003e\u003cbr/\u003e\u003cb\u003e2、公共参数：\u003c/b\u003e\u003cbr/\u003e\u003ctable style=\"text-align:center\"\u003e\u003ctr\u003e\u003ctd style=\"border:1px solid\"\u003e参数名\u003c/td\u003e\u003ctd style=\"border:1px solid\"\u003e类型\u003c/td\u003e\u003ctd style=\"border:1px solid\"\u003e是否必传\u003c/td\u003e\u003ctd style=\"border:1px solid\"\u003e说明\u003c/td\u003e\u003ctr\u003e\u003ctd style=\"border:1px solid\"\u003eappid\u003c/td\u003e\u003ctd style=\"border:1px solid\"\u003estring\u003c/td\u003e\u003ctd style=\"border:1px solid\"\u003e是\u003c/td\u003e\u003ctd style=\"border:1px solid\"\u003e开放平台给分配的appid\u003c/td\u003e\u003c/tr\u003e\u003c/tr\u003e\u003ctr\u003e\u003ctd style=\"border:1px solid\"\u003enonce_str\u003c/td\u003e\u003ctd style=\"border:1px solid\"\u003estring\u003c/td\u003e\u003ctd style=\"border:1px solid\"\u003e是\u003c/td\u003e\u003ctd style=\"border:1px solid\"\u003e随机字符串，最大32位长度，26位大小写字母a,b…z和数字组成\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003ctd style=\"border:1px solid\"\u003etimestamp\u003c/td\u003e\u003ctd style=\"border:1px solid\"\u003eint\u003c/td\u003e\u003ctd style=\"border:1px solid\"\u003e是\u003c/td\u003e\u003ctd style=\"border:1px solid\"\u003e系统时间戳 UNIX_TIMESTAMP格式；1970年到目前的秒数\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003ctd style=\"border:1px solid\"\u003esign\u003c/td\u003e\u003ctd style=\"border:1px solid\"\u003estring\u003c/td\u003e\u003ctd style=\"border:1px solid\"\u003e是\u003c/td\u003e\u003ctd style=\"border:1px solid\"\u003e签名信息（签名规则查看第4节）\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003ctd style=\"border:1px solid\"\u003e_page\u003c/td\u003e\u003ctd style=\"border:1px solid\"\u003eint\u003c/td\u003e\u003ctd style=\"border:1px solid\"\u003e否\u003c/td\u003e\u003ctd style=\"border:1px solid\"\u003e请求页码\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003ctd style=\"border:1px solid\"\u003e_page_size\u003c/td\u003e\u003ctd style=\"border:1px solid\"\u003eint\u003c/td\u003e\u003ctd style=\"border:1px solid\"\u003e否\u003c/td\u003e\u003ctd style=\"border:1px solid\"\u003e每页请求返回数据数，最大不能超过100\u003c/td\u003e\u003c/tr\u003e\u003c/table\u003e \u003cbr/\u003e\u003cbr/\u003e\u003cb\u003e3、公共返回参数：\u003c/b\u003e\u003cbr/\u003e\u003ctable style=\"text-align:center\"\u003e\u003ctr\u003e\u003ctd style=\"border:1px solid\"\u003e参数名\u003c/td\u003e\u003ctd style=\"border:1px solid\"\u003e类型\u003c/td\u003e\u003ctd style=\"border:1px solid\"\u003e是否必传\u003c/td\u003e\u003ctd style=\"border:1px solid\"\u003e说明\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003ctd style=\"border:1px solid\"\u003ecode\u003c/td\u003e\u003ctd style=\"border:1px solid\"\u003eint\u003c/td\u003e\u003ctd style=\"border:1px solid\"\u003e是\u003c/td\u003e\u003ctd style=\"border:1px solid\"\u003e接口返回状态码\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003ctd style=\"border:1px solid\"\u003emsg\u003c/td\u003e\u003ctd style=\"border:1px solid\"\u003estring\u003c/td\u003e\u003ctd style=\"border:1px solid\"\u003e是\u003c/td\u003e\u003ctd style=\"border:1px solid\"\u003e提示信息（错误信息）\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003ctd style=\"border:1px solid\"\u003edata\u003c/td\u003e\u003ctd style=\"border:1px solid\"\u003emap\u003c/td\u003e\u003ctd style=\"border:1px solid\"\u003e是\u003c/td\u003e\u003ctd style=\"border:1px solid\"\u003e对应的业务数据\u003c/td\u003e\u003c/tr\u003e\u003c/table\u003e \u003cbr/\u003e\u003cbr/\u003e\u003cb\u003e4、签名规则：\u003c/b\u003e\u003cbr/\u003e（1）所有发送或者接收到的数据为集合M，将集合M内非空参数值的参数按照参数名ASCII码从小到大排序（字典序），使用URL键值对的格式（即key1=value1\u0026key2=value2…）拼接成字符串stringA。\u003cbr/\u003e（2）在stringA最后拼接上\u0026secret=secretValue得到stringSignTemp字符串，并对stringSignTemp进行MD5运算，再将得到的字符串所有字符转换为大写，得到sign值signValue。\u003cbr/\u003e\u003cbr/\u003e\u003cb\u003e5、code状态码取值：\u003c/b\u003e\u003cbr/\u003e\u003ctable style=\"text-align:center\"\u003e\u003ctr\u003e\u003ctd style=\"border:1px solid\"\u003e200\u003c/td\u003e\u003ctd style=\"border:1px solid\"\u003e正常响应码\u003c/td\u003e\u003c/tr\u003e \u003ctr\u003e\u003ctd style=\"border:1px solid\"\u003e400\u003c/td\u003e\u003ctd style=\"border:1px solid\"\u003e业务处理失败响应码\u003c/td\u003e\u003c/tr\u003e \u003ctr\u003e\u003ctd style=\"border:1px solid\"\u003e401\u003c/td\u003e\u003ctd style=\"border:1px solid\"\u003e参数签名异常，检查下签名是否正常\u003c/td\u003e\u003c/tr\u003e\u003c/table\u003e",
        "version": "1.0.0",
        "contact": {
            "email": "pyan@hzinsights.com"
        },
        "license": {
            "name": "Apache 2.0",
            "url": "http://www.apache.org/licenses/LICENSE-2.0.html"
        }
    },
    "basePath": "/api",
    "paths": {
        "/company_user/user_report_list": {
            "get": {
                "tags": [
                    "company_user"
                ],
                "description": "获取用户阅读数据报表",
                "operationId": "CompanyUser.获取用户阅读数据报表",
                "parameters": [
                    {
                        "in": "query",
                        "name": "start_date",
                        "description": "开始日期，格式：2021-11-03",
                        "type": "string"
                    },
                    {
                        "in": "query",
                        "name": "end_date",
                        "description": "结束日期，格式：2021-11-04",
                        "type": "string"
                    },
                    {
                        "in": "query",
                        "name": "mobile",
                        "description": "用户手机号",
                        "type": "string"
                    },
                    {
                        "in": "query",
                        "name": "email",
                        "description": "用户邮箱",
                        "type": "string"
                    }
                ],
                "responses": {
                    "200": {
                        "description": "",
                        "schema": {
                            "$ref": "#/definitions/company_user.UserReportListResp"
                        }
                    }
                }
            }
        },
        "/company_user/view_total_list": {
            "get": {
                "tags": [
                    "company_user"
                ],
                "description": "获取用户阅读数据报表",
                "operationId": "CompanyUser.获取用户阅读数据报表",
                "responses": {
                    "200": {
                        "description": "",
                        "schema": {
                            "type": "array",
                            "items": {
                                "$ref": "#/definitions/logic.UserView"
                            }
                        }
                    }
                }
            }
        },
        "/report/article/change": {
            "post": {
                "tags": [
                    "report"
                ],
                "description": "报告变更通知的插入点接口",
                "operationId": "ReportController.报告变更通知的插入点接口",
                "parameters": [
                    {
                        "in": "body",
                        "name": "request",
                        "description": "type json string",
                        "required": true,
                        "schema": {
                            "$ref": "#/definitions/article.CreatArticleCeluePushReq"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "创建成功"
                    }
                }
            }
        },
        "/report/getReportChapterInfo": {
            "get": {
                "tags": [
                    "report"
                ],
                "description": "获取章节详情",
                "operationId": "ReportControllerCommon.获取章节详情接口",
                "parameters": [
                    {
                        "in": "query",
                        "name": "ResearchReportTypeId",
                        "description": "章节ID",
                        "required": true,
                        "type": "integer",
                        "format": "int64"
                    },
                    {
                        "in": "query",
                        "name": "mobile",
                        "description": "用户手机号(加密后的)",
                        "type": "string"
                    }
                ],
                "responses": {
                    "200": {
                        "description": "",
                        "schema": {
                            "$ref": "#/definitions/report.ResearchReportTypeContentInfo"
                        }
                    }
                }
            }
        },
        "/report/getReportInfo": {
            "get": {
                "tags": [
                    "report"
                ],
                "description": "获取报告详情",
                "operationId": "ReportControllerCommon.获取报告详情",
                "parameters": [
                    {
                        "in": "query",
                        "name": "research_report_id",
                        "description": "报告ID",
                        "required": true,
                        "type": "integer",
                        "format": "int64"
                    },
                    {
                        "in": "query",
                        "name": "mobile",
                        "description": "用户手机号(加密后的)",
                        "required": true,
                        "type": "string"
                    }
                ],
                "responses": {
                    "200": {
                        "description": "",
                        "schema": {
                            "$ref": "#/definitions/report.ResearchReportInfo"
                        }
                    }
                }
            }
        },
        "/report/list": {
            "get": {
                "tags": [
                    "report"
                ],
                "description": "获取报告列表",
                "operationId": "ReportController.获取报告列表接口",
                "parameters": [
                    {
                        "in": "query",
                        "name": "_page_size",
                        "description": "每页数据条数",
                        "required": true,
                        "type": "integer",
                        "format": "int64"
                    },
                    {
                        "in": "query",
                        "name": "_page",
                        "description": "当前页页码，从1开始",
                        "required": true,
                        "type": "integer",
                        "format": "int64"
                    },
                    {
                        "in": "query",
                        "name": "report_type",
                        "description": "类型 day：晨报 、week ：周报、two_week：双周报 、month：月报、other ：点评 (默认为day:晨报)",
                        "required": true,
                        "type": "string"
                    },
                    {
                        "in": "query",
                        "name": "keyword",
                        "description": "搜索关键词",
                        "required": true,
                        "type": "string"
                    },
                    {
                        "in": "query",
                        "name": "mobile",
                        "description": "用户手机号(加密后的)",
                        "required": true,
                        "type": "string"
                    }
                ],
                "responses": {
                    "200": {
                        "description": "",
                        "schema": {
                            "$ref": "#/definitions/report.ReportListResp"
                        }
                    }
                }
            }
        },
        "/sys_user/create": {
            "post": {
                "tags": [
                    "sys_user"
                ],
                "description": "创建系统用户",
                "operationId": "Admin.创建系统用户",
                "parameters": [
                    {
                        "in": "body",
                        "name": "request",
                        "description": "type json string",
                        "required": true,
                        "schema": {
                            "$ref": "#/definitions/admin.CreateUserReq"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "创建成功"
                    }
                }
            }
        }
    },
    "definitions": {
        "admin.CreateUserReq": {
            "title": "CreateUserReq",
            "type": "object",
            "properties": {
                "mobile": {
                    "description": "手机号",
                    "type": "string"
                },
                "real_name": {
                    "description": "用户真实姓名",
                    "type": "string"
                },
                "role_type": {
                    "description": "角色类型，枚举值。1：ficc研究员；2：权益研究员；3：ficc销售；4：权益销售",
                    "type": "integer",
                    "format": "int64"
                }
            }
        },
        "article.CreatArticleCeluePushReq": {
            "title": "CreatArticleCeluePushReq",
            "type": "object",
            "properties": {
                "action": {
                    "description": "操作方式 add：新增、edit：修改、move：删除",
                    "type": "string"
                },
                "article_id": {
                    "description": "文章ID",
                    "type": "integer",
                    "format": "int64"
                }
            }
        },
        "company_report_permission.ResearchReportTypeContent": {
            "title": "ResearchReportTypeContent",
            "type": "object",
            "properties": {
                "content": {
                    "description": "内容",
                    "type": "string"
                },
                "content_type": {
                    "description": "内容分类类型",
                    "type": "string"
                },
                "created_time": {
                    "description": "创建时间",
                    "type": "string",
                    "format": "datetime"
                },
                "img_url": {
                    "description": "图片路径",
                    "type": "string"
                },
                "last_updated_time": {
                    "description": "最近一次更新时间",
                    "type": "string",
                    "format": "datetime"
                },
                "research_report_id": {
                    "description": "报告id",
                    "type": "integer",
                    "format": "int64"
                },
                "research_report_type_content_id": {
                    "description": "研究报告内容id",
                    "type": "integer",
                    "format": "int64"
                },
                "research_report_type_title": {
                    "description": "标题",
                    "type": "string"
                },
                "sort": {
                    "description": "排序",
                    "type": "integer",
                    "format": "int64"
                }
            }
        },
        "company_report_permission.ResearchReportTypeInfo": {
            "title": "ResearchReportTypeInfo",
            "type": "object",
            "properties": {
                "banner_url": {
                    "description": "banner url",
                    "type": "string"
                },
                "report_chapter_type_id": {
                    "description": "章节名称",
                    "type": "integer",
                    "format": "int64"
                },
                "report_chapter_type_name": {
                    "description": "章节名称",
                    "type": "string"
                },
                "research_report_id": {
                    "description": "报告id",
                    "type": "integer",
                    "format": "int64"
                },
                "research_report_type_id": {
                    "description": "研究报告id",
                    "type": "integer",
                    "format": "int64"
                },
                "research_report_type_title": {
                    "description": "研究报告标题",
                    "type": "string"
                },
                "type": {
                    "type": "string"
                },
                "type_id": {
                    "description": "分类id",
                    "type": "integer",
                    "format": "int64"
                }
            }
        },
        "company_report_permission.ResearchReportTypeList": {
            "title": "ResearchReportTypeList",
            "type": "object",
            "properties": {
                "BannerUrl": {
                    "description": "banner显示图片",
                    "type": "string"
                },
                "Edit": {
                    "description": "是否编辑过",
                    "type": "integer",
                    "format": "int32"
                },
                "EditImgUrl": {
                    "description": "管理后台编辑时选用的图",
                    "type": "string"
                },
                "LastUpdatedTime": {
                    "description": "最后更新时间",
                    "type": "string",
                    "format": "datetime"
                },
                "PauseEndTime": {
                    "description": "暂停结束日期",
                    "type": "string",
                    "format": "datetime"
                },
                "PauseStartTime": {
                    "description": "暂停开始日期",
                    "type": "string",
                    "format": "datetime"
                },
                "ReportChapterTypeKey": {
                    "description": "章节key",
                    "type": "string"
                },
                "ReportChapterTypeName": {
                    "description": "报告章节类型名称",
                    "type": "string"
                },
                "ReportChapterTypeThumb": {
                    "description": "H5展示的图片",
                    "type": "string"
                },
                "ResearchReportId": {
                    "description": "研究报告id",
                    "type": "integer",
                    "format": "int64"
                },
                "ResearchReportTypeId": {
                    "description": "章节ID",
                    "type": "integer",
                    "format": "int64"
                },
                "ResearchReportTypeTitle": {
                    "description": "研究报告标题",
                    "type": "string"
                },
                "Sort": {
                    "description": "排序字段",
                    "type": "integer",
                    "format": "int64"
                },
                "Trend": {
                    "description": "趋势观点",
                    "type": "string"
                },
                "TypeId": {
                    "description": "分类id",
                    "type": "integer",
                    "format": "int64"
                },
                "http_url": {
                    "type": "string"
                }
            }
        },
        "company_user.UserReportListResp": {
            "title": "UserReportListResp",
            "type": "object",
            "properties": {
                "list": {
                    "description": "数据列表",
                    "type": "array",
                    "items": {
                        "$ref": "#/definitions/tables.ViewReportList"
                    }
                },
                "paging": {
                    "$ref": "#/definitions/utils.PagingItem",
                    "description": "分页数据"
                }
            }
        },
        "logic.UserView": {
            "title": "UserView",
            "type": "object",
            "properties": {
                "count": {
                    "description": "阅读数",
                    "type": "integer",
                    "format": "int64"
                },
                "phone": {
                    "description": "手机号",
                    "type": "string"
                }
            }
        },
        "report.ReportList": {
            "title": "ReportList",
            "type": "object",
            "properties": {
                "http_url": {
                    "type": "string"
                },
                "periods": {
                    "type": "integer",
                    "format": "int64"
                },
                "research_report_date": {
                    "type": "string"
                },
                "research_report_id": {
                    "type": "integer",
                    "format": "int64"
                },
                "research_report_name": {
                    "description": "标题",
                    "type": "string"
                }
            }
        },
        "report.ReportListResp": {
            "title": "ReportListResp",
            "type": "object",
            "properties": {
                "list": {
                    "description": "列表",
                    "type": "array",
                    "items": {
                        "$ref": "#/definitions/report.ReportList"
                    }
                },
                "paging": {
                    "$ref": "#/definitions/utils.PagingItem",
                    "description": "分页数据"
                }
            }
        },
        "report.ResearchReport": {
            "title": "ResearchReport",
            "type": "object",
            "properties": {
                "author": {
                    "type": "string"
                },
                "createdTime": {
                    "type": "string",
                    "format": "datetime"
                },
                "enabled": {
                    "type": "integer",
                    "format": "int32"
                },
                "isHasMenu": {
                    "type": "integer",
                    "format": "int32"
                },
                "isSendedMsg": {
                    "type": "integer",
                    "format": "int32"
                },
                "lastUpdatedTime": {
                    "type": "string",
                    "format": "datetime"
                },
                "periods": {
                    "type": "integer",
                    "format": "int64"
                },
                "reportVariety": {
                    "type": "string"
                },
                "researchReportDate": {
                    "type": "string",
                    "format": "datetime"
                },
                "researchReportImg": {
                    "type": "string"
                },
                "researchReportName": {
                    "type": "string"
                },
                "researchReportTitle": {
                    "type": "string"
                },
                "research_report_id": {
                    "type": "integer",
                    "format": "int64"
                },
                "status": {
                    "type": "string"
                },
                "type": {
                    "type": "string"
                },
                "viewers": {
                    "type": "integer",
                    "format": "int64"
                }
            }
        },
        "report.ResearchReportInfo": {
            "title": "ResearchReportInfo",
            "type": "object",
            "properties": {
                "ResearchReportTypeContentList": {
                    "description": "报告详情",
                    "type": "array",
                    "items": {
                        "$ref": "#/definitions/company_report_permission.ResearchReportTypeContent"
                    }
                },
                "has_menu": {
                    "type": "integer",
                    "format": "int64"
                },
                "research_report_info": {
                    "$ref": "#/definitions/report.ResearchReport"
                },
                "research_report_type_list": {
                    "type": "array",
                    "items": {
                        "$ref": "#/definitions/company_report_permission.ResearchReportTypeList"
                    }
                }
            }
        },
        "report.ResearchReportTypeContentInfo": {
            "title": "ResearchReportTypeContentInfo",
            "type": "object",
            "properties": {
                "add": {
                    "type": "integer",
                    "format": "int64"
                },
                "research_report_type_content_list": {
                    "description": "报告详情",
                    "type": "array",
                    "items": {
                        "$ref": "#/definitions/company_report_permission.ResearchReportTypeContent"
                    }
                },
                "research_report_type_info": {
                    "$ref": "#/definitions/company_report_permission.ResearchReportTypeInfo"
                },
                "research_report_type_list": {
                    "type": "array",
                    "items": {
                        "$ref": "#/definitions/company_report_permission.ResearchReportTypeList"
                    }
                }
            }
        },
        "tables.ViewReportList": {
            "title": "ViewReportList",
            "type": "object",
            "properties": {
                "company_name": {
                    "description": "公司名称",
                    "type": "string"
                },
                "created_time": {
                    "description": "报告阅读时间",
                    "type": "string"
                },
                "email": {
                    "description": "邮箱",
                    "type": "string"
                },
                "mobile": {
                    "description": "手机号",
                    "type": "string"
                },
                "report_name": {
                    "description": "报告标题",
                    "type": "string"
                },
                "user_name": {
                    "description": "用户名称",
                    "type": "string"
                }
            }
        },
        "utils.PagingItem": {
            "title": "PagingItem",
            "type": "object",
            "properties": {
                "current_index": {
                    "description": "当前页页码",
                    "type": "integer",
                    "format": "int64"
                },
                "is_end": {
                    "description": "是否最后一页",
                    "type": "boolean"
                },
                "is_start": {
                    "description": "是否首页",
                    "type": "boolean"
                },
                "next_index": {
                    "description": "下一页页码",
                    "type": "integer",
                    "format": "int64"
                },
                "page_size": {
                    "description": "每页数据条数",
                    "type": "integer",
                    "format": "int64"
                },
                "pages": {
                    "description": "总页数",
                    "type": "integer",
                    "format": "int64"
                },
                "previous_index": {
                    "description": "上一页页码",
                    "type": "integer",
                    "format": "int64"
                },
                "totals": {
                    "description": "总数据量",
                    "type": "integer",
                    "format": "int64"
                }
            }
        }
    },
    "tags": [
        {
            "name": "company_user",
            "description": "CompanyUser\n客户联系人模块\n"
        },
        {
            "name": "report",
            "description": "报告模块\n"
        },
        {
            "name": "report",
            "description": "报告模块\n"
        },
        {
            "name": "sys_user",
            "description": "Admin\n系统用户模块\n"
        }
    ]
}