Appearance
快速开始
前言
欢迎使用 博达智能体开放平台 ,在阅读文档的过程中,如果您对文档有任何的问题,可在 博达智能体开放平台 的交流群里进行交流。
章节目的
本章节的目的,是为了帮助您快速的使用 博达智能体开放平台,把 博达智能体开放平台 的能力应用在自己产品里运行起来。
术语
开发者,调用开放平台接口的业务主体,开发者可以是个人或企业,企业我们一般也称为厂商;
应用,指具体的产品,产品属于一个特定的产品族;应用是调用开放接口的基本单元,一般也称为调用者;
clientId,调用方标识,为每一个调用方(应用)颁发一个clientId; clientSecret,调用方秘钥,为每一个调用方(应用)颁发一个clientSecret,使用clientId和clientSecret可以获取开放平台的调用许可(token);
接入指南
申请应用
目前需要发邮件申请,申请邮件地址:yangqiang@chinawebber.com,邮件内容如下:
邮件主题:申请 博达智能体开放平台 xxx 应用的 clientId 和 clientSecret
邮件内容:
1. 应用名称:xxx
2. 应用描述:xxx
3. 租户名称:xxx
4. 申请周期:2025-01-01 ~ 2025-12-31(示例)具体接入
根据自己的实际需要,浏览API文档,了解具体使用方法和参数,进行对应的编码工作
API鉴权机制
一、 获取ClientID和ClientScrete
二、 根据ClientID和ClientScrete生成access token
请求 https://api.vsbclub.com/boda/getTokenByClientId 获取access token,具体参见获取token接口说明
三、 将access token值通过header方式传入调用开放API
Authorization = “access token值” 进行对应的API接口请求
错误码
API总览
基础API
获取token
描述
获取请求API的授权token
http请求方式
GET
请求地址
https://api.vsbclub.com/boda/getTokenByClientId
请求参数
| 参数 | 类型 | 是否必填 | 说明 |
|---|---|---|---|
| clientId | String | 是 | clientId |
| clientSecret | String | 是 | clientSecret |
返回参数说明
| 参数 | 类型 | 说明 |
|---|---|---|
| code | int | 返回码 |
| msg | String | 操作信息 |
| data | Object | data详情 |
data结构体
| 参数 | 类型 | 说明 |
|---|---|---|
| requestHeader | String | 请求头的key值 |
| token | String | token值 |
| expiresIn | int | 失效时间 |
返回示例
{
"code": 200,
"msg": "操作成功",
"data": {
"requestHeader": "Authorization",
"token": "eyJhbGciOeyJhdWQiOlsiMSJdLCJjbGllbnRJZCuIiwic2NvcGUiOlsiYWxsIl0sInRlbmFudElkIjoiYETYaW4iLCJleHAiOjE2NTkzNDg1MDMsImp0aSI6ImJkNGIzYjM5LTE2YjUtNGI2CDHHFD0MzE5NmQwODYzNCIsImNsaWVudF9pZCI6ImFkbWluIn0.bnVicynphOCCb39Nr7FC5OkZR16exdWp7DofUiivW_LmqNEb0t5U4h4wtJT9mEfVoOpBOIZgri8PHqACnG9mFazFFtrw4eSE2W42rRJYfnCUgWqu1y-dwOaLhILYT8yOs2inKf6IMUn7TgLJmzkBlhKBuwlIJO_NdK7PLrztPPc",
"expiresIn": 7199
}
}