ProxyLite OpenAPI

A chave de autenticação app_key pode ser visualizada na página inicial do centro pessoal após o login.

Por favor, guarde a chave com segurança, pois ela possui permissões de administrador da sua conta.

Base URLs:

https://api.proxylite.com

Métodos de Autenticação

Autenticação App Key

Parâmetros POST:

app_key: {your_app_key}

Ou como parâmetro de consulta:

?app_key={your_app_key}

Formato de Resposta

Todas as interfaces retornam um formato JSON uniforme:

{
	"code": 200,
	"message": "操作成功",
	"data": {}
}

code: Código de status, 200 indica sucesso, outros valores indicam falha
message: Mensagem de resposta (em chinês)
data: Dados de resposta

Authentication

Esta interface suporta os seguintes dois métodos de autenticação:

1. Bearer Token (JWT)

Passar o Token através do HTTP Header.

Exemplo de Header:

Authorization: Bearer <your_jwt_token>

Autenticação API Key

Esta interface utiliza o método API Key para verificação de identidade.

O cliente precisa incluir o parâmetro app_key na solicitação, caso contrário a solicitação será rejeitada.

Exemplo:

GET /api/example?app_key=your_app_key

POST /api/example?app_key=your_app_key
Content-Type: application/json

Nome	Tipo	Obrigatório	Restrição	Descrição
» code	responseCode	false	none	Código de status, 200 sucesso, 3 app_key inválido
» msg	string	false	none	Mensagem de status
» data	object	false	none	none
»» list	[object]	false	none	none
»»» id	integer	false	none	Número da conta
»»» username	string	false	none	Nome da conta proxy
»»» password	string	false	none	Senha da conta proxy
»»» created_at	string	false	none	Hora de adição
»»» remark	string	false	none	Observação
»»» product_type	productTypes	false	none	Tipo de plano, 9 Plano 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	integer	false	none	Tráfego usado, unidade: KB
»»» limit_flow	integer	false	none	Limite de tráfego personalizado: unidade GB máximo 102400, 0 sem limite
»»» status	integer	false	none	Status de ativação: 1 ativo, 0 inativo

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

Observe que após a exclusão não é possível recuperar, o tráfego usado e outros dados não podem ser consultados. A exclusão tem um tempo de espera de aproximadamente 5 minutos, durante este período ainda podem ocorrer cobranças.

Parâmetros de Requisição Body

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

Parâmetros de Requisição

Nome	Localização	Tipo	Obrigatório	Descrição
body	body	object	Não	none
» app_key	body	string	Não	Chave de autorização
» accounts	body	string	Não	Contas proxy, suporta apenas números e letras. Suporta operação em lote, separe as contas proxy com vírgula em inglês (,)

Exemplo de Resposta

200 Response

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

Resultado da Resposta

Código de Status	Significado do Código	Descrição	Modelo de Dados
200	OK	Requisição bem-sucedida	Inline

Estrutura de Dados da Resposta

Código de Status 200

Nome	Tipo	Obrigatório	Restrição	Descrição
» code	integer	false	none	Código de status, 200 sucesso, 3 app_key inválido, 156 conta não verificada
» msg	string	false	none	Mensagem de status
» data	null	false	none	none

POST Desativar Conta Proxy

POST /end-point/whitelist-account/disable

A desativação tem um tempo de espera de aproximadamente 5 minutos, durante este período ainda podem ocorrer cobranças.

Parâmetros de Requisição Body

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

Parâmetros de Requisição

Nome	Localização	Tipo	Obrigatório	Descrição
body	body	object	Não	none
» app_key	body	string	Não	Chave de autorização
» accounts	body	string	Não	Contas proxy, suporta apenas números e letras. Suporta operação em lote, separe as contas proxy com vírgula em inglês (,)

Exemplo de Resposta

200 Response

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

Resultado da Resposta

Código de Status	Significado do Código	Descrição	Modelo de Dados
200	OK	Requisição bem-sucedida	Inline

Estrutura de Dados da Resposta

Código de Status 200

Nome	Tipo	Obrigatório	Restrição	Descrição
» code	integer	false	none	Código de status, 200 sucesso, 3 app_key inválido, 156 conta não verificada
» msg	string	false	none	Mensagem de status
» data	null	false	none	none

POST Ativar Conta Proxy

POST /end-point/whitelist-account/enable

Parâmetros de Requisição Body

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

Parâmetros de Requisição

Nome	Localização	Tipo	Obrigatório	Descrição
body	body	object	Não	none
» app_key	body	string	Não	Chave de autorização
» accounts	body	string	Não	Contas proxy, suporta apenas números e letras. Suporta operação em lote, separe as contas proxy com vírgula em inglês (,)

Exemplo de Resposta

200 Response

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

Resultado da Resposta

Código de Status	Significado do Código	Descrição	Modelo de Dados
200	OK	Requisição bem-sucedida	Inline

Estrutura de Dados da Resposta

Código de Status 200

Nome	Tipo	Obrigatório	Restrição	Descrição
» code	integer	false	none	Código de status, 200 sucesso, 3 app_key inválido, 156 conta não verificada
» msg	string	false	none	Mensagem de status
» data	null	false	none	none

POST Alterar Senha da Conta Proxy

POST /end-point/whitelist-account/change-password

Observe que após a alteração há um tempo de espera de 5 minutos, durante este período a senha antiga ainda pode ser usada normalmente.

Parâmetros de Requisição Body

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

Parâmetros de Requisição

Nome	Localização	Tipo	Obrigatório	Descrição
body	body	object	Não	none
» app_key	body	string	Não	Chave de autorização
» account	body	string	Não	Conta proxy, suporta apenas números e letras.
» password	body	string	Não	Nova senha da conta proxy, suporta apenas números e letras.

Exemplo de Resposta

200 Response

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

Resultado da Resposta

Código de Status	Significado do Código	Descrição	Modelo de Dados
200	OK	Requisição bem-sucedida	Inline

Estrutura de Dados da Resposta

Código de Status 200

Nome	Tipo	Obrigatório	Restrição	Descrição
» code	integer	false	none	Código de status, 200 sucesso, 3 app_key inválido, 156 conta não verificada
» msg	string	false	none	Mensagem de status
» data	null	false	none	none

POST Alterar Observação da Conta Proxy

POST /end-point/whitelist-account/change-remark

Parâmetros de Requisição Body

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

Parâmetros de Requisição

Nome	Localização	Tipo	Obrigatório	Descrição
body	body	object	Não	none
» app_key	body	string	Não	Chave de autorização
» account	body	string	Não	Conta proxy, suporta apenas números e letras.
» remark	body	string	Não	Nova observação da conta proxy, até 32 caracteres chineses ou 64 ingleses.

Exemplo de Resposta

200 Response

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

Resultado da Resposta

Código de Status	Significado do Código	Descrição	Modelo de Dados
200	OK	Requisição bem-sucedida	Inline

Estrutura de Dados da Resposta

Código de Status 200

Nome	Tipo	Obrigatório	Restrição	Descrição
» code	integer	false	none	Código de status, 200 sucesso, 3 app_key inválido, 156 conta não verificada
» msg	string	false	none	Mensagem de status
» data	null	false	none	none

POST Alterar Limite de Tráfego da Conta Proxy

POST /end-point/whitelist-account/change-limit

Observe que as estatísticas de tráfego podem ter um atraso de até 5 minutos, ou seja, o tráfego consumido real pode exceder este limite.

Parâmetros de Requisição Body

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

Parâmetros de Requisição

Nome	Localização	Tipo	Obrigatório	Descrição
body	body	object	Não	none
» app_key	body	string	Não	Chave de autorização
» account	body	string	Não	Conta proxy, suporta apenas números e letras.
» limit	body	integer	Não	Limite de tráfego, unidade: GB, 0 para sem limite superior

Exemplo de Resposta

200 Response

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

Resultado da Resposta

Código de Status	Significado do Código	Descrição	Modelo de Dados
200	OK	Requisição bem-sucedida	Inline

Estrutura de Dados da Resposta

Código de Status 200

Nome	Tipo	Obrigatório	Restrição	Descrição
» code	integer	false	none	Código de status, 200 sucesso, 3 app_key inválido, 156 conta não verificada
» msg	string	false	none	Mensagem de status
» data	null	false	none	none

Consulta de Logs de Tráfego

GET Resumo de Tráfego Usado por Dia

GET /end-point/user-usage-flow/total

Parâmetros de Requisição

Nome	Localização	Tipo	Obrigatório	Descrição
app_key	query	string(password)	Sim	Chave de autenticação
start_time	query	string(Y-m-d H:i:s)	Não	Hora de início, pode ser preciso até segundos. Observe que o registro de logs tem um atraso de até 5 minutos. Padrão: últimos 7 dias.
end_time	query	string(Y-m-d H:i:s)	Não	Hora de término, pode ser preciso até segundos. Observe que o registro de logs tem um atraso de até 5 minutos. Padrão: hora atual.
username	query	string	Não	Nome da subconta, padrão consulta todas as contas, pode especificar subconta. Observe que se você adicionou subcontas com o mesmo nome, esta consulta retornará todos os registros de uso de contas proxy com o mesmo nome.
product_type	query	number	Não	Tipo de plano

Exemplo de Resposta

200 Response

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

Resultado da Resposta

Código de Status	Significado do Código	Descrição	Modelo de Dados
200	OK	Requisição bem-sucedida	Inline

Estrutura de Dados da Resposta

Código de Status 200

Nome	Tipo	Obrigatório	Restrição	Descrição
» code	integer	false	none	Código de status, 200 sucesso, 3 app_key inválido, 156 conta não verificada
» msg	string	false	none	Mensagem de status
» data	object	false	none	none
»» list	[object]	false	none	none
»»» day	string	false	none	Data
»»» flow	integer	false	none	Tráfego consumido, unidade: KB

Consulta de Planos

GET Lista de Planos Adquiridos

GET /end-point/user-product/list

Parâmetros de Requisição

Nome	Localização	Tipo	Obrigatório	Descrição
app_key	query	string(password)	Sim	Chave de autenticação
trade_no	query	string	Não	Número do pedido, insira o número completo do pedido. Não suporta busca difusa.
page	query	number	Não	Paginação, padrão: 1
size	query	number	Não	Quantidade de itens por página, padrão: 20
product_type	query	number	Não	Tipo de plano

Exemplo de Resposta

200 Response

{
	"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 da Resposta

Código de Status	Significado do Código	Descrição	Modelo de Dados
200	OK	Requisição bem-sucedida	Inline

Estrutura de Dados da Resposta

Código de Status 200

Nome	Tipo	Obrigatório	Restrição	Descrição
» code	integer	false	none	Código de status, 200 sucesso, 3 app_key inválido, 156 conta não verificada
» msg	string	false	none	Mensagem de status
» data	object	false	none	none
»» list	[object]	false	none	none
»»» id	integer	false	none	Número do plano
»»» created_at	string	false	none	Hora de ativação do plano
»»» expired_at	string	false	none	Hora de expiração do plano, após expirar o tráfego não pode ser usado.
»»» product_type	productTypes	false	none	Tipo de plano, 9 Plano de tráfego residencial dinâmico, 11 IP residencial dinâmico, 14 IP de data center estático, 25 IP residencial estático
»»» trade_no	string	false	none	Número de transação do pedido
»»» order	object	false	none	none
»»»» created_at	string	false	none	Hora de criação do pedido
»»»» pay_at	string	false	none	Hora de pagamento do pedido
»»»» title	string	false	none	Descrição do pedido
»» page	integer	false	none	Página atual
»» page_size	integer	false	none	Tamanho da página
»» total_count	integer	false	none	Quantidade total de registros
»» total_page	integer	false	none	Quantidade total de páginas

Valores de Enumeração

Atributo	Valor
product_type	9
product_type	11
product_type	14
product_type	25

Extração de IP

GET Extrair IP

GET /end-point/ip/v3

Parâmetros de Requisição

Nome	Localização	Tipo	Obrigatório	Descrição
app_key	query	string(password)	Não	Chave de acesso
cc	query	string	Não	País ou região
state	query	string	Não	Província ou estado
city	query	string	Não	Cidade
format	query	string	Não	Formato de obtenção
lb	query	string	Não	Separador, válido apenas para formato text
num	query	number	Não	Quantidade a extrair
life	query	number	Não	Ciclo de manutenção - minutos
ep	query	string	Não	Rede proxy

Exemplo de Resposta

200 Response

{
	"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 da Resposta

Código de Status	Significado do Código	Descrição	Modelo de Dados
200	OK	Requisição bem-sucedida	Inline

Estrutura de Dados da Resposta

Código de Status 200

Nome	Tipo	Obrigatório	Restrição	Descrição
» code	integer	false	none	Código de status, 200 sucesso, 3 app_key inválido, 156 conta não verificada
» msg	string	false	none	Mensagem de status
» data	object	false	none	none
»» list	[any]	false	none	none

GET Lista de Cidades

GET /end-point/ip/dynamic-citys

Exemplo de Resposta

200 Response

{
	"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 da Resposta

Código de Status	Significado do Código	Descrição	Modelo de Dados
200	OK	Requisição bem-sucedida	Inline

Estrutura de Dados da Resposta

Código de Status 200

Nome	Tipo	Obrigatório	Restrição	Descrição
» code	integer	false	none	Código de status, 200 sucesso, 3 app_key inválido, 156 conta não verificada
» msg	string	false	none	Mensagem de status
» data	object	false	none	none
»» list	[object]	false	none	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	none	Código do continente
»»» country_code	string	false	none	Código do país ou região
»»» items	[object]	false	none	Província ou estado
»»»» city	string	false	none	Nome da cidade
»»»» state	string	false	none	Código do nome da província ou estado
»»»» continent_code	string	false	none	Código do continente
»»»» country_code	string	false	none	Código do país ou região

GET Busca de Cidades

GET /end-point/ip/dynamic-citys/search

Parâmetros de Requisição

Nome	Localização	Tipo	Obrigatório	Descrição
country_code	query	string	Sim	Código do país ou região
state	query	string	Sim	Código do estado ou província

Exemplo de Resposta

200 Response

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

Resultado da Resposta

Código de Status	Significado do Código	Descrição	Modelo de Dados
200	OK	Requisição bem-sucedida	Inline

Estrutura de Dados da Resposta

Código de Status 200

Nome	Tipo	Obrigatório	Restrição	Descrição
» code	integer	false	none	Código de status, 200 sucesso, 3 app_key inválido, 156 conta não verificada
» msg	string	false	none	Mensagem de status
» data	object	false	none	none
»» list	[string]	false	none	Lista

GET Lista de Estados

GET /end-point/ip/dynamic-states

Exemplo de Resposta

200 Response

{
	"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 da Resposta

Código de Status	Significado do Código	Descrição	Modelo de Dados
200	OK	Requisição bem-sucedida	Inline

Estrutura de Dados da Resposta

Código de Status 200

Nome	Tipo	Obrigatório	Restrição	Descrição
» code	integer	false	none	Código de status, 200 sucesso, 3 app_key inválido, 156 conta não verificada
» msg	string	false	none	Mensagem de status
» data	object	false	none	none
»» list	[object]	false	none	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	none	Código do continente
»»» country_code	string	false	none	Código do país ou região
»»» items	[object]	false	none	Província ou estado
»»»» state	string	false	none	Código do nome da província ou estado
»»»» continent_code	string	false	none	Código do continente
»»»» country_code	string	false	none	Código do país ou região

GET Busca de Estado/Província

GET /end-point/ip/dynamic-states/search

Parâmetros de Requisição

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

Exemplo de Resposta

200 Response

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

Resultado da Resposta

Código de Status	Significado do Código	Descrição	Modelo de Dados
200	OK	Requisição bem-sucedida	Inline

Estrutura de Dados da Resposta

Código de Status 200

Nome	Tipo	Obrigatório	Restrição	Descrição
» code	integer	false	none	Código de status, 200 sucesso, 3 app_key inválido, 156 conta não verificada
» msg	string	false	none	Mensagem de status
» data	object	false	none	none
»» list	[string]	false	none	Lista

GET Extrair Lista de IPs Estáticos Adquiridos

GET /end-point/ip/get-static-ip

Parâmetros de Requisição

Nome	Localização	Tipo	Obrigatório	Descrição
country_code	query	string	Não	Código do país ou região
product_type	query	number	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 do pedido
page	query	number	Não	Número da página
size	query	number	Não	Quantidade por página
status	query	number	Não	Status, 1: válido, 2: inválido, 3: expirando em breve, 4: em manutenção

Valores de Enumeração

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

Exemplo de Resposta

200 Response

{}

Resultado da Resposta

Código de Status	Significado do Código	Descrição	Modelo de Dados
200	OK	none	Inline

Estrutura de Dados da Resposta

GET Obter Quantidade de IPs Estáticos Disponíveis por Região

GET /end-point/static-ip-region

Parâmetros de Requisição

Nome	Localização	Tipo	Obrigatório	Descrição
isp	query	string	Não	Tipo de IP

Descrição dos Tipos de IP

Tipo de IP	Descrição
1	IP estático residencial
0	IP estático de data center

Exemplo de Resposta

200 Response

{
	"code": 200,
	"msg": "请求成功",
	"data": {
		"list": [
			{
				"code": "US",
				"number": 55
			}
		]
	}
}

Resultado da Resposta

Código de Status	Significado do Código	Descrição	Modelo de Dados
200	OK	none	Inline

Estrutura de Dados da Resposta

Código de Status 200

Nome	Tipo	Obrigatório	Restrição	Descrição
» code	integer	false	none	Código de status, 200 sucesso
» msg	string	false	none	Mensagem de status
» data	object	false	none	none
»» list	[object]	false	none	none
»»» code	string	false	none	Código do país ou região
»»» number	integer	false	none	Quantidade

Gerenciamento de Pedidos

GET Lista de Pedidos

GET /end-point/order/list

Parâmetros de Requisição

Nome	Localização	Tipo	Obrigatório	Descrição
page_no	query	integer	Não	none
page_size	query	integer	Não	none
trade_no	query	string	Não	Número do pedido
status	query	integer	Não	Status do pedido
product_type	query	integer	Não	Tipo de produto

Descrição Detalhada

status: Status do pedido

Status	Descrição
0	Aguardando pagamento
1	Pago
2	Cancelado por timeout sem pagamento
3	Reembolsado

product_type: Tipo de produto

Tipo de Produto	Descrição
3	Recarga de saldo
9	Plano de tráfego dinâmico
11	Plano global dinâmico por tempo V2
12	Plano de tráfego IDC de longa duração
13	Plano de tráfego IP estático residencial
14	Plano IP estático de data center
15	Plano de tráfego ISP de longa duração
16	Plano de tráfego estático
17	Plano de quantidade de IP dinâmico
18	web-scraper
19	Renovação de IP estático
20	Cota de troca de IP estático
21	Plano de tráfego estático v2
24	Plano adicional de tráfego estático
25	Plano IP estático residencial
26	Pedido complementar - Alguns canais de pagamento exigem que o usuário preencha manualmente o valor, como: criptomoeda. Se houver pagamento insuficiente, é necessário contatar o suporte para completar
27	Serp
28	Video

Valores de Enumeração

Atributo	Valor
status	0
status	1
status	2
status	3
product_type	3
product_type	9
product_type	11
product_type	12
product_type	14
product_type	16
product_type	17
product_type	18
product_type	19
product_type	21
product_type	24
product_type	25
product_type	26
product_type	27
product_type	28

Exemplo de Resposta

200 Response

{
	"code": 0,
	"message": "操作成功",
	"data": {
		"list": [
			{
				"id": 0,
				"trade_no": "string",
				"product_id": 0,
				"product_name": "string",
				"total_fee": 0.1,
				"pay_fee": 0.1,
				"status": 0,
				"created_at": "2019-08-24T14:15:22Z"
			}
		],
		"pagination": {
			"total": 0,
			"page_no": 0,
			"page_size": 0,
			"total_pages": 0
		}
	}
}

Resultado da Resposta

Código de Status	Significado do Código	Descrição	Modelo de Dados
200	OK	Sucesso	Inline

{
	"pid": x, // Contate o suporte para obter
	"upids": "1,2,3,4,5,6", // Obtenha os IDs correspondentes de /end-point/ip/get-static-ip
	"pm_id": 1 // Obtenha de /end-point/payment/list
	"coupon_sn: "xxx", // Opcional - cupom
  }

Parâmetros de Requisição Body

{
	"pid": 0,
	"upids": "string",
	"amount": 0,
	"pm_id": 0,
	"region_list": "string",
	"coupon_sn": "string",
	"use_invitation_registration_discount": true,
	"renew_duration": 0,
	"product_sku_bandwidth_id": 0,
	"product_sku_concurrency_id": 0,
	"recharge_amount": 0
}

Parâmetros de Requisição

Nome	Localização	Tipo	Obrigatório	Descrição
body	body	object	Sim	none
» pid	body	integer	Sim	ID do plano
» upids	body	string	Não	Lista de IDs de planos para renovação
» amount	body	number	Não	Quantidade de planos para nova compra
» pm_id	body	integer	Sim	ID do método de pagamento
» region_list	body	string	Não	Especificar região + quantidade ao comprar IP estático
» coupon_sn	body	string	Não	Número do cupom
» use_invitation_registration_discount	body	boolean	Não	Usar desconto de registro por convite
» renew_duration	body	integer	Não	Duração da renovação - opcional para IP estático
» product_sku_bandwidth_id	body	integer	Não	Plano 11: ID do plano de largura de banda
» product_sku_concurrency_id	body	integer	Não	Plano 11: ID do plano de concorrência
» recharge_amount	body	integer	Não	Plano 3: Valor da recarga

Exemplo de Resposta

200 Response

{
	"code": 0,
	"message": "操作成功",
	"data": {
		"id": 0,
		"trade_no": "string",
		"product_id": 0,
		"product_name": "string",
		"total_fee": 0.1,
		"pay_fee": 0.1,
		"status": 0,
		"created_at": "2019-08-24T14:15:22Z"
	}
}

Resultado da Resposta

Código de Status	Significado do Código	Descrição	Modelo de Dados
200	OK	Criado com sucesso	Inline

Estrutura de Dados da Resposta

POST Cancelar Pedido

POST /end-point/order/close

Parâmetros de Requisição Body

{
	"trade_no": "string"
}

Parâmetros de Requisição

Nome	Localização	Tipo	Obrigatório	Descrição
body	body	object	Sim	none
» trade_no	body	string	Sim	none

Resultado da Resposta

Código de Status	Significado do Código	Descrição	Modelo de Dados
200	OK	Operação bem-sucedida	None

Gerenciamento de Usuários

GET Obter Informações do Usuário - Ainda não disponível

GET /end-point/user/info

Exemplo de Resposta

200 Response

{
	"code": 0,
	"message": "操作成功",
	"data": {
		"id": 0,
		"email": "[email protected]",
		"phone": "string",
		"balance": 0.1,
		"status": 0,
		"is_real_name": true,
		"created_at": "2019-08-24T14:15:22Z"
	}
}

Resultado da Resposta

Código de Status	Significado do Código	Descrição	Modelo de Dados
200	OK	Sucesso	Inline

Nome	Localização	Tipo	Obrigatório	Descrição
trade_no	query	string	Não	Número do pedido - pode ser fornecido quando alguns pedidos precisam de método específico

Exemplo de Resposta

200 Response

{
	"code": 0,
	"message": "Operação bem-sucedida",
	"data": {
		"list": [
			{
				"name": "Grupo de métodos de pagamento",
				"logos": ["https://example.com/logo1.png", "https://example.com/logo2.png"],
				"items": [
					{
						"id": 1,
						"title": "title1",
						"logo": "https://example.com/logo1.png",
						"group": "online",
						"disabled": false,
						"min": 10,
						"max": 5000
					}
				]
			}
		]
	}
}

Resultado da Resposta

Código de Status	Significado do Código de Status	Descrição	Modelo de Dados
200	OK	Obtido com sucesso	Inline

Estrutura de Dados da Resposta

Nome	Tipo	Obrigatório	Restrição	Descrição
» code	integer	false	none	Código de status, 200 sucesso, 3 app_key inválida, 156 conta não verificada
» msg	string	false	none	Mensagem de status
» data	object	false	none	none
»» name	string	false	none	Nome do grupo
»» logos	string[]	false	none	Lista de ícones do grupo
»» items	object[]	false	none	Lista de itens dentro do grupo
»»» id	integer	false	none	ID do método de pagamento
»»» title	string	false	none	Nome do método de pagamento
»»» logo	string	false	none	Logo do método de pagamento
»»» group	string	false	none	Identificador do grupo do método de pagamento
»»» disabled	boolean	false	none	Se está desabilitado (padrão `false`)
»»» min	number	false	none	Valor mínimo
»»» max	number	false	none	Valor máximo

Marketing

GET Proporção de Bônus de Recarga

GET /end-point/activity/balance-recharge-gift-ratio

Proporção de bônus de recarga

Exemplo de Resposta

200 Response

{
	"code": 0,
	"msg": "Operação bem-sucedida",
	"data": {
		"list": [
			{
				"amount": 100,
				"ratio": 1.2
			}
		]
	}
}

Resultado da Resposta

Código de Status	Significado do Código de Status	Descrição	Modelo de Dados
200	OK	OK	Inline

Estrutura de Dados da Resposta

Nome	Tipo	Obrigatório	Restrição	Descrição
» code	integer	false	none	Código de status, 200 sucesso, 3 app_key inválida, 156 conta não verificada
» msg	string	false	none	Mensagem de status
» data	object	false	none	none
» list	[object]	false	none	none
»» amount	integer	false	none	Valor de recarga
»» ratio	number	false	none	Proporção de recarga

Descrição da Estrutura de Dados (Schemas)

productTypes (Tipos de Plano)

Campo	Tipo	Descrição
product_type	integer	Tipo de plano

Descrição dos valores opcionais:

Valor	Significado
9	Plano de tráfego residencial dinâmico
11	IP residencial dinâmico
14	IP de data center estático
25	IP residencial estático

API Key (Chave de Autenticação)

Usada para autenticação de identidade da interface, por favor passe através do parâmetro Query.

Nome do Parâmetro	Localização	Tipo	Obrigatório	Descrição
app_key	query	string	Sim	Chave de autenticação

Campos de Resposta Comuns

responseCode

Campo	Tipo	Exemplo	Descrição
code	integer	200	Código de status (200 sucesso, 3 indica app_key inválida)

responseMsg

Campo	Tipo	Exemplo	Descrição
message	string	success	Mensagem de resposta

Resposta de Sucesso (SuccessResponse)

{
	"code": 0,
	"message": "Operação bem-sucedida",
	"data": {}
}

Resposta de Erro (ErrorResponse)

{
	"code": 400,
	"message": "Erro de parâmetro",
	"errors": {}
}

User

{
	"id": 0,
	"email": "[email protected]",
	"phone": "string",
	"balance": 0.1,
	"status": 0,
	"is_real_name": true,
	"created_at": "2019-08-24T14:15:22Z"
}

Nome	Tipo	Obrigatório	Restrição	Descrição
id	integer	false	none	none
email	string(email)	false	none	none
phone	string	false	none	none
balance	number(float)	false	none	none
status	integer	false	none	none
is_real_name	boolean	false	none	none
created_at	string(date-time)	false	none	none

Order

{
	"id": 0,
	"trade_no": "string",
	"product_id": 0,
	"product_name": "string",
	"total_fee": 0.1,
	"pay_fee": 0.1,
	"status": 0,
	"created_at": "2019-08-24T14:15:22Z"
}

Nome	Tipo	Obrigatório	Restrição	Descrição
id	integer	false	none	none
trade_no	string	false	none	none
product_id	integer	false	none	none
product_name	string	false	none	none
total_fee	number(float)	false	none	none
pay_fee	number(float)	false	none	none
status	integer	false	none	none
created_at	string(date-time)	false	none	none

Product

{
	"id": 0,
	"name": "string",
	"type": 0,
	"price": 0.1,
	"description": "string"
}

Nome	Tipo	Obrigatório	Restrição	Descrição
id	integer	false	none	none
name	string	false	none	none
type	integer	false	none	none
price	number(float)	false	none	none
description	string	false	none	none

WhiteIp

{
	"id": 0,
	"ip": "string",
	"remark": "string",
	"created_at": "2019-08-24T14:15:22Z"
}

Nome	Tipo	Obrigatório	Restrição	Descrição
id	integer	false	none	none
ip	string	false	none	none
remark	string	false	none	none
created_at	string(date-time)	false	none	none

WhitelistAccount

{
	"id": 0,
	"username": "string",
	"limit": 0,
	"used": 0,
	"status": 0
}

Nome	Tipo	Obrigatório	Restrição	Descrição
id	integer	false	none	none
username	string	false	none	none
limit	integer	false	none	none
used	integer	false	none	none
status	integer	false	none	none

Coupon

{
	"id": 0,
	"name": "string",
	"code": "string",
	"discount": 0.1,
	"expire_time": "2019-08-24T14:15:22Z"
}

Nome	Tipo	Obrigatório	Restrição	Descrição
id	integer	false	none	none
name	string	false	none	none
code	string	false	none	none
discount	number(float)	false	none	none
expire_time	string(date-time)	false	none	none

Article

{
	"id": 0,
	"title": "string",
	"content": "string",
	"created_at": "2019-08-24T14:15:22Z"
}

Nome	Tipo	Obrigatório	Restrição	Descrição
id	integer	false	none	none
title	string	false	none	none
content	string	false	none	none
created_at	string(date-time)	false	none	none

Pagination

{
	"total": 0,
	"page_no": 0,
	"page_size": 0,
	"total_pages": 0
}

Nome	Tipo	Obrigatório	Restrição	Descrição
total	integer	false	none	none
page_no	integer	false	none	none
page_size	integer	false	none	none
total_pages	integer	false	none	none