You need to enable JavaScript to run this app.
导航

专题API

最近更新时间2023.02.28 17:57:49

首次发布时间2022.03.29 18:08:07

本接口用于客户获取专题内容,火山引擎会返回专题的标题、封面图以及关联的内容信息等。

注意

接入前需要联系火山引擎开通功能和接口访问权限,否则访问会被拦截。

请求方式

请求方法

GET/POST(Content-Type: application/x-www-form-urlencoded)

请求url

https://mercury.volcengineapi.com/?Action=HotBoard&Version=2021-01-01

请求header

ServiceName:content

请求参数

参数描述类型是否必填说明
Partner渠道号String
AccessToken用户唯一标识String
Biz业务类型String【默认】获取专题列表+内容列表
  • "list": 获取专题列表
  • "board": 获取指定专题详情
  • "article": 获取指定专题下的内容列表
Offset偏移量int当获取内容列表时,用于翻页请求。首次传0。
Limit指定返回条数int当获取内容列表时,用于指定返回内容条数。默认为10,最多支持20条。
HotBoardGid专题idString当获取专题详情或内容列表时使用

响应参数

参数
描述
类型
说明
Result
专题列表
List<Result>

示例代码

获取专题列表+内容列表

请求示例

public static void main(String[] args) {
    //初始化一个service
    StreamService streamService = StreamServiceImpl.getInstance();
    //设置ak,sk 此为请求的凭证
    streamService.setAccessKey("...");
    streamService.setSecretKey("...");
    //初始化一个request
    HotBoardRequest req = new HotBoardRequest();
    req.setPartner("...");
    req.setAccessToken("...");
    try {
        HotBoardResponse response = streamService.hotBoard(req);
        System.out.println(JSON.toJSONString(response));
    } catch (Exception e) {
        e.printStackTrace();
    }
}

响应示例

{
  "ResponseMetadata": {
    "Action": "HotBoard",
    "Error": {
      "Code": "",
      "CodeN": 0,
      "Message": ""
    },
    "Region": "cn-north-1",
    "RequestId": "202207201554550102111952290128A24F",
    "Service": "content",
    "Version": "2021-01-01"
  },
  "Result": [
    {
      "HotArticles": [
        {
          "Abstract": "...",
          "ArticleClass": "图文",
          "ArticleUrl": "...",
          "CommentCount": 1,
          "CommentUrl": "...",
          "CoverImageList": [
            {
              "Height": 498,
              "Uri": "...",
              "Url": "...",
              "UrlList": [
                {
                  "Url": "...",
                },
                {
                  "Url": "...",
                },
                {
                  "Url": "...",
                }
              ],
              "Width": 1024
            }
          ],
          "CoverMode": 3,
          "DiggCount": 2,
          "GroupId": "7121978595953820198",
          "HasVideo": false,
          "IsStick": false,
          "PublishTime": 1658215085,
          "ShareCount": 10,
          "ShareUrl": "...",
          "Source": "...",
          "Title": "...",
          "UserInfo": {
            "AvatarUrl": "...",
            "Description": "...",
            "Follow": false,
            "FollowerCount": 3217,
            "HomePage": "...",
            "IsFollowed": false,
            "IsFollowing": false,
            "Name": "...",
            "UserId": "110557154138",...
          },
          "VideoDuration": 0,
          "VideoWatchCount": 0
          ...
        },
        ...
      ],
      "HotBoard": {
        "ArticleUrl": "...",
        "Category": "technology",
        "CoverImageList": [
          {
            "Height": 960,
            "Uri": "...",
            "Url": "...",
            "UrlList": [
              {
                "Url": "...",
              }
            ],
            "Width": 540
          }
        ],
        "CoverImgUrl": "...",
        "GroupId": "7122257648254189603",
        "Title": "..."
        ...
      }
    },...
  ]
}

获取专题列表

请求示例

public static void main(String[] args) {
    //初始化一个service
    StreamService streamService = StreamServiceImpl.getInstance();

    //设置ak,sk 此为请求的凭证
    streamService.setAccessKey("...");
    streamService.setSecretKey("...");
    //初始化一个request
    HotBoardListRequest req = new HotBoardListRequest();
    req.setPartner("...");
    req.setAccessToken("...");
    try {
        HotBoardListResponse response = streamService.hotBoardList(req);
        System.out.println(JSON.toJSONString(response));
    } catch (Exception e) {
        e.printStackTrace();
    }
}

响应示例

{
  "ResponseMetadata": {
    "Action": "HotBoard",
    "Error": {
      "Code": "",
      "CodeN": 0,
      "Message": ""
    },
    "Region": "cn-north-1",
    "RequestId": "20220720161436010212136153183E72CA",
    "Service": "content",
    "Version": "2021-01-01"
  },
  "Result": [
    {
      "ArticleUrl": "...",
      "Category": "...",
      "CoverImageList": [
        {
          "Height": 960,
          "Uri": "...",
          "Url": "...",
          "UrlList": [
            {
              "Url": "...",
            }
          ],
          "Width": 540
        }
      ],
      "CoverImgUrl": "...",
      "GroupId": "7121531801671126559",
      "Title": "..."
      ...
    },
    {...},
    ...
  ]
}

获取专题详情

请求示例

public static void main(String[] args) {
    //初始化一个service
    StreamService streamService = StreamServiceImpl.getInstance();
    //设置ak,sk 此为请求的凭证
    streamService.setAccessKey("...");
    streamService.setSecretKey("...");
    //初始化一个request
    HotBoardBoardRequest req = new HotBoardBoardRequest();
    req.setPartner("...");
    req.setAccessToken("...");
    req.setHotBoardGid("7122257648254189603");
    try {
        HotBoardBoardResponse response = streamService.hotBoardBoard(req);
        System.out.println(JSON.toJSONString(response));
    } catch (Exception e) {
        e.printStackTrace();
    }
}

响应示例

{
  "ResponseMetadata": {
    "Action": "HotBoard",
    "Error": {
      "Code": "",
      "CodeN": 0,
      "Message": ""
    },
    "Region": "cn-north-1",
    "RequestId": "20220720160919010212074081082B18AE",
    "Service": "content",
    "Version": "2021-01-01"
  },
  "Result": {
    "ArticleUrl": "...",
    "Category": "technology",
    "CoverImageList": [
      {
        "Height": 960,
        "Uri": "...",
        "Url": "...",
        "UrlList": [
          {
            "Url": "...",
          }
        ],
        "Width": 540
      }
    ],
    "CoverImgUrl": "...",
    "GroupId": "7122257648254189603",
    "Title": "..."
    ...
  }
}

获取内容列表

请求示例

public static void main(String[] args) {
        //初始化一个service
        StreamService streamService = StreamServiceImpl.getInstance();

        //设置ak,sk 此为请求的凭证
        streamService.setAccessKey("...");
        streamService.setSecretKey("...");
        //初始化一个request
        HotBoardArticleRequest req = new HotBoardArticleRequest();
        req.setPartner("...");
        req.setAccessToken("...");
        req.setHotBoardGid("7122257648254189603");
//        req.setLimit(10);
        req.setOffset(0);
        try {
            HotBoardArticleResponse response = streamService.hotBoardArticle(req);
            System.out.println(JSON.toJSONString(response));
        } catch (Exception e) {
            e.printStackTrace();
        }
    }

响应示例

{
  "ResponseMetadata": {
    "Action": "HotBoard",
    "Error": {
      "Code": "",
      "CodeN": 0,
      "Message": ""
    },
    "Region": "cn-north-1",
    "RequestId": "202207201621200102120740811032C47D",
    "Service": "content",
    "Version": "2021-01-01"
  },
  "Result": [
              {
              "Abstract": "...",
              "ArticleClass": "图文",
              "ArticleUrl":  "...",
              "CommentCount": 5,
              "CommentUrl":  "...",
              "CoverImageList": [
                {
                  "Height": 2643,
                  "Uri":  "...",
                  "Url":  "...",
                  "UrlList": [
                    {
                      "Url":  "...",
                    },
                    {
                      "Url":  "...",
                    },
                    {
                      "Url":  "...",
                    }
                  ],
                  "Width": 3965
                }
              ],
              "CoverMode": 3,
              "DiggCount": 23,
              "GroupId": "7122304091337802278",
              "HasVideo": false,
              "IsStick": false,
              "PublishTime": 1658291723,
              "ShareCount": 6,
              "ShareUrl":  "...",
              "Source": "...",
              "Title": "...",
              "UserInfo": {
                "AvatarUrl":  "...",
                "Description": "...",
                "Follow": false,
                "FollowerCount": 440413,
                "HomePage":  "...",
                "IsFollowed": false,
                "IsFollowing": false,
                "Name": "...",
                "UserId": "...",
                ...
              },
              "VideoDuration": 0,
              "VideoWatchCount": 0
              ...
           },...
        ]
 }