Create an account

Client version1.8.0 (latest)1.7.0Version overview

POST

Example base URLhttp://local.zhongyibrowser.com:39025http://127.0.0.1:39025/api/v1/accounts

Create a preset or custom account using an existing account platform ID, and return full account details on success. The account platform must match type.

Request parameters

Authorization Bearer Token

Include your API Key as a Bearer token in the Authorization request header.

Authorization: Bearer <api-key>

Body parameters

requiredRequest content typeapplication/jsonAccountCreateRequest

Fields

›stringrequired

Account platform type: preset means a system preset platform; custom means a user-defined platform.

Enum

›stringrequired

Account platform ID; must match type

minLength: 1

›string | null

Account display name; null clears the value

maxLength: 255

›string | null

Login username; null clears the value

maxLength: 255

›string | null

Login password; null clears the value

maxLength: 255

›string | null

Two-step verification secret; null clears the value

maxLength: 255

›string | null

Account notes; null clears the value

maxLength: 5000

Example

Generated from the schema; not a live response.

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

Request code examples

JavaScript / TypeScript: Node.js 18+ with fetch; PHP: cURL extension; Go: 1.16+; Java: JDK 11+. Replace the token and example parameter values before running.

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'

fetch("http://local.zhongyibrowser.com:39025/api/v1/accounts", {
  method: "POST",
  headers: {
      "Authorization": "Bearer <TOKEN>",
      "Content-Type": "application/json"
    },
  body: "{\n  \"type\": \"preset\",\n  \"platform_id\": \"string\"\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  \"type\": \"preset\",\n  \"platform_id\": \"string\"\n}"
  }
  const response: Response = await fetch("http://local.zhongyibrowser.com:39025/api/v1/accounts", 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/accounts');
curl_setopt_array($ch, [
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => [
    'Authorization: Bearer <TOKEN>',
    'Content-Type: application/json',
  ],
  CURLOPT_POSTFIELDS => '{
  "type": "preset",
  "platform_id": "string"
}',
]);

$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/accounts", strings.NewReader(`{
  "type": "preset",
  "platform_id": "string"
}`))
	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" +
        "  \"type\": \"preset\",\n" +
        "  \"platform_id\": \"string\"\n" +
        "}";
    HttpClient client = HttpClient.newHttpClient();
    HttpRequest request = HttpRequest.newBuilder()
        .uri(URI.create("http://local.zhongyibrowser.com:39025/api/v1/accounts"))
        .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/accounts"
headers = {
    "Authorization": "Bearer <TOKEN>",
    "Content-Type": "application/json"
}
data = "{\n  \"type\": \"preset\",\n  \"platform_id\": \"string\"\n}"

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

Responses

Success: code = 0. Failure: code > 0. Select a status to view its fields and example. Expand objects to inspect nested fields. Optional fields may be omitted.

Details of the created account

Body

Response content typeapplication/jsonAccountDetailSuccessResponse

Fields

›numberrequired

Business status code; always 0 on success

Enum

›stringrequired

Business status message; always success on success

Enum

›objectrequired

Endpoint business data

Additional fields are not allowed.

Example

Generated from the schema; not a live response.

{
  "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"
    ]
  }
}

View all business error codes and HTTP statuses