OpenAPI

A chave de autenticação app_key pode ser encontrada na página inicial da sua central de usuário após o login.

Por favor, guarde a chave de forma segura, pois ela possui permissões de administrador da sua conta.

URLs base:

Autenticação

Gerenciamento de conta de agente

GET Lista de contas de proxy

GET /openapi/whitelist-account/list

Exemplo de retorno

Resposta 200

{
	"code": 200,
	"msg": "string",
	"data": {
		"list": [
			{
				"id": 0,
				"username": "string",
				"password": "string",
				"created_at": "string",
				"remark": "string",
				"product_type": 9,
				"usage_flow": 0,
				"limit_flow": 102400,
				"status": 0
			}
		]
	}
}

Resultado de retorno

Código de status	Significado do código de status	Descrição	Modelo de dados
200	OK	Solicitação bem-sucedida	Em linha

Estrutura de dados de retorno

Código de status 200

Nome	Tipo	Obrigatório	Restrição	Explicação
» code	responseCode	false	nenhum	Código de status, 200 sucesso, 3 app_key inválido
» msg	string	falso	nenhum	Mensagem de status
» dados	objeto	falso	nenhum	nenhum
»» lista	[objeto]	falso	nenhum	nenhum
»»» id	inteiro	falso	nenhum	Número da conta
»»» nome de usuário	string	falso	nenhum	Nome da conta proxy
»»» senha	string	false	none	Senha da conta proxy
»»» created_at	string	false	none	Adicionado em
»»» observação	string	falso	nenhum	Observações
»»» product_type	productTypes	falso	nenhum	Tipo de pacote, 9 Pacote de tráfego residencial dinâmico, 11 IP residencial dinâmico, 14 IP de data center estático, 25 IP residencial estático
»»» usage_flow	inteiro	falso	nenhum	Tráfego usado, unidade: KB
»»» limit_flow	inteiro	falso	nenhum	Limite de tráfego personalizado: unidade GB, máximo de 102400, 0 para ilimitado
»»» status	inteiro	falso	nenhum	Status ativado: 1 ativado, 0 desativado

Valores de enumeração

Atributos	Valor
product_type	9
product_type	11
product_type	14
product_type	25

POST Adiciona uma conta de proxy.

POST /openapi/whitelist-account/add

Parâmetros do corpo da requisição

{
	"app_key": "stringstringstringstringstringst",
	"accounts": "user01:pass,user02:pass,user03:pass",
	"remark": "",
	"product_type": 9
}

Parâmetros de solicitação

Nome	Localização	Tipo	Obrigatório	Descrição
body	body	objeto	Não	nenhum
» app_key	corpo	string	Não	Chave de autorização
» contas	corpo	string	Não	Senha da conta, preencha no formato username:password. A conta e a senha aceitam apenas números e letras. É proibido inserir quaisquer símbolos especiais ou espaços. Use dois pontos para separar a conta e a senha. Suporta adição em lote, contas de proxy separadas por vírgula (,) em inglês.
» observação	corpo	string	Não	Descrição da conta do agente
» product_type	body	productTypes	Não	Tipo de pacote, 9 Pacote de tráfego residencial dinâmico, 11 IP residencial dinâmico, 14 IP de data center estático, 25 IP residencial estático

Valor de enumeração

Atributo	Valor
» product_type	9
» product_type	11
» product_type	14
» product_type	25

Exemplo de retorno

Resposta 200

{
	"code": 200,
	"msg": "string",
	"data": null
}

Resultado Retornado

Código de Status	Significado do Código de Status	Descrição	Modelo de dados
200	OK	Solicitação bem-sucedida	Embutido

Estrutura de dados de retorno

Código de status 200

Nome	Tipo	Obrigatório	Restrições	Descrição
» code	inteiro	falso	nenhum	Código de status, 200 Sucesso, 3 app_key inválido, 156 Conta não autenticada com nome real
» msg	string	false	none	Mensagem de status
» data	nulo	falso	nenhum	nenhum

POST Remover Conta Proxy

POST /openapi/whitelist-account/delete

Observe que a exclusão é irreversível e o tráfego usado, etc., não pode ser consultado. A exclusão tem um tempo de espera de cerca de 5 minutos, durante o qual ainda podem ser geradas cobranças.

Parâmetros de solicitação do corpo

{
	"app_key": "stringstringstringstringstringst",
	"accounts": "user01,user02"
}

Parâmetros de solicitação

Nome	Localização	Tipo	Obrigatório	Descrição
corpo	corpo	objeto	Não	nenhum
» app_key	body	string	Não	Chave de autorização
» accounts	body	string	Não	Contas de agente, apenas números e letras são permitidos. Suporta operações em lote, contas de agente separadas por vírgula (,) em inglês

Exemplo de retorno

Resposta 200

{
	"code": 200,
	"msg": "string",
	"data": null
}

Resultado Retornado

Código de Status	Significado do Código de Status	Explicação	Modelo de dados
200	OK	Solicitar para	Em linha

Estrutura de dados de retorno

Código de status 200

Nome	Tipo	Obrigatório	Restrição	Descrição
» código	inteiro	falso	nenhum	Códigos de status: 200 Sucesso, 3 app_key inválido, 156 Conta não autenticada com nome real
» msg	string	false	nenhum	Mensagem de status
» data	nulo	falso	nenhum	nenhum

POST desativou contas de proxy

POST /openapi/whitelist-account/disable

A desativação tem um tempo de espera de aproximadamente 5 minutos, durante o qual ainda podem ser geradas cobranças.

Parâmetros do corpo da requisição

{
	"app_key": "stringstringstringstringstringst",
	"accounts": "user01,user02"
}

Parâmetros da requisição

Nome	Localização	Tipo	Obrigatório	Explicação
corpo	corpo	objeto	Não	nenhum
» app_key	corpo	string	Não	Chave de autorização
» accounts	corpo	string	Não	Conta de agente, suporta apenas números e letras. Suporta operação em lote, contas de agente separadas por vírgula (,) em inglês

Exemplo de retorno

Resposta 200

{
	"code": 200,
	"msg": "string",
	"data": null
}

Resultado de retorno

Código de status	Significado do código de status	Descrição	Modelo de dados
200	OK	Solicitação como	Em linha

Estrutura de dados de retorno

Código de status 200

Nome	Tipo	Obrigatório	Restrição	Explicação
» code	inteiro	falso	nenhum	Código de status, 200 sucesso, 3 app_key inválido, 156 conta não autenticada
» msg	string	falso	nenhum	Mensagem de status
» dados	nulo	falso	nenhum	nenhum

POST Habilitar conta de proxy

POST /openapi/whitelist-account/enable

Parâmetros do corpo da requisição

{
	"app_key": "stringstringstringstringstringst",
	"accounts": "user01,user02"
}

Parâmetros da requisição

Nome	Localização	Tipo	Obrigatório	Explicação
corpo	corpo	objeto	Não	nenhum
» app_key	corpo	string	Não	Chave de autorização
» accounts	corpo	string	Não	Conta de agente, suporta apenas números e letras. Suporta operação em lote, contas de agente separadas por vírgula (,) em inglês

Exemplo de retorno

Resposta 200

{
	"code": 200,
	"msg": "string",
	"data": null
}

Resultado de retorno

Código de status	Significado do código de status	Descrição	Modelo de dados
200	OK	Solicitação como	Em linha

Estrutura de dados de retorno

Código de status 200

Nome	Tipo	Obrigatório	Restrição	Explicação
» code	inteiro	falso	nenhum	Código de status, 200 sucesso, 3 app_key inválido, 156 conta não autenticada
» msg	string	falso	nenhum	Mensagem de status
» dados	nulo	falso	nenhum	nenhum

POST Modificar a senha da conta de proxy

POST /openapi/whitelist-account/change-password

Observe que há um tempo de espera de 5 minutos após a modificação, durante o qual a senha antiga ainda pode ser usada normalmente.

Parâmetros do corpo da requisição

{
	"app_key": "stringstringstringstringstringst",
	"account": "user",
	"password": "pass"
}

Parâmetros de solicitação

Nome	Localização	Tipo	Obrigatório	Descrição
body	body	objeto	Não	nenhum
» app_key	corpo	string	Não	Chave de autorização
» conta	corpo	string	Não	Contas de agente, suportam apenas números e letras.
» senha	corpo	string	Não	Nova senha da conta de agente, suporta apenas números e letras.

Exemplo de retorno

Resposta 200

{
	"code": 200,
	"msg": "string",
	"data": null
}

Resultado Retornado

Código de Status	Significado do Código de Status	Explicação	Modelo de dados
200	OK	Solicitar como	Embutido

Estrutura de dados de retorno

Código de status 200

Nome	Tipo	Obrigatório	Restrições	Descrição
» code	inteiro	falso	nenhum	Código de status, 200 Sucesso, 3 app_key inválido, 156 Conta não autenticada
» msg	string	false	none	Mensagem de status
» data	nulo	falso	nenhum	nenhum

POST Modificar observação da conta de proxy

POST /openapi/whitelist-account/change-remark

Parâmetros do corpo da requisição

{
	"app_key": "stringstringstringstringstringst",
	"account": "user",
	"remark": ""
}

Parâmetros da requisição

Nome	Localização	Tipo	Obrigatório	Descrição
body	corpo	objeto	Não	nenhum
» app_key	corpo	string	Não	Chave de autorização
» account	body	string	Não	Contas de agente, apenas números e letras são permitidos.
» observação	corpo	string	Não	Nova observação da conta do agente, até 32 caracteres chineses ou 64 caracteres ingleses.

Exemplo de retorno

Resposta 200

{
	"code": 200,
	"msg": "string",
	"data": null
}

Resultado de retorno

Código de status	Significado do código de status	Explicação	Modelo de dados
200	OK	Solicitação como	Embutido

Estrutura de dados de retorno

Código de status 200

Nome	Tipo	Obrigatório	Restrição	Descrição
» código	inteiro	falso	nenhum	Códigos de status: 200 Sucesso, 3 app_key inválido, 156 Conta não autenticada com nome real
» msg	string	false	nenhum	Mensagem de status
» data	nulo	falso	nenhum	nenhum

POST Modificar o limite de tráfego da conta de proxy

POST /openapi/whitelist-account/change-limit

Por favor, note que as estatísticas de tráfego podem ter um atraso de até 5 minutos, o que significa que o consumo real de tráfego pode exceder este limite.

Parâmetros do corpo da requisição

{
	"app_key": "stringstringstringstringstringst",
	"account": "user",
	"limit": 0
}

Parâmetros da requisição

Nome	Localização	Tipo	Obrigatório	Descrição
body	corpo	objeto	Não	nenhum
» app_key	corpo	string	Não	Chave de autorização
» conta	corpo	string	Não	Contas de agente, apenas números e letras são permitidos.
» limit	body	inteiro	Não	Limite de tráfego, unidade: GB, 0 para ilimitado

Exemplo de retorno

Resposta 200

{
	"code": 200,
	"msg": "string",
	"data": null
}

Resultado de retorno

Código de status	Significado do código de status	Explicação	Modelo de dados
200	OK	Solicitar como	Em linha

Estrutura de dados de retorno

Código de status 200

Nome	Tipo	Obrigatório	Restrição	Descrição
» código	inteiro	falso	nenhum	status code, 200 sucesso, 3 app_key inválido, 156 conta não autenticada com nome real
» msg	string	false	nenhum	Mensagem de status
» data	nulo	falso	nenhum	nenhum

Consulta de logs de tráfego

GET Uso de tráfego agregado por dia

GET /openapi/user-usage-flow/total

Parâmetros da requisição

Nome	Localização	Tipo	Obrigatório	Descrição
app_key	consulta	string(senha)	Sim	Chave de autenticação
horário_de_início	consulta	string(A-m-d H:i:s)	Não	Tempo de início, com precisão de segundos. Observe que os logs têm um atraso de até 5 minutos. O padrão é dentro de 7 dias.
end_time	query	string(Y-m-d H:i:s)	Não	Data e hora de término, com precisão de segundos. Observe que há um atraso de até 5 minutos no registro. O padrão é a hora atual.
username	query	string	否	Nome da subconta. Por padrão, consulta todas as contas, mas você pode especificar uma subconta. Observe que, se você adicionar subcontas com o mesmo nome, esta consulta retornará todos os registros de uso da conta de agente com o mesmo nome.
product_type	consulta	número	Não	Tipo de pacote

Exemplo de retorno

Resposta 200

{
	"code": 200,
	"msg": "string",
	"data": {
		"list": [
			{
				"day": "2022-08-01",
				"flow": 0
			}
		]
	}
}

Resultado de retorno

Código de status	Significado do código de status	Descrição	Modelo de dados
200	OK	Solicitação como	Em linha

Estrutura de dados de retorno

Código de status 200

Nome	Tipo	Obrigatório	Restrição	Explicação
» code	inteiro	falso	nenhum	Código de status, 200 sucesso, 3 app_key inválido, 156 conta não autenticada
» msg	string	falso	nenhum	Mensagem de status
» dados	objeto	falso	nenhum	nenhum
»» lista	[objeto]	falso	nenhum	nenhum
»»» dia	string	falso	nenhum	Data
»»» fluxo	inteiro	falso	nenhum	Consumo de dados, unidade: KB

Consulta de Pacotes

GET Lista de pacotes comprados

GET /openapi/user-product/list

Parâmetros da requisição

Nome	Localização	Tipo	Obrigatório	Descrição
app_key	consulta	string(senha)	Sim	Chave de autenticação
trade_no	query	string	Não	Número do pedido. Insira o número do pedido completo. A pesquisa difusa não é compatível.
página	consulta	número	Não	Paginação, padrão: 1
size	query	Número	Não	Quantidade de itens por página, padrão: 20
product_type	consulta	número	Não	Tipo de pacote

Exemplo de retorno

Resposta 200

{
	"code": 200,
	"msg": "string",
	"data": {
		"list": [
			{
				"id": 0,
				"created_at": "2022-05-13 12:14:15",
				"expired_at": "2022-05-13 12:14:15",
				"product_type": 9,
				"trade_no": "2022051312134339861461465434",
				"order": {
					"created_at": "2022-05-13 12:13:43",
					"pay_at": "2022-05-13 12:13:43",
					"title": "入门级"
				}
			}
		],
		"page": 1,
		"page_size": 20,
		"total_count": 0,
		"total_page": 0
	}
}

Resultado de retorno

Código de status	Significado do código de status	Descrição	Modelo de dados
200	OK	Solicitação como	Em linha

Estrutura de dados de retorno

Código de status 200

Nome	Tipo	Obrigatório	Restrição	Explicação
» code	inteiro	falso	nenhum	Código de status, 200 sucesso, 3 app_key inválido, 156 conta não autenticada com nome real
» msg	string	falso	nenhum	Mensagem de status
» dados	objeto	falso	nenhum	nenhum
»» lista	[objeto]	falso	nenhum	nenhum
»»» id	inteiro	falso	nenhum	Número do Pacote
»»» created_at	string	falso	nenhum	Tempo de ativação do pacote
»»» expired_at	string	false	none	Tempo de expiração do pacote, o tráfego não pode ser usado após a expiração.
»»» tipo_de_produto	tiposDeProduto	falso	nenhum	Tipos de pacote, pacote de tráfego residencial dinâmico 9, IP residencial dinâmico 11, IP de data center estático 14, IP residencial estático 25
»»» trade_no	string	false	nenhum	Número de transação do pedido
»»» pedido	objeto	falso	nenhum	nenhum
»»»» created_at	string	false	none	Data de criação do pedido
»»»» pay_at	string	false	none	Tempo de pagamento do pedido
»»»» título	string	false	nenhum	Descrição do pedido
»» página	inteiro	falso	nenhum	Página atual
»» page_size	inteiro	falso	nenhum	Tamanho da página
»» total_count	inteiro	falso	nenhum	Quantidade total de registros
»» total_page	inteiro	falso	nenhum	Número total de páginas

Valores de enumeração

Atributos	Valor
product_type	9
product_type	11
product_type	14
product_type	25

Extração de IP

GET Extrair IP

GET /openapi/ip/v3

Parâmetros de solicitação

Nome	Localização	Tipo	Obrigatório	Descrição
app_key	query	string(senha)	Não	Chave de acesso
cc	consulta	string	Não	País ou região
estado	consulta	string	Não	Estado ou província
cidade	consulta	string	Não	Cidade
format	query	string	Não	Obter formato
lb	consulta	string	Não	Separador, válido apenas para o formato text
num	query	número	Não	Extrair quantidade
vida	consulta	número	Não	Manter ciclo - minutos
ep	query	string	Não	Rede de proxies

Exemplo de retorno

Resposta 200

{
	"code": 200,
	"msg": "string",
	"data": {
		"list": [
			[
				"150.109.114.72:1140",
				"150.109.114.72:1141",
				"150.109.114.72:1142",
				"150.109.114.72:1143",
				"150.109.114.72:1144",
				"150.109.114.72:1145",
				"150.109.114.72:1146",
				"150.109.114.72:1147",
				"150.109.114.72:1148",
				"150.109.114.72:1149"
			]
		]
	}
}

Resultado Retornado

Código de Status	Significado do Código de Status	Explicação	Modelo de dados
200	OK	Solicitação como	Embutido

Estrutura de dados de retorno

Código de status 200

Nome	Tipo	Obrigatório	Restrição	Descrição
» código	inteiro	falso	nenhum	status code, 200 sucesso, 3 app_key inválido, 156 conta não autenticada com nome real
» msg	string	false	nenhum	Mensagem de status
» data	objeto	falso	nenhum	nenhum
»» lista	[qualquer]	falso	nenhum	nenhum

GET Lista de cidades

GET /openapi/ip/dynamic-citys

Exemplo de retorno

Resposta 200

{
	"code": 200,
	"msg": "string",
	"data": {
		"list": [
			{
				"name_zh_cn": "美国",
				"name_en": "United States",
				"continent_code": "NA",
				"country_code": "US",
				"items": [
					{
						"city": null,
						"state": null,
						"continent_code": null,
						"country_code": null
					}
				]
			}
		]
	}
}

Resultado Retornado

Código de Status	Significado do Código de Status	Descrição	Modelo de dados
200	OK	Solicitar como	Embutido

Estrutura de dados de retorno

Código de status 200

Nome	Tipo	Obrigatório	Restrições	Descrição
» code	inteiro	falso	nenhum	Código de status, 200 Sucesso, 3 app_key inválido, 156 Conta não autenticada
» msg	string	false	none	Mensagem de status
» data	objeto	falso	nenhum	nenhum
»» lista	[objeto]	falso	nenhum	Lista
»»» name_zh_cn	string	false	none	Nome do país ou região
»»» name_en	string	false	none	Nome do país ou região
»»» continent_code	string	false	nenhum	Código do continente
»»» country_code	string	falso	nenhum	Código do país ou região
»»» itens	[objeto]	falso	nenhum	Província ou estado
»»»» cidade	string	false	none	Nome da cidade
»»»» estado	string	false	nenhum	Código do nome do estado ou província
»»»» continent_code	string	falso	nenhum	Código do continente
»»»» código_do_país	string	false	none	Código do país ou região

GET Busca de Cidades

GET /openapi/ip/dynamic-citys/search

Parâmetros de Requisição

Nome	Localização	Tipo	Obrigatório	Descrição
código_do_país	consulta	string	é	Código do país ou região
estado	consulta	string	Sim	Código do estado ou província

Exemplo de retorno

Resposta 200

{
	"code": 200,
	"msg": "string",
	"data": {
		"list": ["string"]
	}
}

Resultado Retornado

Código de Status	Significado do Código de Status	Descrição	Modelo de dados
200	OK	Solicitar como	Embutido

Estrutura de dados de retorno

Código de status 200

Nome	Tipo	Obrigatório	Restrições	Descrição
» code	inteiro	falso	nenhum	Código de status, 200 Sucesso, 3 app_key inválido, 156 Conta não autenticada com nome real
» msg	string	false	none	Mensagem de status
» data	objeto	falso	nenhum	nenhum
»» lista	[string]	falso	nenhum	Lista

GET Lista de estados

GET /openapi/ip/dynamic-states

Exemplo de retorno

Resposta 200

{
	"code": 200,
	"msg": "string",
	"data": {
		"list": [
			{
				"name_zh_cn": "美国",
				"name_en": "United States",
				"continent_code": "NA",
				"country_code": "US",
				"items": [
					{
						"state": null,
						"continent_code": null,
						"country_code": null
					}
				]
			}
		]
	}
}

Resultado do retorno

Código de status	Significado do código de status	Descrição	Modelo de dados
200	OK	Solicitação bem-sucedida	Em linha

Estrutura de dados de retorno

Código de status 200

Nome	Tipo	Obrigatório	Restrição	Explicação
» code	inteiro	falso	nenhum	Código de status, 200 sucesso, 3 app_key inválido, 156 conta não autenticada
» msg	string	falso	nenhum	Mensagem de status
» dados	objeto	falso	nenhum	nenhum
»» lista	[objeto]	falso	nenhum	Lista
»»» name_zh_cn	string	false	nenhum	Nome do país ou região
»»» name_en	string	falso	nenhum	Nome do país ou região
»»» continent_code	string	false	none	Código do continente
»»» country_code	string	false	none	Código do país ou região
»»» itens	[objeto]	falso	nenhum	Estado ou província
»»»» estado	string	falso	nenhum	Código do nome do estado ou província
»»»» continent_code	string	falso	nenhum	Código do continente
»»»» código_do_país	string	false	nenhum	Códigos de país/região

GET Pesquisa de estado/província

GET /openapi/ip/dynamic-states/search

Parâmetros de solicitação

Nome	Localização	Tipo	Obrigatório	Explicação
country_code	query	string	Sim	Código do país ou região

Exemplo de retorno

Resposta 200

{
	"code": 200,
	"msg": "string",
	"data": {
		"list": ["string"]
	}
}

Resultado Retornado

Código de Status	Significado do Código de Status	Explicação	Modelo de dados
200	OK	Solicitar como	Embutido

Estrutura de dados de retorno

Código de status 200

Nome	Tipo	Obrigatório	Restrições	Descrição
» code	inteiro	falso	nenhum	Código de status, 200 Sucesso, 3 app_key inválido, 156 Conta não autenticada com nome real
» msg	string	false	none	Mensagem de status
» data	objeto	falso	nenhum	nenhum
»» lista	[string]	falso	nenhum	Lista

GET Obter lista de IPs estáticos

GET /ip/get-static-ip

Parâmetros de requisição

Nome	Localização	Tipo	Obrigatório	Descrição
country_code	consulta	string	Não	Código do país ou região
tipo_de_produto	consulta	número	Não	Tipo de produto, 25: IP residencial estático, 14: IP de data center
trade_no	query	string	Não	Filtrar IP por número de pedido
página	consulta	número	Não	Número da página
tamanho	consulta	número	Não	Quantidade por página
status	query	number	Não	Status, 1: Ativo, 2: Inativo, 3: Expirando, 4: Em manutenção

Valores de enumeração

Atributo	Valor
tipo_de_produto	14
tipo_de_produto	25
status	1
status	2
status	3
status	4

Exemplo de retorno

Resposta 200

{}

Resultado Retornado

Código de Status	Significado do Código de Status	Explicação	Modelo de dados
200	OK	nenhum	Embutido

Estrutura de dados de retorno

Modelo de Dados

productTypes

Tipos de pacote, 9 Pacote de tráfego residencial dinâmico, 11 IP residencial dinâmico, 14 IP de data center estático, 25 IP residencial estático

Atributos

Nome	Tipo	Obrigatório	Restrição	Nome em Chinês	Explicação
anônimo	inteiro	falso	nenhum		Tipo de pacote, 9 Pacote de tráfego residencial dinâmico, 11 IP residencial dinâmico, 14 IP de data center estático, 25 IP residencial estático

Valores de enumeração

Atributo	Valor
anônimo	9
anônimo	11
anônimo	14
anônimo	25

apiKey

null

Chave de API

Nome	Tipo	Obrigatório	Restrição	Nome chinês	Descrição
anônimo	inteiro	falso	nenhum		Código de status, 200 sucesso, 3 app_key inválido

responseMsg

"success"

mensagem de resposta

Atributos

Nome	Tipo	Obrigatório	Restrição	Nome em Chinês	Descrição
anônimo	string	falso	nenhum		mensagem de resposta