企业级网关注册接口
注册企业网关实例的请求参数、响应结构和调用示例。
企业级网关注册接口
接口参考待联调:当前完整开通流程包含企业命名,而这份旧接口资料没有名称字段;该接口是否只是初始化子步骤、当前请求地址及登录方式仍待核准。 以下是待核对的接口资料,不作为可直接接入的正式示例。控制台操作请按对应使用指南完成。
1. 接口概述
该接口使用已登录用户的登录 Token 注册并初始化企业级网关服务。这里的接口认证指登录身份校验,不是个人实名或企业认证。调用成功后,系统会为该用户分配独立的渠道表和模型表。
- 接口名称: 注册企业级网关
- 接口路径:
/enterprise_gateway/registry - 请求方式:
POST - Content-Type:
application/json
2. 请求参数
2.1 Header 参数
| 参数名 | 必选 | 类型 | 说明 | 示例 |
|---|---|---|---|---|
| Authorization | 是 | string | 用户认证 Token (Bearer Token) | Bearer YOUR_ACCESS_TOKEN |
2.2 Body 参数
该接口不需要请求体参数。用户信息将从 Header 中的 Token 解析获取。
3. 返回参数
返回数据为 JSON 格式。
3.1 成功响应
HTTP 状态码: 200
| 参数名 | 类型 | 说明 |
|---|---|---|
| code | int | 业务状态码,0 表示成功 |
| msg | string | 提示信息 |
| data | object | 返回的数据对象 |
| channel_table_name | string | 分配的渠道表名称 |
| channel_models_table_name | string | 分配的渠道模型表名称 |
| is_new_created | bool | 是否为新创建 (true: 新创建, false: 已存在) |
3.2 失败响应
HTTP 状态码: 200 (业务逻辑错误) 或其他 HTTP 错误码
| 参数名 | 类型 | 说明 |
|---|---|---|
| code | int | 错误码 (如 50000) |
| msg | string | 错误描述信息 |
| data | null | 无数据 |
4. 调用示例
4.1 cURL 示例
curl -X POST 'YOUR_GATEWAY_BASE_URL/enterprise_gateway/registry' \
-H 'Authorization: Bearer <YOUR_ACCESS_TOKEN>' \
-H 'Content-Type: application/json'
4.2 成功响应示例
{
"code": 0,
"data": {
"channel_table_name": "channel_1001",
"channel_models_table_name": "channel_models_1001",
"is_new_created": true
},
"msg": "注册成功"
}
4.3 失败响应示例
{
"code": 50000,
"data": null,
"msg": "注册失败: 数据库连接异常"
}