RESTful接口

RESTful接口提供跟神箭手平台对接的一系列接口,主要包括对账号和信息的各种操作。

目前提供的接口包括 账号接口应用接口爬虫接口清洗接口API接口

接口地址

接口请求方式为POST,地址为

https://www.shenjian.io/rest/v3/<接口路径>

不同的接口有不同的接口路径。比如获取爬虫列表的接口路径crawler/list,该接口的POST地址为

https://www.shenjian.io/rest/v3/crawler/list

全局POST参数

有三个参数是所有RESTful接口都必须发送的参数,分别是user_keytimestampsign具体的接口如无特殊说明,都默认需要POST这三个参数。这三个参数用来验证用户的合法性。

每个用户注册之后,会分配各自的user_keyuser_secret,在用户基本信息中查看。user_key在请求中传递,user_secret需要开发者保管好,用来加密计算signsign的计算方法为,将user_keytimestampuser_secret顺序连接后进行md5,即:

md5(user_key + timestamp + user_secret)

参数列表如下:

参数 参数说明
user_key 用户自己的user_key
timestamp 发送请求时的时间戳,秒级
sign 根据上述算法计算的签名,32位,大小写均可

注意:

timestamp的单位是秒,与服务器时间前后相差不能超过5分钟,如果超过,服务器会返回相应的错误信息。

返回结果

结果返回json字符串,成功示例:

{
"code": 0,
"reason": "请求成功",
"data": {
"crawler_status": "未启动"
}
}

失败示例:

{
"code": 101,
"reason": "请求频率超过限制"
}

code为返回码,0表示成功,非0表示失败。
reason为失败的原因。
data为请求返回的数据。

全局返回码

返回码code对照表如下:

返回码 返回码说明
0 请求成功
500 通用请求失败,具体失败原因在reason中
100 缺少参数
101 请求频率超过限制
102 请求并发数超过限制
103 timestamp与服务器时间相差过大
104 user_key无效
105 签名sign无效
106 账号异常,已被冻结
107 账号欠费
108 账号未激活
100001 应用不存在
100002 没有操作权限
100003 参数类型错误
100004 应用状态错误
100005 没有信息被更新
100006 webhook没有通知事件
100007 webhook尚未设置
100008 发布项不存在