首页 > 开发者资源 > SAAS在线API

融媒体数字报报刊系统API开发规范

更新时间:2023-03-15 作者:中栖梧桐云

综述

云享EICapitanAPI说明

1、请求方式: get

2、返回值:全量字段,CJSON::encode

3API 参数:①允许采集 ;②允许指定白名单IP连接;③允许指定应用的ID、密钥连接;

4、防采集参数

5、第三方App应用接入api认证服务,对外服务状态:未开放;

6、接入API,请注意单位时间(1’)内请求并发数(建议:请求间隔时间1~3’);规避激活“风控”系统而被拒绝请求

 

方案一:

1.       特点

xml全量全息数据源API请求,按照时间(期次)输出一个期次包含所有信息,以JSON数据输出;

2.       优势

数据回调比较集中;开发者调用API易于理解。

3.       劣势

XML数据入库后,数据一次定稿;即发布管理者再次修订数据不更新XML全集数据。譬如:①期次数据下线;②新闻文字修改

第三方APP,需要依据实际业务情况,依据实际业务逻辑组装数据。

方案二(备选):

1.       特点

报刊在线数据(不含归档数据、入库但未发布数据)

2.       优势

    数据按需回调;②对外数据随时更新、修改。③已经具有数字报刊业务逻辑数据关系

3.       劣势

①下线/在线,状态由用户管理;②数据API接口分散

XML全集数据API接口

接口1:请求报刊最新期次xml全息数据

1API_URL

http://域名/节点名/release/json_release_xml_info?xml_date=年年年年-月月-日日&appsecret=xxxxxx字符串

2、示例

http://XXX/节点名/release/json_release_xml_info?xml_date=2022-07-13&appsecret=1sdsfdfdfddgd

3API说明

请求地址

/报刊节点名/release/json_release_xml_info

请求方式

GET

请求示例

参见上述示例

响应格式

application/json;charset=UTF-8

错误代码

error_msg_code:6004//代表报刊AppID错误

error_msg_code:6001//代表AppID_api_status为关闭状态,请联络云报刊平台运维工程师

error_msg_code:6002//代表 appidappsecret密钥串错误,密钥串请联络云报刊平台

null;//代表 无数据

error_msg_code:6003//代表IP被封禁,请联络云报刊平台运维工程师设置白名单

error_msg_code:6005//代表单位时间(1’) ,API调用次数累积超额或被风控判断为恶意调用而被阻止。

返回数据格式

CJSON::encode

 

 


字段说明:

 

字段

说明

xml_id

输出XML数据主键ID

release_id

期次id

paper_id

版次id

news_id

新闻id

xml_reportedperson

报道对象(购买广告管理系统才可获得)

xml_year

xml数据实际【年】份 索引使用

xml_month

xml数据实际【月】份 索引使用

xml_papername

报纸名称

xml_lssue

期次

xml_date

出版日期

xml_pagecount

本期报纸总页数

xml_editionnumber

当前xml的版次

xml_thumbnailimage

本版的jpg版面图文件名

xml_pagename

版名

xml_pagepdf

本版pdf文件名

xml_sizewidth

版面实际宽度

xml_sizeheight

版面实际高度

xml_title_eyebrow

引题(肩题)

xml_title

标题

xml_title_sub

副题

xml_author

作者

xml_class

分类

xml_articleclass

文章分类

xml_imagesnumbers

新闻插图数量

xml_resource

文章来源

xml_area

地区

xml_foreword

新闻前言或引言

xml_keywords

关键词

xml_content

正文

xml_coordinate

原始坐标

xml_wordsnumber

文章字数

xml_personage

人物

xml_subjectmatter

题材

xml_product

广告产品(购买广告管理系统才可获得)

xml_color

广告颜色(购买广告管理系统才可获得)

xml_advertisers

广告主(购买广告管理系统才可获得)

xml_size

广告面积(购买广告管理系统才可获得)

xml_adervertisetype

广告类型((购买广告管理系统才可获得)

xml_data_url

当前期次物理数据所在逻辑路径

接口2:请求新闻数据的新闻插图

1API_URL

http://域名/节点名/release/release/json_xml_imge?xml_id=xxx&appsecret=xxxx

2、示例

http://XXX/节点名/release/json_xml_imge?xml_id=xxx&appsecret=xxxxxx

3API说明

 

请求地址

/节点名/release/json_xml_imge

请求方式

GET

请求示例

参见上述示例

响应格式

application/json;charset=UTF-8

错误代码

error_msg_code:6004//代表报刊AppID错误

error_msg_code:6001//代表AppID_api_status为关闭状态,请联络云报刊平台运维工程师

error_msg_code:6002//代表 appidappsecret密钥串错误,密钥串请联络云报刊平台

null;//代表 无数据

error_msg_code:6003//代表IP被封禁,请联络云报刊平台运维工程师设置白名单

error_msg_code:6005//代表单位时间(1’) ,API调用次数累积超额或被风控判断为恶意调用而被阻止。

返回数据格式

CJSON::encode

 

 

 

字段说明:

 

字段

说明

xml_image_author

新闻图片作者

xml_image_caption

图片说明

xml_image_name

图片名字

xml_image_url

地址

 

 

期次报刊在线数据API接口

接口1:期次信息API

1API_URL

http://域名/节点名/release/json_release_info?date=xxx&appsecret =xxxxxxxxxxxxx字符串

2、示例

http://域名/节点名/release/json_release_info?date=xxxx&appsecret=xxxxx

3API说明

 

请求地址

/报刊节点名/release/json_release_info

请求方式

GET

请求示例

参见上述示例

响应格式

application/json;charset=UTF-8

错误代码

error_msg_code:6004//代表报刊AppID错误

error_msg_code:6001//代表AppID_api_status为关闭状态,请联络云报刊平台运维工程师

error_msg_code:6002//代表 appidappsecret密钥串错误,密钥串请联络云报刊平台

null;//代表 无数据

error_msg_code:6003//代表IP被封禁,请联络云报刊平台运维工程师设置白名单

error_msg_code:6005//代表单位时间(1’) ,API调用次数累积超额或被风控判断为恶意调用而被阻止。

返回数据格式

CJSON::encode

 

 

 

字段说明:

 

字段

说明

release_id

期次id

release_name

期次名

release_time

出版时间

release_master

主编

release_pubtime

发布时间

release_opentime

公开时间

release_status

状态  1--发布  维护(审核)--2  存档(封存不公开)--3

release_total

总期次

release_pagecount

本期版面总数

 

 

接口2:期次所有版次信息API

1API_URL

http://域名/节点名/release/json_release_paper_info?release_id=xxx& appsecret=xxxx字符串

2、示例

http://域名/节点名/release/json_release_paper_info?release_id=xxx&appsecret=xxxx

3API说明

 

请求地址

/报刊节点名/release/json_release_paper_info

请求方式

GET

请求示例

参见上述示例

响应格式

application/json;charset=UTF-8

错误代码

error_msg_code:6004//代表报刊AppID错误

error_msg_code:6001//代表AppID_api_status为关闭状态,请联络云报刊平台运维工程师

error_msg_code:6002//代表 appidappsecret密钥串错误,密钥串请联络云报刊平台

null;//代表 无数据

error_msg_code:6003//代表IP被封禁,请联络云报刊平台运维工程师设置白名单

error_msg_code:6005//代表单位时间(1’) ,API调用次数累积超额或被风控判断为恶意调用而被阻止。

返回数据格式

CJSON::encode

 

 

 

字段说明:

 

字段

说明

paper_id

版面id

paper_release_id

期次id

paper_url

版面图URl

paper_time

上传时间

paper_editor_id

本版编辑id

paper_filesize

版面大小:宽度

paper_site_id

站点ID

paper_name_cn

版面名称

paper_editor

编辑名

paper_pdf

Pdf文件URL

paper_timestamp

版面生成时间戳

paper_html_url

静态html 如果为空 则没有生成

paper_editionnumber

版次

cache

缓存

 

 

接口3:版面的所有新闻信息API

1API_URL

http://域名/节点名/news/json_paper_news_info?paper_id=xxx&appsecret=xxxxxx字符串

2、示例

http://域名/节点名/news/json_paper_news_info?paper_id=xxx&appsecret=xxxxx

3API说明

请求地址

/报刊节点名/news/json_paper_news_info

请求方式

GET

请求示例

参见上述示例

响应格式

application/json;charset=UTF-8

错误代码

error_msg_code:6004//代表报刊AppID错误

error_msg_code:6001//代表AppID_api_status为关闭状态,请联络云报刊平台运维工程师

error_msg_code:6002//代表 appidappsecret密钥串错误,密钥串请联络云报刊平台

null;//代表 无数据

error_msg_code:6003//代表IP被封禁,请联络云报刊平台运维工程师设置白名单

error_msg_code:6005//代表单位时间(1’) ,API调用次数累积超额或被风控判断为恶意调用而被阻止。

返回数据格式

CJSON::encode

 

 

 

字段说明:

 

字段

说明

news_id

新闻id

news_order_num

排序id

news_title_eyebrow

引题(肩题)

news_title

标题

news_title_sub

副题

news_author

作者

news_class

分类

news_articleclass

文章分类

news_imagesnumbers

新闻插图数量

news_resource

文章来源

news_foreword

新闻前言或引言

news_keywords

关键词

news_content

正文

news_type

文章类型:1-无图文章  2-有图文章  3-纯图片文章

news_edit_time

编辑时间

news_updatetime

更新时间

news_paper_id

所属版面id

news_release_id

所属期次id

news_site_id

所属站点

news_coordinate

原始坐标

news_paper_order

版次内新闻排序

接口4:新闻插图信息API

1API_URL

http://域名/节点名/news/json_imge_info?news_id=xxx&appsecret=xxxxxxxxxxxxx字符串

2、示例

http://域名/节点名/news/json_imge_info?news_id=xxx&appsecret=xxxxx

3API说明

请求地址

/报刊节点名/release/json_imge_info

请求方式

GET

请求示例

http://XXX/节点名

响应格式

application/json;charset=UTF-8

错误代码

error_msg_code:6004//代表报刊AppID错误

error_msg_code:6001//代表AppID_api_status为关闭状态,请联络云报刊平台运维工程师

error_msg_code:6002//代表 appid appsecret密钥串错误,密钥串请联络云报刊平台

null;//代表 无数据

error_msg_code:6003//代表IP被封禁,请联络云报刊平台运维工程师设置白名单

error_msg_code:6005//代表单位时间(1’) ,API调用次数累积超额或被风控判断为恶意调用而被阻止。

返回数据格式

CJSON::encode

 

 

 

字段说明:

 

字段

说明

news_image_id

id

news_image_author

新闻图片作者

newsl_image_caption

图片说明

news_image_name

图片名字

news_image_url

图片地址

news_id

归属那个news数据

position

图片排序

接口5:最新8期报刊数据API

1API_URL

http://域名/节点名/release/json_news_paper?appsecret=xxxxxxxxxxxxx字符串

2、示例

http://域名/节点名/release/json_news_paper?appsecret=xxxxx

3API说明

请求地址

/报刊节点名/release/json_imge_info

请求方式

GET

请求示例

http://XXX/节点名

响应格式

application/json;charset=UTF-8

错误代码

error_msg_code:6004//代表报刊AppID错误

error_msg_code:6001//代表AppID_api_status为关闭状态,请联络云报刊平台运维工程师

error_msg_code:6002//代表 appid appsecret密钥串错误,密钥串请联络云报刊平台

null;//代表 无数据

error_msg_code:6003//代表IP被封禁,请联络云报刊平台运维工程师设置白名单

error_msg_code:6005//代表单位时间(1’) ,API调用次数累积超额或被风控判断为恶意调用而被阻止。

返回数据格式

CJSON::encode

 

 

 

字段说明:

字段

说明

paper_url

最新期次的URL

paper_index_img

最新期次的首版jpg

paper_id

版次ID

release_id

期次Id

paper_url

首版版面url

paper_pdf

首版版面pdf

paper_editionnumber

版面名称

release_name

期次名称

release_pubtime

期次出版时间



转载请以链接形式注明出处:

本篇文章来源于 "中栖梧桐云" :http://www.womtech.cn

中栖梧桐云 版权与免责声明:

① 凡本网注明“来源:中栖梧桐云”的所有作品,版权均属于中栖梧桐云,版权归中栖梧桐云所有,未经本网授权不得转载、摘编或利用其它方式使用上述作品。已经本网授权使用作品的,应在授权范围内使用,并注明“来源:中栖梧桐云”。违反上述声明者,本网将追究其相关法律责任。

② 凡本网注明“来源:XXX(非中栖梧桐云)”的作品,均转载自其它媒体,转载目的在于传递更多信息,并不代表本网赞同其观点和对其真实性负责。

③ 本网部分内容来自互联网,如因作品内容、版权和其它问题需要同本网联系的,请在30日内进行。

※ 联系方式:中栖梧桐云 Email:jinostart@126.com

最新活动

分类

立即注册,开启您的0门槛上融媒体云之旅!

免费试用

关注联系我们

微信公众号 微博

联系我们

热门推荐

快速入口

支持与服务

全部行业解决方案

    友情链接

©2021-2025 中栖梧桐 京ICP备15002495号-2 京公网安备11011402013126

    联系我们

售前电话咨询 010-13910566257 售后电话咨询 010-57117580 更多