跳到主要内容

软件API接口

概述​

msray软件开放API接口，可自行开发程序，通过HTTP协议与软件通讯。

提交任务API接口​

请求地址： http://127.0.0.1:34567/task/create

请求方式： POST

请求头类型： Content-Type:application/json

请求参数：

字段类型描述
keywords[]string关键词列表 字符串数组
engines[]string使用的搜索引擎列表 字符串数组. 可选值请参考附录-搜索引擎代码
maxPageint最大搜索页码，建议为8
saveRelatedStatusint是否存储相关词 1=开启 2=关闭
addRelatedStatusint是否自动把相关词加入队列 1=开启 2=关闭
autoRetryint是否开启失败自动重试 1=开启 2=关闭

请求参数例子：

{
    "keywords": ["msray","msray-search","msray-plus"],
    "engines": ["baidu","bing","sogou"],
    "maxPage": 8,
    "saveRelatedStatus": 1,
    "addRelatedStatus": 1,
    "autoRetry":1
}

成功返回内容：

{
    "code": 200,
    "data": {
        "keywords": ["msray","msray-search","msray-plus"],
        "engines": ["baidu","bing","sogou"],
        "maxPage": 8,
        "saveRelatedStatus": 1,
        "addRelatedStatus": 1,
        "autoRetry":1
    }，
    "message": "success"
}

失败返回内容：

{
    "code": 1000,
    "data": ""，
    "message": "xxxxxx"
}

附录：搜索引擎代码表​

搜索引擎编码
百度搜索baidu
百度移动搜索baidu_mobile
必应搜索bing
搜狗搜索sogou
谷歌搜索google