使用说明
更新时间:2023-03-14
前言
- API是UNIT企业版开放能力的基础,借助API可以极大的节省人力成本,提高效率,用更高效的方式完成对UNIT企业版数据资源的管控。对于开发者来说,使用 API 完成一些重复性强的工作可以极大节约时间和精力;除此之外,API还有便于组合能力、便于自动化、扩展性强等优点。 本文介绍了管理端开放接口的鉴权参数、API请求结构和参数、数据返回结构和参数以及各个模块之间的关系。
- 角色说明。UNIT企业版服务分为管理端和服务端。 管理端: 用于内部运营使用。管理端数据可以发布推向服务端。 服务端: 最终用于C端用户查询使用 开放能力接口范围定义: /open 开头的都是管理端;/core 开头的是服务端;
请求鉴权
开放能力API调用时,依然需要在HTTP请求的header中加上Authorization字段,值为与Agent相匹配的token。如下:
key | value |
---|---|
Authorization | NGD {token} |
Api的地址格式为:{IP}:{PORT}/open/v{versionId}/{model}" 以ip地址为127.0.0.1,端口为8600,FAQ标准问创建地址为例,API的访问地址地址为:127.0.0.1:8600/open/v1/faq/standard/create
/open 开头的使用域名:openapi-ngd.baidu.com,/core 开头的域名地址为:api-ngd.baidu.com
注1:本文请求地址中的未明确写明版本的,versionId默认都为1,其他按照path中的为准
注2:开放接口服务目前默认关闭,有使用需求的用户可以填写咨询单,备注信息注明“开通开放接口使用”
请求返回值
返回值的格式分为请求正确与请求错误两种: 1、请求正确返回值:
参数名 | 类型 | 父节点 | 备注 |
---|---|---|---|
code | int | HTTP状态码(请求正确则为200) | |
time | long | 时间 | |
msg | string | 状态信息 | |
data | T | 返回数据 |
2、请求错误返回值:
参数名 | 类型 | 父节点 | 备注 |
---|---|---|---|
code | int | 错误状态码 | |
requestId | string | 请求ID | |
msg | string | 状态信息 | |
tip | string | 提示 |