请输入
菜单

文章开放接口文档

文档版本：v1.0
更新日期：2026-03-11
接口模块：文章开放 API

一、概述

1.1 文档说明

本文档描述文章相关的开放 API 接口，包括获取栏目列表、推送新闻等功能。所有接口均需通过 appId 和 secret 进行鉴权。

1.2 基础信息

项目 说明
Base URL https://www.shanghuiyi.com/open/article
鉴权方式 所有接口需在请求中携带 appId 和 secret 参数
数据格式 JSON

1.3 统一响应格式

json 复制代码 
{
  "errno": 0,
  "errmsg": "成功",
  "data": {}
}
字段 类型 说明
errno int 错误码，0 表示成功
errmsg string 错误信息
data object/array 业务数据，成功时根据接口返回不同结构

二、接口列表

序号 接口名称 请求方式 路径 说明
1 获取栏目列表 GET /open/article/categories 获取当前协会下的栏目树形结构
2 推送新闻 POST /open/article/pushArticle 向指定协会推送一篇新闻文章

三、接口详情

3.1 获取栏目列表

3.1.1 接口说明

获取当前协会下的栏目树形结构，用于文章推送时选择所属栏目。

3.1.2 请求信息

项目 说明
请求方式 GET
请求路径 https://www.shanghuiyi.com/open/article/categories
Content-Type application/x-www-form-urlencoded 或 application/json

3.1.3 请求参数

参数名 类型 必填 说明
appId string 是 开放平台应用ID
secret string 是 开放平台密钥

3.1.4 请求示例

复制代码 
GET https://www.shanghuiyi.com/open/article/categories?appId={your_app_id}&secret={your_secret}

3.1.5 响应参数

参数名 类型 说明
errno int 错误码，0 表示成功
errmsg string 错误信息
data array 栏目树列表

data 中 CategoryVo 结构：

字段名 类型 说明
id int 栏目ID
categoryName string 栏目名称
categorySn string 栏目编码
list array 子栏目列表，结构同 CategoryVo

3.1.6 响应示例

json 复制代码 
{
  "errno": 0,
  "errmsg": "成功",
  "data": [
    {
      "id": 1,
      "categoryName": "新闻资讯",
      "categorySn": "news",
      "list": [
        {
          "id": 2,
          "categoryName": "行业动态",
          "categorySn": "industry",
          "list": []
        }
      ]
    }
  ]
}

3.2 推送新闻

3.2.1 接口说明

向指定协会推送一篇新闻文章。文章内容会先上传至 COS 存储，再创建文章记录。shId、contentUrl 由服务端根据鉴权结果和上传逻辑自动填充，无需传入。

3.2.2 请求信息

项目 说明
请求方式 POST
请求路径 https://www.shanghuiyi.com/open/article/pushArticle
Content-Type application/json

3.2.3 请求参数

Query 参数：

参数名 类型 必填 说明
appId string 是 开放平台应用ID
secret string 是 开放平台密钥

Body 参数 (ArticleDto)：

参数名 类型 必填 说明
title string 是 文章标题
content string 是 文章内容（富文本/纯文本）
categoryIds array[int] 是 栏目ID列表，至少一个
thumbImg string 否 封面图URL

3.2.4 请求示例

bash 复制代码 
POST https://www.shanghuiyi.com/open/article/pushArticle?appId={your_app_id}&secret={your_secret}
Content-Type: application/json

{
  "title": "2025年行业发展趋势分析",
  "content": "<p>文章正文内容...</p>",
  "categoryIds": [1, 2],
  "thumbImg": "https://example.com/cover.jpg"
}

3.2.5 响应参数

参数名 类型 说明
errno int 错误码，0 表示成功
errmsg string 错误信息
data object 成功时为空对象

3.2.6 响应示例

成功：

json 复制代码 
{
  "errno": 0,
  "errmsg": "成功",
  "data": {}
}

失败（参数校验）：

json 复制代码 
{
  "errno": 400,
  "errmsg": "文章标题不能为空！",
  "data": null
}

四、错误码说明

errno 说明
0 成功
非0 失败，具体原因见 errmsg

五、附录

5.1 参数校验规则

pushArticle 接口：

参数 校验规则
title 不能为空
content 不能为空
categoryIds 不能为空，至少包含一个栏目ID
上一个
证书开放接口文档
下一个
会员开放接口文档
最近修改: 2026-03-11Powered by