跳转到内容
Local API平台账号

创建账号 ​

版本概览
POST
/api/v1/accounts

使用已有账号平台 ID 创建 preset 或 custom 账号,成功后直接返回完整账号详情。账号平台必须与 type 对应。

请求参数

Authorization Bearer Token

在请求头 Authorization 中使用 Bearer Token 传入 API Key。

Authorization: Bearer <api-key>

Body 参数

必填application/jsonAccountCreateRequest
字段说明
string必填
账号平台类型:preset 表示系统预设平台;custom 表示用户自定义平台
枚举值
string必填
账号平台 ID,必须与 type 对应
minLength: 1
string | null
账号显示名称;null 表示清空
maxLength: 255
string | null
登录用户名;null 表示清空
maxLength: 255
string | null
登录密码;null 表示清空
maxLength: 255
string | null
两步验证密钥;null 表示清空
maxLength: 255
string | null
账号备注;null 表示清空
maxLength: 5000
示例

根据数据模型生成,非实际请求结果。

{
  "type": "preset",
  "platform_id": "string"
}

请求示例代码

JavaScript / TypeScript 使用 Node.js 18+ 内置 fetch;PHP 需启用 cURL 扩展;Go 需 1.16+;Java 需 JDK 11+。运行前请替换 Token 和示例参数值。

curl -X POST -H 'Authorization: Bearer <TOKEN>' -H 'Content-Type: application/json' -d '{
  "type": "preset",
  "platform_id": "string"
}' 'http://local.zhongyibrowser.com:39025/api/v1/accounts'

返回响应

成功时 code = 0,失败时 code > 0。选择状态码查看对应字段和示例,展开对象可查看嵌套字段;可选字段可能不返回。

创建后的账号详情

Body

application/jsonAccountDetailSuccessResponse
字段说明
number必填
业务状态码;成功固定为 0
枚举值
string必填
业务状态信息;成功固定为 success
枚举值
object必填
接口业务数据

不允许额外字段。

示例

根据数据模型生成,非实际请求结果。

{
  "code": 0,
  "message": "success",
  "data": {
    "id": "account_01JABCDEF1234567890",
    "type": "preset",
    "name": "string",
    "username": "string",
    "password": "string",
    "twofa_key": "string",
    "remark": "string",
    "owner": "string",
    "editable": true,
    "platform": {
      "id": "string",
      "website": "string",
      "icon_url": "string",
      "platform_code": "string",
      "platform_name": "string",
      "category_code": "string",
      "category_name": "string",
      "region_code": "string",
      "region_name": "string"
    },
    "browser_count": 0,
    "created_at": "2024-01-15T09:30:00Z",
    "updated_at": "2024-01-15T09:30:00Z",
    "browser_ids": [
      "env_01JABCDEF1234567890"
    ]
  }
}

查看全部业务错误码与 HTTP 状态码

中屹浏览器 Local API 文档