接入指南

小理简报开放平台以Rest API形式提供新闻资讯服务,接入小理简报开放平台主要包括以下流程:

  1. 开通小理简报企业账号,小理简报企业版访问地址:https://r.xiaoli.ai/
  2. 创建应用,配置应用的全局参数。
  3. 开始开发。

开通小理企业版账号

正式开始前,请首先注册小理简报企业版账号, 注册完成后需要提交企业相关信息以进行审核。

收到您的企业信息后,工作人员会尽快与您取得联系以完成审核,审核通过后就可以登录系统开始使用了。

创建新应用

点击左侧导航栏的“接口服务 - 新建接口应用”,转到创建页面,创建新的应用

配置应用全局参数

成功创建应用后,系统会为应用设置相应的默认全局参数。默认参数能够满足大多数情况的需求,开发者可以根据实际需求进行修改。

全局参数包括:

参数名称 参数取值 备注
应用名称 用户自定义的名称
应用描述 用户自定义的描述
接口服务类型 应用所开通的接口种类,多选,默认开通新闻检索接口
默认检索范围 系统默认的检索范围为“默认资讯源”。 新闻资讯比新闻范围更大,包括发表在博客、公众号等信息源的内容。
负面资讯过滤 启用该设置后,小理将自动过滤负面资讯。接口返回的资讯列表中将不包含负面资讯。 负面资讯判定由计算机算法完成,可能存在漏报的情况。应用开发方可根据自身需求进一步过滤负面资讯。

获得应用密钥

创建成功后,进入左侧导航栏“接口服务 - 我的应用”,根据名称选择刚刚创建的应用,查看应用的具体信息。

在应用信息页面可以看到系统后台将为每个应用生成AppSecret(应用密钥)。该密钥将用于API身份验证,请务必以安全的形式保存,不可交与第三方。

开始开发

Hello World

小理简报提供如下REST风格的HTTP接口:https://api.xiaoli.com/v1/api/...;用户可以用HTTP请求工具测试接口,以下给出cURL的请求示例。

打开命令行窗口,输入以下cURL命令,提交一个POST请求:

curl -d '{"token": "YOUR_APP_SECRET"}' \
     -H "Content-Type: application/json" \
     -X POST https://api.xiaoli.ai/v1/api/validate

将YOUR_APP_SECRET替换成所创建应用的AppSecret(应用密钥)

正常情况下,该命令将返回如下结果:

{
    "msg": "OK"
}

请求数据格式

API接口请求的参数通过POST方法所带的Body实现,请求数据格式为json,每个请求Body需要提供token字段:

{
    "token": "YOUR_APP_SECRET",
    "...": "..."
}

将YOUR_APP_SECRET替换成所创建应用的AppSecret(应用密钥),其他字段参见具体接口。

响应数据格式

用户需要通过HTTP Status Code确定返回结果的正确性,结果成功返回后http代码为2XX,错误则返回4XX,主要包括400(参数错误),401(token验证失败)等。请参考HTTP返回代码规范

具体的返回数据在response的body中,响应数据包的格式为JSON格式,UTF-8编码。

json字段一般包括:

字段 名称 取值
msg 响应提示消息 错误时显示响应提示信息
data 响应数据 不同接口响应数据各异,请参见具体接口