渠道合作商开户

简介

TorchV在v1.8.4的版本中，增加了对渠道的对接，渠道合作商可以通过该接口，打通当前TorchV的Paas层开租户的能力，通过调用接口的方式，和自己的业务系统进行打通。

接口列表

创建租户

接口地址:/openapi/partner/account/create

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

请求Header：

参数名称	类型	必填	描述
`Content-Type`	string	是	请求的数据格式，目前仅支持 JSON 格式，固定填写"application/json"
`token`	string	是	鉴权Token值，获取方式请参考文档

请求参数:

参数名称	参数说明	是否必须	数据类型
name	租户账号，全局唯一，不唯一的情况，系统会报错	true	string
startTime	开始日期，格式：yyyy-MM-dd ,必须大于等于当日	true	string(date-time)
endTime	结束日期，格式：yyyy-MM-dd，必须大于开始日期	true	string(date-time)
priceLevel	账号的等级，BASIC-基础版(19800/年),STANDARD-标准版(36800/年),PROFESSIONAL-专业版(99800/年)，CUSTOM-渠道合作商自定义类别,标准版参考文档，如果是CUSTOM，那么下面的custom参数需要传递价格和空间	true	string
contact	联系人	false	string
contactTitle	联系人职位	false	string
phone	联系电话	false	string
email	联系邮件	false	string
company	公司名称	false	string
industry	行业	false	string
remark	应用场景	false	string
custom	如果`priceLevel`字段是CUSTOM，那么该参数不能为空参数需要传递价格和空间	false	`Custom`
price	初始化当前账号的金额，单位：元	false	number
space	初始化当前账号的空间大小，单位是MB	false	integer(int32)

请求示例:

{
  "name": "", // 租户账号，全局唯一，不唯一的情况，系统会报错
  "startTime": "", // 开始日期，格式：yyyy-MM-dd ,必须大于等于当日
  "endTime": "", // 结束日期，格式：yyyy-MM-dd，必须大于开始日期
  "priceLevel": "", // 账号的等级，DEFAULT-试用版(0/年),STANDARD-标准版(36800/年),PROFESSIONAL-专业版(99800/年)，CUSTOM-渠道合作商自定义类别，如果是CUSTOM，那么下面的custom参数需要传递价格和空间
  "contact": "", //联系人
  "contactTitle": "", // 联系人职位
  "phone": "", // 电话
  "email": "", // email
  "company": "", // 公司
  "industry": "", // 行业
  "remark": "", // 备注
  // 如果priceLevel字段是CUSTOM，那么该下面的参数必填
  "custom": {
    "price": 5,// 初始化当前账号的金额，单位：元
    "space": 5 // 初始化当前账号的空间大小，单位是MB
  }
}

响应示例:

{
  "code": 8200, //请参考错误编码的完整定义
  "message": "SUCCESS",
  "data": {
    "name": "custom2024092701", //租户账号
    "pwd": "5AjTJt2qP4cG5bAE", // 租户密码，该密码仅在本次创建接口完成后返回
    "code": "1839653718786703360", // 租户编号
    "apps": [ //初始化的应用，主要有两个，一个ChatBot，一个Assistant
      {
        "appid":"", // 应用的appid
        "secret":"", // 应用的secret
        "accessToken":"", // 应用的accessToken
        "category":""  // 应用类型，DEFAULT-默认类型，即ChatBot，ASSISTANT-写作助手(Assistant)
      }
      // more...
    ]  
  }
}

查询租户

接口地址:/openapi/partner/account/query

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

请求Header：

参数名称	类型	必填	描述
`token`	string	是	鉴权Token值，获取方式请参考文档

请求参数:

参数名称	参数说明	是否必须	数据类型
name	账号名称或者租户编码	true	string

响应参数:

参数名称	参数说明	类型
code	状态码	integer(int32)
message		string
data		PartnerAccountInfo
id		integer(int64)
code	租户编码	string
name	账号/租户名称	string
contact	联系人	string
phone	联系电话	string
startTime	开始日期	string(date-time)
endTime	截止日期	string(date-time)
createTime	创建时间	string(date-time)
contactTitle	联系人职位	string
email	所属邮箱	string
company	所属公司	string
remark	备注	string
priceLevel	当前账号的价格等级	string
tokenAmount	token账号总金额	number
useTokenAmount	已经消耗使用的token金额	number
useTokenNumber	已经消耗使用的token数值	integer(int64)
storage	存储空间,单位：byte	integer(int64)
useStorage	已经消耗使用的存储空间,单位：byte	integer(int64)

响应示例:

{
  "code": 8200, // 状态码
  "message": "SUCCESS",
  "data": {
    "id": 322,
    "code": "1840272292647665664", //租户编码
    "name": "custom2024092719", // 租户名称
    "contact": "肖", //联系人
    "phone": "13586552493", //联系电话
    "startTime": 1727539200000,  // 开始时间
    "endTime": 1732982400000, //截止时间
    "createTime": 1727590080000, //创建日期
    "contactTitle": "CTO", //联系人职位
    "email": "xiaoymin@foxmail.com", //email
    "company": "TorchV", //所属公司
    "remark": "", //备注
    "priceLevel": "CUSTOM", //当前账号的价格等级
    "tokenAmount": 10, // token账号总金额
    "useTokenAmount": 0, // 已经消耗使用的token金额
    "useTokenNumber": 0, // 已经消耗使用的token数值
    "storage": 10485760, // 存储空间,单位：byte
    "useStorage": 0 // 已经消耗使用的存储空间,单位：byte
  }
}

租户延期

接口地址:/openapi/partner/account/delay

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

请求Header：

参数名称	类型	必填	描述
`Content-Type`	string	是	请求的数据格式，目前仅支持 JSON 格式，固定填写"application/json"
`token`	string	是	鉴权Token值，获取方式请参考文档

请求示例:

{
  "name": "custom2024092719", // 租户名称或者租户编码
  "endTime": "2024-12-03" // 结束时间，格式：yyyy-MM-dd
}

请求参数:

参数名称	参数说明	是否必须	数据类型
name	账号名称/租户编码	true	string
endTime	截至日期，格式：yyyy-MM-dd	true	string(date-time)

响应参数:

参数名称	参数说明	类型	schema
code	业务编码	integer(int32)	integer(int32)
message	消息	string
data		string

响应示例:


{
  "code": 8200, // 8200代表当前操作成功
  "message": "SUCCESS",
  "data": "更新成功"
}

流量包/金额充值

接口地址:/openapi/partner/account/recharge

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

请求Header：

参数名称	类型	必填	描述
`Content-Type`	string	是	请求的数据格式，目前仅支持 JSON 格式，固定填写"application/json"
`token`	string	是	鉴权Token值，获取方式请参考文档

请求示例:

{
  "name": "custom2024092719", //账号名称/租户编码
  "category": "STORAGE_ADD", // 充值类型，INCREMENT-增值资源包，STORAGE_ADD-存储扩容包
  "size": 10, // 资源包值，根据category类别来区分，如果是INCREMENT，那么该值是金额，如果是STORAGE_ADD,那么该值是上传流量空间
  "storageUnit": "MB" //流量包单位，类型：MB、GB,仅在category类型是`STORAGE_ADD`时生效。
}

请求参数:

参数名称	参数说明	是否必须	数据类型
name	账号名称/租户编码	true	string
category	INCREMENT-增值资源包，STORAGE_ADD-存储扩容包	true	string
size	资源包大小，按category类别来区分，如果是INCREMENT，那么该值是金额，如果是STORAGE_ADD,那么该值是上传流量空间	true	integer(int64)
storageUnit	流量包单位，类型：MB、GB,仅在category类型是`STORAGE_ADD`时生效。	true	string

响应参数:

参数名称	参数说明	类型
code	业务编码	integer(int32)
message	消息	string
data		string

响应示例:


{
  "code": 8200,// 8200代表当前操作成功
  "message": "SUCCESS",
  "data": "SUCCESS"
}

简介​

接口列表​

创建租户​

查询租户​

租户延期​

流量包/金额充值​

简介

接口列表

创建租户

查询租户

租户延期

流量包/金额充值