创建代理

POST

/api/v1/proxies

创建 custom 或 api 代理并返回创建后的完整详情。API 代理需提供 auth_type（缺省为 whitelist）；选择 credential 时 username、password 均必填。Local API 会在本机解析当前 IP 和端口；integ、syt 不能通过该接口创建。用户名、密码和提取地址属于敏感字段，不应写入调用方日志。

请求参数

Authorization Bearer Token

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

Authorization: Bearer <api-key>

Body 参数

必填application/jsonProxyCreateRequest

字段说明

object

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

{
  "name": "string",
  "mode": "custom",
  "config": {
    "host": "string",
    "port": 0
  }
}

请求示例代码

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 '{
  "name": "string",
  "mode": "custom",
  "config": {
    "host": "string",
    "port": 0
  }
}' 'http://local.zhongyibrowser.com:39025/api/v1/proxies'

fetch("http://local.zhongyibrowser.com:39025/api/v1/proxies", {
  method: "POST",
  headers: {
      "Authorization": "Bearer <TOKEN>",
      "Content-Type": "application/json"
    },
  body: "{\n  \"name\": \"string\",\n  \"mode\": \"custom\",\n  \"config\": {\n    \"host\": \"string\",\n    \"port\": 0\n  }\n}",
})
  .then((response) => response.json())
  .then((data) => console.log(data))

async function main(): Promise<void> {
  const options: RequestInit = {
    "method": "POST",
    "headers": {
      "Authorization": "Bearer <TOKEN>",
      "Content-Type": "application/json"
    },
    "body": "{\n  \"name\": \"string\",\n  \"mode\": \"custom\",\n  \"config\": {\n    \"host\": \"string\",\n    \"port\": 0\n  }\n}"
  }
  const response: Response = await fetch("http://local.zhongyibrowser.com:39025/api/v1/proxies", options)
  const data: unknown = await response.json()
  console.log(data)
}

main().catch(console.error)

<?php
$ch = curl_init('http://local.zhongyibrowser.com:39025/api/v1/proxies');
curl_setopt_array($ch, [
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => [
    'Authorization: Bearer <TOKEN>',
    'Content-Type: application/json',
  ],
  CURLOPT_POSTFIELDS => '{
  "name": "string",
  "mode": "custom",
  "config": {
    "host": "string",
    "port": 0
  }
}',
]);

$response = curl_exec($ch);
if ($response === false) {
  throw new RuntimeException(curl_error($ch));
}
curl_close($ch);
echo $response . PHP_EOL;

package main

import (
	"fmt"
	"io"
	"log"
	"net/http"
	"strings"
)

func main() {
	req, err := http.NewRequest("POST", "http://local.zhongyibrowser.com:39025/api/v1/proxies", strings.NewReader(`{
  "name": "string",
  "mode": "custom",
  "config": {
    "host": "string",
    "port": 0
  }
}`))
	if err != nil {
		log.Fatal(err)
	}
	req.Header.Set("Authorization", "Bearer <TOKEN>")
	req.Header.Set("Content-Type", "application/json")

	response, err := http.DefaultClient.Do(req)
	if err != nil {
		log.Fatal(err)
	}
	defer response.Body.Close()

	data, err := io.ReadAll(response.Body)
	if err != nil {
		log.Fatal(err)
	}
	fmt.Println(string(data))
}

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Main {
  public static void main(String[] args) throws Exception {
    String body = "{\n" +
        "  \"name\": \"string\",\n" +
        "  \"mode\": \"custom\",\n" +
        "  \"config\": {\n" +
        "    \"host\": \"string\",\n" +
        "    \"port\": 0\n" +
        "  }\n" +
        "}";
    HttpClient client = HttpClient.newHttpClient();
    HttpRequest request = HttpRequest.newBuilder()
        .uri(URI.create("http://local.zhongyibrowser.com:39025/api/v1/proxies"))
        .header("Authorization", "Bearer <TOKEN>")
        .header("Content-Type", "application/json")
        .method("POST", HttpRequest.BodyPublishers.ofString(body))
        .build();

    HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
    System.out.println(response.body());
  }
}

import requests

url = "http://local.zhongyibrowser.com:39025/api/v1/proxies"
headers = {
    "Authorization": "Bearer <TOKEN>",
    "Content-Type": "application/json"
}
data = "{\n  \"name\": \"string\",\n  \"mode\": \"custom\",\n  \"config\": {\n    \"host\": \"string\",\n    \"port\": 0\n  }\n}"

response = requests.post(url, headers=headers, data=data)
print(response.json())

返回响应

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

创建后的代理详情

Body

application/jsonProxyDetailSuccessResponse

字段说明

number必填

业务状态码；成功固定为 0

枚举值

string必填

业务状态信息；成功固定为 success

枚举值

object必填

接口业务数据

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

{
  "code": 0,
  "message": "success",
  "data": {
    "id": "string",
    "name": "string",
    "remark": "string",
    "status": "unchecked",
    "checked_at": "2024-01-15T09:30:00Z",
    "browser_count": 0,
    "is_expired": true,
    "created_at": "2024-01-15T09:30:00Z",
    "updated_at": "2024-01-15T09:30:00Z",
    "mode": "custom",
    "config": {
      "protocol": "http",
      "ip_protocol": "ipv4",
      "host": "string",
      "port": 0,
      "username": "string",
      "password": "string"
    },
    "browser_ids": [
      "env_01JABCDEF1234567890"
    ]
  }
}

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

创建代理 ​

请求参数

请求示例代码

返回响应

创建代理