跳转到内容
Local API平台账号

创建自定义账号平台 ​

版本概览
POST
/api/v1/account-platforms

为当前用户创建一个自定义账号平台。website 必须是包含 http:// 或 https:// 协议的有效网址;同一用户不能重复创建相同网址。接口不支持创建系统预设平台。

请求参数

Authorization Bearer Token

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

Authorization: Bearer <api-key>

Body 参数

必填application/jsonAccountPlatformCreateRequest
字段说明
string必填
自定义平台网址,必须包含 http:// 或 https:// 协议
示例值"https://example.com"
format: "uri"maxLength: 500
示例

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

{
  "website": "https://example.com"
}

请求示例代码

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 '{
  "website": "https://example.com"
}' 'http://local.zhongyibrowser.com:39025/api/v1/account-platforms'

返回响应

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

创建后的自定义账号平台

Body

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

不允许额外字段。

示例

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

{
  "code": 0,
  "message": "success",
  "data": {
    "id": "string",
    "type": "preset",
    "website": "string",
    "icon_url": "string",
    "platform_code": "string",
    "platform_name": "string",
    "category": {
      "code": "string",
      "name": "string"
    },
    "region": {
      "code": "string",
      "name": "string"
    }
  }
}

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

中屹浏览器 Local API 文档