接口文档V1.0

一、文档说明

1.1、文档简介

1、当前接口版本:v1.0

2、接口地址:https://api.zhituiw.com/v1/index.html,为了数据传输安全,仅支持https通道。

3、所有请求及返回数据均使用utf-8进行编码,返回数据类型为json格式。

4、php版本sdk下载:api_v1_sdk.zip

1.2、公共参数

1、在所有接口调用中,都必须带以下参数。

参数名称 参数类型 是否必须 参数说明
access_key string 您可登录用户中心,在用户信息页面查看该参数值。
time string 请求时间,取当前unix时间戳,精确到秒,如果与服务器时间相差过大,会引起请求过期错误。
method string 接口方法(接口方法会在接下来章节给出相应的值)
signature string 签名,签名生成规则参考1.3节
signature_nonce string 签名唯一随机数,用于防止网络重放攻击,建议每一次请求都使用不同的随机数。
signature_method string 签名方法(默认为hmac-md5)

1.3、签名规则

1、筛选:获取所有请求参数,剔除 signature 参数,剔除值为空的参数。

2、排序:将筛选后的参数按照第一个字符的键值 ASCII 码递增排序(字母升序排序),如果遇到相同字符则按照第二个字符的键值 ASCII 码递增排序,以此类推。

3、拼接:将排序后的参数与其对应值,组合成“参数=参数值”的格式,并且把这些参数用 & 字符连接起来,此时生成的字符串为待签名字符串。

4、生成:将待签名字符串 和 access_secret 按照相应的签名方法获得签名,签名字符串全部为小写格式。

1.4、返回说明

1、本文档所涉及api的数据返回均为json字符串格式,json数据结构如下所示。

参数名称 参数类型 是否必须 参数说明
status number 接口请求状态,-1:失败 1:成功
code string 错误代码,如果接口请求成功则返回为空。
message string 接口返回提示信息
data array 调用接口后返回的数据

1.5、公共错误代码

1、此项列出公共错误代码。

code 代码说明
common.missing_access_key 访问凭证不能为空
common.access_key_not_found 访问凭证不存在
common.missing_time 时间戳不能为空
common.request_time_out 接口请求超时
common.missing_method 接口方法不能为空
common.method_not_found 接口方法不存在
common.missing_signature 签名不能为空
common.signature_not_match 签名验证失败
common.missing_signature_nonce 签名随机数不能为空
common.signature_nonce_already_exist 签名随机码已存在
common.missing_signature_method 签名方法不能为空
common.signature_method_not_support 签名方法不支持

二、软文接口

2.1、接口列表

接口名称 接口功能
article.add 用于文章发布
article.modify 文章修改,只有待审或拒审状态才可修改
article.query 文章查询,获取文章信息
article.delete 文章删除,只有待审或拒审状态才可删除
article.getRecord 获取发布记录,即文章链接

2.2、文章发布

请求参数:

参数名称 参数类型 是否必须 参数说明
method string 接口方法,文章发布使用:article.add
title string 文章标题
group_id number

分类ID

分类ID参考:1:新闻类 2:教育类 3:旅游类 4:健康类 5:娱乐类 6:房产类 7:科技类 8:财经类 9:体育类 10:行业类

keyword string 文章关键词
summary string 文章摘要
content string 文章内容
number number 文章发布数量
mark string 备注信息,仅自己可见,可留空
fixed_time string 定时发布,时间戳形式,不能小于当前时间,且必须设置在一年之内,可留空
out_order_no string 外部订单号,由接入方自行生成,可用于后期定位文章执行其他操作

返回参数:

参数名称 参数类型 是否必须 参数说明
status number 接口请求状态,-1:失败 1:成功
code string 错误代码,如果接口请求成功则返回为空。
message string 接口返回提示信息

2.3、文章修改

1、只有待审或拒审状态下的文章才可以执行修改操作

请求参数:

参数名称 参数类型 是否必须 参数说明
method string 接口方法,文章修改使用:article.modify
title string 文章标题
group_id number 分类ID
keyword string 文章关键词
summary string 文章摘要
content string 文章内容
mark string 备注信息,仅自己可见,可留空
fixed_time string 定时发布,时间戳形式,不能小于当前时间,且必须设置在一年之内,可留空
out_order_no string 外部订单号,用于定位要操作的文章

返回参数:

参数名称 参数类型 是否必须 参数说明
status number 接口请求状态,-1:失败 1:成功
code string 错误代码,如果接口请求成功则返回为空。
message string 接口返回提示信息

2.4、文章查询

请求参数:

参数名称 参数类型 是否必须 参数说明
method string 接口方法,文章修改使用:article.query
out_order_no string 外部订单号,用于定位要操作的文章

返回参数:

参数名称 参数类型 是否必须 参数说明
status number 接口请求状态,-1:失败 1:成功
code string 错误代码,如果接口请求成功则返回为空。
message string 接口返回提示信息
data array 调用接口后返回的数据
    ├─title string 文章标题
    ├─group_id string 分类ID
    ├─keyword string 文章关键词
    ├─summary string 文章摘要
    ├─content string 文章内容
    ├─number number 文章发布数量
    ├─process number 文章已发布数量
    ├─status number 文章审核状态:-2:撤稿 -1:拒稿 0:待审 1:通过 2:完成
    ├─add_time string 文章提交时间
    ├─fixed_time string 定时发布时间,如果是立即发布则该值为空

2.5、文章删除

1、只有待审或拒审状态下的文章才可以执行删除操作

请求参数:

参数名称 参数类型 是否必须 参数说明
method string 接口方法,文章删除使用:article.delete
out_order_no string 外部订单号,用于定位要操作的文章

返回参数:

参数名称 参数类型 是否必须 参数说明
status number 接口请求状态,-1:失败 1:成功
code string 错误代码,如果接口请求成功则返回为空。
message string 接口返回提示信息

2.6、获取发布记录

请求参数:

参数名称 参数类型 是否必须 参数说明
method string 接口方法,获取发布记录使用:article.getRecord
out_order_no string 外部订单号,用于定位要操作的文章

返回参数:

参数名称 参数类型 是否必须 参数说明
status number 接口请求状态,-1:失败 1:成功
code string 错误代码,如果接口请求成功则返回为空。
message string 接口返回提示信息
data array 调用接口后返回的数据,由于返回多条数据,将以二维数组形式返回
    ├─website_name string 网站名称
    ├─website_url string 网站地址
    ├─url string 发布链接

2.7、接口错误代码

1、此项列出常规错误代码。

code 代码说明
article.missing_title 文章标题不能为空
article.invalid_title 文章标题格式错误,不能超过50字符
article.missing_group_id 分类ID不能为空
article.invalid_group_id 分类ID格式错误,必须为整数
article.group_id_not_found 分类ID不存在
article.invalid_keyword 文章关键词格式错误,不能超过100字符
article.invalid_summary 文章摘要格式错误,不能超过200字符
article.missing_content 文章内容不能为空
article.invalid_content 文章内容格式错误,不能超过50000字符
article.missing_number 发布数量不能为空
article.invalid_number 发布数量格式错误,必须为整数
article.number_out_of_range 发布数量超出范围
article.invalid_mark 备注信息格式错误,不能超过50字符
article.fixed_time_out_of_range 定时发布时间超出范围,不能小于当前时间,且必须设置在一年之内
article.missing_out_order_no 外部订单号不能为空
article.invalid_out_order_no 外部订单号格式错误,不能超过50字符
article.out_order_no_already_exist 外部订单号已存在
article.out_order_no_not_found 外部订单号不存在
article.money_not_enough 账户余额不足
article.operation_not_permit 文章已审核通过或已发布完成,不允许操作
article.url_number_out_of_range 插入外链数量超过范围,限制5条以内
  • Copyright© 2020-2025 北京财融科技有限公司
  • 京ICP备15051378号-6

QQ客服

QQ:

扫码关注本站