海讯社开放平台接口文档(V1.1)

更新

(1)版本号:v1.0;更新时间:2021年10月14日;更新内容:创建API接口文档。

(1)版本号:v1.1;更新时间:2021年11月09日;更新内容:更新返回值说明。

目录

1、令牌获取

2、令牌刷新

3、软文资源

4、自媒体资源

5、海外发稿资源

6、海外社媒资源

7、资源状态查询

8、创建订单

9、查询订单

10、更新订单

1、令牌获取

注:令牌有效时间7200秒;建议保存令牌,在令牌有效期快结束之前刷新令牌(比如7100秒时刷新令牌)

接口地址:https://api.haipress.com/api/member/user/tokenON

请求方式:POST

请求参数:

参数名 必填 描述
token Y 海讯社提供token
key Y 海讯社提供key
clientType Y 固定值:5;放入headers。

返回参数(json格式):

参数名 类型 描述
code Integer 200成功;当返回code不为200时,参考【返回msgen与msgcn详细说明】,根据返回值定义处理逻辑
msgen String 英文描述(参考返回msgen与msgcn详细说明)
msgcn String 中文描述(参考返回msgen与msgcn详细说明)
data String 访问令牌;将携带此令牌请求下面的刷新令牌、资源、订单接口

返回msgen与msgcn详细说明(当返回code不为200时,可根据返回值定义处理逻辑):

msgen msgcn
paramNull 参数(token与key)不能为空
tokenError token错误
keyError key错误
tokenException token异常请联系客服
success token获取成功
2、令牌刷新

注:令牌有效时间7200秒;建议保存令牌,在令牌有效期快结束之前刷新令牌(比如7100秒时刷新令牌)

接口地址:https://api.haipress.com/api/member/user/refreshTokenON

请求方式:GET

请求参数:

参数名 必填 描述
openToken Y 访问令牌(参考令牌获取);放入headers。
clientType Y 固定值:5;放入headers。

返回参数(json格式):

参数名 类型 描述
code Integer 200成功;当返回code不为200时,参考【返回msgen与msgcn详细说明】,根据返回值定义处理逻辑
msgen String 英文描述(参考返回msgen与msgcn详细说明)
msgcn String 中文描述(参考返回msgen与msgcn详细说明)
data String 访问令牌;将携带此令牌请求刷新令牌、资源、订单接口

返回msgen与msgcn详细说明(当返回code不为200时,可根据返回值定义处理逻辑)

msgen msgcn
tokenNull openToken不能为空
tokenError openToken错误
tokenExpired openToken已过期
authorityError 请求接口地址错误
refreshTokenError token刷新失败
success token刷新成功
3、软文资源

注:请定时更新, 确保资源同步;资源状态可根据资源状态接口查询;每页查询数量不要过多,建议不要超过3000条,可先查询total总数,再分页查询

接口地址:https://api.haipress.com/api/media/resources/list1ON

请求方式:POST

请求参数:

参数名 必填 描述
openToken Y 访问令牌(参考令牌获取);放入headers。
clientType Y 固定值:5;放入headers。
page Y 页数
limit Y 每页条数
own N 特色资源(0:否  1:是)

返回参数(json格式):

参数名 类型 描述
code Integer 200成功;当返回code不为200时,参考【返回msgen与msgcn详细说明】,根据返回值定义处理逻辑
msgen String 英文描述(参考返回msgen与msgcn详细说明)
msgcn String 中文描述(参考返回msgen与msgcn详细说明)
data Json 返回数据:{total:总数, list:[详细数据,参考list字段说明]}

list字段说明:

参数名 类型 描述
sourceid String 资源id
classify String 媒体分类
region String 区域
name String 媒体名称
costprice Double 价格
entrancelink String 入口链接
caseurl String 案例地址
searchcoll String 搜索收录
linktype Integer 链接类型( 2:可带网址 0:不可带网址)
publishtime Integer 发稿速度(1:一小时内 2:二小时内 12:半天 24:当天 48:隔天 49:2天以上 )
newsresource Integer 新闻源(1:百度新闻源 0:非百度新闻源)
weekendpublish Integer 周末可发(1:可发 0:不可发)
portalmedia String 综合门户
industrystr String 特别行业
searchcollint Integer 收录情况(0:不包收录 1:包收录)
pcweight Integer 电脑权重(0:无权重 1:权重1 2:权重2……)
wapweight Integer 移动权重(0:无权重 1:权重1 2:权重2……)
entrlevel Integer 入口级别(0:没有入口 1:首页入口 2:频道入口 3:上级入口)
remark String 备注
recommend Integer 推荐(1:是 0:否)
flag Integer 状态(1:上架 0:下架)
deleted Integer 删除(1:正常 0:已删除)

返回msgen与msgcn详细说明(当返回code不为200时,可根据返回值定义处理逻辑)

msgen msgcn
tokenNull openToken不能为空
tokenError openToken错误
tokenExpired openToken已过期
authorityError 请求接口地址错误
userError 账号异常,请联系客服
success 资源查询成功
4、自媒体资源

注:请定时更新, 确保资源同步;资源状态可根据资源状态接口查询;每页查询数量不要过多,建议不要超过3000条,可先查询total总数,再分页查询

接口地址:https://api.haipress.com/api/media/resources/list2ON

请求方式:POST

请求参数:

参数名 必填 描述
openToken Y 访问令牌(参考令牌获取);放入headers。
clientType Y 固定值:5;放入headers。
page Y 页数
limit Y 每页条数
own N 特色资源(0:否  1:是)

返回参数(json格式):

参数名 类型 描述
code Integer 200成功;当返回code不为200时,参考【返回msgen与msgcn详细说明】,根据返回值定义处理逻辑
msgen String 英文描述(参考返回msgen与msgcn详细说明)
msgcn String 中文描述(参考返回msgen与msgcn详细说明)
data Json 返回数据:{total:总数, list:[详细数据,参考list字段说明]}

list字段说明:

参数名 类型 描述
sourceid String 资源id
classify String 媒体分类
region String 区域
name String 媒体名称
costprice Double 价格
entrancelink String 入口链接
caseurl String 案例地址
authint Integer 账号认证 1:已认证 0:未认证
industrystr String 行业分类
fans Integer 粉丝数 1(0-1000) 5(1001-5000);10(5001-1万);50(1万-5万);100(5万-10万);1000(10万-100万);1001(100万以上)
readnumber Integer 阅读数 1(0-1000);5(1001-5000);10(5001-1万);50(1万-5万);100(5万-10万);101(10万)
weekendpublish Integer 周末可发 1:可发 0:不可发
isvideo Integer 可发视频 1:可发 0:不可发
remark String 备注
recommend Integer 推荐 1:是 0:否
flag Integer 状态 1:上架 0:下架
deleted Integer 删除 1:正常 0:已删除

返回msgen与msgcn详细说明(当返回code不为200时,可根据返回值定义处理逻辑)

msgen msgcn
tokenNull openToken不能为空
tokenError openToken错误
tokenExpired openToken已过期
authorityError 请求接口地址错误
userError 账号异常,请联系客服
success 资源查询成功
5、海外发稿资源

注:请定时更新, 确保资源同步;资源状态可根据资源状态接口查询;

接口地址:https://api.haipress.com/api/media/resources/list3ON

请求方式:POST

请求参数:

参数名 必填 描述
openToken Y 访问令牌(参考令牌获取);放入headers。
clientType Y 固定值:5;放入headers。
page Y 页数
limit Y 每页条数
own N 特色资源(0:否  1:是)

返回参数(json格式):

参数名 类型 描述
code Integer 200成功;当返回code不为200时,参考【返回msgen与msgcn详细说明】,根据返回值定义处理逻辑
msgen String 英文描述(参考返回msgen与msgcn详细说明)
msgcn String 中文描述(参考返回msgen与msgcn详细说明)
data Json 返回数据:{total:总数, list:[详细数据,参考list字段说明]}

list字段说明:

参数名 类型 描述
sourceid String 资源id
language String 语言分类
region String 国家地区
name String 媒体名称
costprice Double 价格
producttype Integer 产品类型 1:海外直投 2:国外单发 3:海外套餐 4:翻译/配音 5:母语撰写 6:数据监测 7:创意营销
publishtime Integer 发布速度 24:24小时 48:48小时 1000:更多时间
searchcollint Integer 收录情况 0:不包收录 1:新闻源 2:网页
translation Integer 翻译选项 0:不包翻译 1:包翻译
label Integer 标签选项 0:无标签 1:有标签
bottominfo Integer 底部信息 0:无需底部信息 1:需要底部信息
postauth Integer 发布授权 0:无需授权 1:需要授权
piccost Integer 图片费用 0:免费 1:收费 2:无图片
industrystr String 特别行业
caseurl String 案例地址
remark String 发布说明
recommend Integer 推荐 1:是 0:否
flag Integer 状态 1:上架 0:下架
deleted Integer 删除 1:正常 0:已删除

返回msgen与msgcn详细说明(当返回code不为200时,可根据返回值定义处理逻辑)

msgen msgcn
tokenNull openToken不能为空
tokenError openToken错误
tokenExpired openToken已过期
authorityError 请求接口地址错误
userError 账号异常,请联系客服
success 资源查询成功
6、海外社媒资源

注:请定时更新, 确保资源同步;资源状态可根据资源状态接口查询;

接口地址:https://api.haipress.com/api/media/resources/list4ON

请求方式:POST

请求参数:

参数名 必填 描述
openToken Y 访问令牌(参考令牌获取);放入headers。
clientType Y 固定值:5;放入headers。
page Y 页数
limit Y 每页条数
own N 特色资源(0:否  1:是)

返回参数(json格式):

参数名 类型 描述
code Integer 200成功;当返回code不为200时,参考【返回msgen与msgcn详细说明】,根据返回值定义处理逻辑
msgen String 英文描述(参考返回msgen与msgcn详细说明)
msgcn String 中文描述(参考返回msgen与msgcn详细说明)
data Json 返回数据:{total:总数, list:[详细数据,参考list字段说明]}

list字段说明:

参数名 类型 描述
sourceid String 资源id
language String 语言分类
region String 国家地区
name String 媒体名称
costprice Double 价格
socialtype Integer 社媒分类 1:Instagram 2:Facebook 3:Youtube 4:Tiktok 5:Twitter 6:其他 7:LinkedIn
onlinetime Integer 在线时长 1:24小时 2:7天 3:30天 4:永久
postway Integer 发布方式 1:内容分发 2:原创制作发布 3:广告植入 4:其他
fans Integer 粉丝数量 1:1万以下 10:10万以下 30:30万以下 80:80万以下 100:100万以上
industrystr Integer 行业分类
caseurl String 案例地址
remark String 发布说明
recommend Integer 推荐 1:是 0:否
flag Integer 状态 1:上架 0:下架
deleted Integer 删除 1:正常 0:已删除

返回msgen与msgcn详细说明(当返回code不为200时,可根据返回值定义处理逻辑)

msgen msgcn
tokenNull openToken不能为空
tokenError openToken错误
tokenExpired openToken已过期
authorityError 请求接口地址错误
userError 账号异常,请联系客服
success 资源查询成功
7、资源状态查询

注:更新资源后,可用此接口定时查询资源状态,确保资源状态正确。

接口地址:https://api.haipress.com/api/media/resources/stateON

请求方式:POST

请求参数:

参数名 必填 描述
openToken Y 访问令牌(参考令牌获取);放入headers。
clientType Y 固定值:5;放入headers。
sourceid Y 海讯资源id

返回参数(json格式):

参数名 类型 描述
code Integer 200成功;当返回code不为200时,参考【返回msgen与msgcn详细说明】,根据返回值定义处理逻辑
msgen String 英文描述(参考返回msgen与msgcn详细说明)
msgcn String 中文描述(参考返回msgen与msgcn详细说明)
data Json 返回数据,参考data字段说明

data字段说明:

参数名 类型 描述
flag Integer 状态 1:上架 0:下架
deleted Integer 删除 1:正常 0:已删除

返回msgen与msgcn详细说明(当返回code不为200时,可根据返回值定义处理逻辑)

msgen msgcn
tokenNull openToken不能为空
tokenError openToken错误
tokenExpired openToken已过期
authorityError 请求接口地址错误
success 资源状态查询成功
8、创建订单

接口地址:https://api.haipress.com/api/media/order/createON

请求方式:POST;注意contentType为application/json

请求参数:

参数名 必填 描述
openToken Y 访问令牌(参考令牌获取);放入headers。
clientType Y 固定值:5;放入headers。
data Y 订单数据(参考data字段说明);注意data不是参数名称,按照【data字段说明】封装,放入body即可。

data字段说明(需将data数据转成json格式):

参数名 必填 描述
ordernum Y 订单号(接入方系统的订单号)
title Y 标题(需单独使用urlencode)
content Y 内容(传预览地址即可,需单独使用urlencode)
remark N 订单备注(不为空时需单独使用urlencode)
origin N 订单来源(有些媒体发布需要白名单;不为空时需单独使用urlencode)
price Y 资源价格(海讯社提供的资源价格,防止资源未更新导致亏损;资源价格与海讯社相等方能推送成功)
sourceid Y 资源id

返回参数(json格式):

参数名 类型 描述
code Integer 200成功;当返回code不为200时,参考【返回msgen与msgcn详细说明】,根据返回值定义处理逻辑
msgen String 英文描述(参考返回msgen与msgcn详细说明)
msgcn String 中文描述(参考返回msgen与msgcn详细说明)

返回msgen与msgcn详细说明(当返回code不为200时,可根据返回值定义处理逻辑)

msgen msgcn
tokenNull openToken不能为空
tokenError openToken错误
tokenExpired openToken已过期
authorityError 请求接口地址错误
paramNull 参数不完整
userError 在海讯社创建的账号异常,请联系客服
resourcesError 资源已下架(订单可直接拒稿)
priceError 资源价格不匹配(订单可直接拒稿)
orderExist 订单已存在,请勿重复推送(订单状态可更新为已推送,根据对接系统自行设置)
depositLess 账户余额不足
success 订单推送成功
9、查询订单

接口地址:https://api.haipress.com/api/media/order/queryON

请求方式:POST

请求参数:

参数名 必填 描述
openToken Y 访问令牌(参考令牌获取);放入headers。
clientType Y 固定值:5;放入headers。
ordernum Y 订单号(接入方系统的订单号)

返回参数(json格式):

参数名 类型 描述
code Integer 200成功;当返回code不为200时,参考【返回msgen与msgcn详细说明】,根据返回值定义处理逻辑
msgen String 英文描述(参考返回msgen与msgcn详细说明)
msgcn String 中文描述(参考返回msgen与msgcn详细说明)
data json 返回数据(参考data字段说明)

data字段说明:

参数名 类型 描述
flag Integer 订单状态 0:订单不存在 1:发布中 2:拒稿 3:发布成功,等待确认(发布24小时后自动审核通过) 4:反馈处理中 5:已完成;说明:对状态疑惑请联系海讯社技术部
url String 订单发布地址(当订单状态为3或5时,返回该值)
result String 订单反馈信息(拒稿理由)

返回msgen与msgcn详细说明(当返回code不为200时,可根据返回值定义处理逻辑)

msgen msgcn
tokenNull openToken不能为空
tokenError openToken错误
tokenExpired openToken已过期
authorityError 请求接口地址错误
success 订单状态查询成功
10、更新订单

接口地址:https://api.haipress.com/api/media/order/processON

请求方式:POST;注意contentType为application/json

请求参数:

参数名 必填 描述
openToken Y 访问令牌(参考令牌获取);放入headers。
clientType Y 固定值:5;放入headers。
data Y 更新数据(参考data字段说明);注意data不是参数名称,按照【data字段说明】封装,放入body即可

data字段说明(需将data数据转成json格式):

参数名 必填 描述
ordernum Y 订单号(接入方系统的订单号)
flag Y 类型:Integer;
订单状态为3(等待确认)时接受订单更新,其余状态不接受;只接受这两个值4(反馈)或5(已完成)
releaseresult N 反馈意见(不为空时需单独使用urlencode;当flag填写为4,最好填写该值,以便媒体纠错)

返回参数(json格式):

参数名 类型 描述
code Integer 200成功;当返回code不为200时,参考【返回msgen与msgcn详细说明】,根据返回值定义处理逻辑
msgen String 英文描述(参考返回msgen与msgcn详细说明)
msgcn String 中文描述(参考返回msgen与msgcn详细说明)

返回msgen与msgcn详细说明(当返回code不为200时,可根据返回值定义处理逻辑)

msgen msgcn
tokenNull openToken不能为空
tokenError openToken错误
tokenExpired openToken已过期
authorityError 请求接口地址错误
paramNull 参数不完整
flagError 只接受这两个值4(反馈)或5(已完成)
orderNull 订单不存在(订单号错误)
stateError 该订单已不接受更新(需要客服手动核实处理)
success 订单更新成功