ProxyCC OpenAPI
Por favor, faça login para visualizar a chave de autenticação app_key na página inicial da sua central pessoal.
Por favor, mantenha a chave em segurança, pois ela tem privilégios de administrador para a sua conta.
URLs base:
https://api.proxy.cc
Método de autenticação
Autenticação da Chave do Aplicativo
Parâmetros POST:
app_key: {your_app_key}
Ou como um parâmetro de consulta:
?app_key={your_app_key}
Formato de resposta
Todas as interfaces retornam um formato JSON unificado:
{
"code": 200,
"message": "操作成功",
"data": {}
}
code: Código de status, 200 indica sucesso, outros valores indicam falhamessage: Mensagem de resposta (Chinês)data: Dados de resposta
Autenticação
Esta interface suporta os dois seguintes métodos de autenticação:
1. Token de Portador (JWT)
Passe o Token através do cabeçalho HTTP.
Exemplo de Cabeçalho:
Authorization: Bearer <your_jwt_token>
Autenticação por Chave de API
Esta interface usa o método de Chave de API para autenticação.
O cliente precisa incluir o parâmetro app_key na requisição, caso contrário, a requisição será rejeitada.
Exemplo:
GET /api/example?app_key=your_app_key
POST /api/example?app_key=your_app_key
Content-Type: application/json
Gerenciamento de Contas Proxy
OBTER Lista de Contas Proxy
GET /open/whitelist-account/list
Exemplo de Retorno
Resposta Bem-Sucedida (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
}
]
}
}
Retornar Resultado
| 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 | Nome Chinês | Descrição |
|---|---|---|---|---|---|
| » code | responseCode | falso | nenhum | Código de status, 200 sucesso, 3 app_key inválida | |
| » 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 do agente | |
| »»» senha | string | falso | nenhum | Senha da conta do agente | |
| »»» created_at | string | falso | nenhum | Adicionar Tempo | |
| »»» observação | string | falso | nenhum | Observações | |
| »»» product_type | tiposDeProduto | falso | nenhum | Tipo de Pacote, 9 Pacote de Tráfego Residencial Dinâmico, 11 IP Residencial Dinâmico, 14 IP de Datacenter Estático, 25 IP Residencial Estático | |
| »»» usage_flow | inteiro | falso | nenhum | Tráfego Usado, Unidade: KB | |
| »»» limite_fluxo | inteiro | falso | nenhum | Limite de tráfego personalizado: Unidade GB, máximo 102400, 0 para ilimitado | |
| »»» status | inteiro | falso | nenhum | Status ativado: 1 ativado, 0 desativado |
Valor Enum
| Propriedade | Valor |
|---|---|
| product_type | 9 |
| product_type | 11 |
| product_type | 14 |
| product_type | 25 |
POST Adicionar Conta Proxy
POST /open/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 Requisição
| Nome | Localização | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| corpo | corpo | objeto | Não | nenhum |
| » app_key | corpo | string | Não | Chave de Autorização |
| » accounts | corpo | string | Não | Senha da conta, preencha no formato nome de usuário:senha. Apenas números e letras são suportados para a conta e senha. Não insira nenhum símbolo especial ou espaços. Separe a conta e a senha com dois pontos. A adição em lote é suportada e as contas de proxy são separadas por vírgulas (,) em inglês. |
| » observação | corpo | string | Não | Descrição da conta proxy |
| » product_type | corpo | tiposDeProduto | Não | Tipo de Pacote, 9 Pacote de Tráfego Residencial Dinâmico, 11 IP Residencial Dinâmico, 14 IP de Datacenter Estático, 25 IP Residencial Estático |
Valor Enum
| Propriedade | Valor |
|---|---|
| » product_type | 9 |
| » product_type | 11 |
| » product_type | 14 |
| » product_type | 25 |
Exemplo de retorno
Resposta 200
{
"code": 200,
"msg": "string",
"data": null
}
Retornar Resultado
| 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 | Nome Chinês | 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 | falso | nenhum | Mensagem de status | |
| » dados | nulo | falso | nenhum | nenhum |
POST Excluir Conta Proxy
POST /open/whitelist-account/delete
Observe que a exclusão é irreversível, e o tráfego usado e outros dados não podem ser consultados após a exclusão. A exclusão leva aproximadamente 5 minutos, e cobranças ainda podem ser incorridas durante este período.
Parâmetros do Corpo da Requisição
{
"app_key": "stringstringstringstringstringst",
"accounts": "user01,user02"
}
Parâmetros de Requisição
| Nome | Localização | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| corpo | corpo | objeto | Não | nenhum |
| » app_key | corpo | string | Não | Chave de Autorização |
| » contas | corpo | string | Não | Conta proxy, suporta apenas números e letras. Suporta operações em lote, separe as contas proxy com vírgulas inglesas (,). |
Exemplo de retorno
Resposta 200
{
"code": 200,
"msg": "string",
"data": 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 | Embutido |
Estrutura de Dados de Retorno
Código de Status 200
| Nome | Tipo | Obrigatório | Restrição | Nome Chinês | Descrição |
|---|---|---|---|---|---|
| » código | inteiro | falso | nenhum | Código de status: 200 Sucesso, 3 app_key inválidas, 156 conta não autenticada com nome real | |
| » msg | string | falso | nenhum | Mensagem de status | |
| » dados | nulo | falso | nenhum | nenhum |
POST Desativar Conta Proxy
POST /open/whitelist-account/disable
A desativação tem um período de espera de aproximadamente 5 minutos, durante o qual as taxas ainda podem ser cobradas.
Parâmetros do Corpo da Requisição
{
"app_key": "stringstringstringstringstringst",
"accounts": "user01,user02"
}
Parâmetros da Requisição
| Nome | Localização | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| corpo | corpo | objeto | Não | nenhum |
| » app_key | corpo | string | Não | Chave de Autorização |
| » contas | corpo | string | Não | Conta proxy, suporta apenas números e letras. Suporta operações em lote, separe as contas proxy com vírgulas inglesas (,). |
Exemplo de retorno
Resposta 200
{
"code": 200,
"msg": "string",
"data": null
}
Retornar Resultado
| 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ção | Nome Chinês | Explicação |
|---|---|---|---|---|---|
| » código | inteiro | falso | nenhum | Código de status, 200 sucesso, 3 app_key inválida, 156 conta não autenticada com nome real | |
| » msg | string | false | nenhum | Mensagem de status | |
| » dados | nulo | falso | nenhum | nenhum |
POST Ativar Conta Proxy
POST /open/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 | Descrição |
|---|---|---|---|---|
| corpo | corpo | objeto | Não | nenhum |
| » app_key | corpo | string | Não | Chave de Autorização |
| » contas | corpo | string | Não | Conta proxy, suporta apenas números e letras. Suporta operações em lote, separe as contas proxy com vírgulas inglesas (,). |
Exemplo de retorno
Resposta 200
{
"code": 200,
"msg": "string",
"data": null
}
Retornar Resultado
| 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ção | Nome Chinês | Descrição |
|---|---|---|---|---|---|
| » código | inteiro | falso | nenhum | Código de status: 200 Sucesso, 3 app_key inválida, 156 conta não autenticada com nome real | |
| » msg | string | false | nenhum | Mensagem de status | |
| » dados | nulo | falso | nenhum | nenhum |
POST Modificar senha da conta proxy
POST /open/whitelist-account/change-password
Por favor, note que há um período 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 da Requisição
| Nome | Localização | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| corpo | corpo | objeto | Não | nenhum |
| » app_key | corpo | string | Não | Chave de Autorização |
| » conta | corpo | string | Não | Conta proxy, suporta apenas números e letras. |
| » senha | corpo | string | Não | Nova senha para a conta proxy, apenas números e letras são suportados. |
Exemplo de retorno
Resposta 200
{
"code": 200,
"msg": "string",
"data": 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 | Nome Chinês | 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 | falso | nenhum | Mensagem de status | |
| » dados | nulo | falso | nenhum | nenhum |
POST Modificar observações da conta proxy
POST /open/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 |
|---|---|---|---|---|
| corpo | corpo | objeto | Não | nenhum |
| » app_key | corpo | string | Não | Chave de Autorização |
| » conta | corpo | string | Não | Conta proxy, suporta apenas números e letras. |
| » observação | corpo | string | Não | Nova nota da conta do agente, dentro de 32 caracteres chineses ou 64 caracteres ingleses. |
Exemplo de retorno
Resposta 200
{
"code": 200,
"msg": "string",
"data": null
}
Retornar Resultado
| Código de Status | Significado do Código de Status | Descrição | Modelo de Dados |
|---|---|---|---|
| 200 | OK | Requisição Bem-Sucedida | Em linha |
Estrutura de Dados de Retorno
Código de Status 200
| Nome | Tipo | Obrigatório | Restrição | Nome Chinês | 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 | falso | nenhum | Mensagem de status | |
| » dados | nulo | falso | nenhum | nenhum |
POST Modificar Limite de Tráfego da Conta do Agente
POST /open/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 |
|---|---|---|---|---|
| corpo | corpo | objeto | Não | nenhum |
| » app_key | corpo | string | Não | Chave de Autorização |
| » conta | corpo | string | Não | Conta proxy, suporta apenas números e letras. |
| » limite | corpo | inteiro | Não | Limite de tráfego, unidade: GB, 0 significa sem limite |
Exemplo de retorno
Resposta 200
{
"code": 200,
"msg": "string",
"data": 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 | Nome Chinês | Descrição |
|---|---|---|---|---|---|
| » code | inteiro | falso | nenhum | Código de status: 200 Sucesso, 3 app_key inválidas, 156 conta não autenticada com nome real | |
| » msg | string | falso | nenhum | Mensagem de status | |
| » dados | nulo | falso | nenhum | nenhum |
Consulta de Log de Tráfego
GET Tráfego de Uso Agregado por Dia
GET /open/user-usage-flow/total
Parâmetros de Requisição
| Nome | Localização | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| app_key | consulta | string(senha) | Sim | Chave de autenticação |
| hora_inicial | consulta | string(A-m-d H:i:s) | Não | Hora de início, com precisão de segundos. Observe que há um atraso de até 5 minutos no registro. Padrão em 7 dias. |
| hora_de_término | consulta | string(A-m-d H:i:s) | Não | Hora de término, precisa ser precisa até o segundo. Observe que há um atraso de até 5 minutos no registro. O padrão é a hora atual. |
| nome de usuário | consulta | string | Não | Nome da subconta, o padrão é consultar todas as contas, pode especificar uma subconta. Observe que, se você adicionou subcontas com o mesmo nome, esta consulta retornará todos os registros de uso para contas proxy 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 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 | Nome Chinês | Descrição |
|---|---|---|---|---|---|
| » code | inteiro | falso | nenhum | Código de status: 200 Sucesso, 3 app_key inválida, 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 | |
| »»» dia | string | falso | nenhum | Data | |
| »»» fluxo | inteiro | falso | nenhum | Consumo de tráfego, unidade: KB |
Consulta de pacote
GET lista de pacotes comprados
GET /open/user-product/list
Parâmetros de Requisição
| Nome | Localização | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| app_key | consulta | string(senha) | Sim | Chave de Autenticação |
| trade_no | consulta | string | Não | Número do pedido, por favor, insira o número completo do pedido. A pesquisa difusa não é suportada. |
| página | consulta | número | Não | Paginação, padrão: 1 |
| tamanho | consulta | número | Não | Número 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 Bem-Sucedida | Em linha |
Estrutura de Dados de Retorno
Código de Status 200
| Nome | Tipo | Obrigatório | Restrição | Nome Chinês | Descrição |
|---|---|---|---|---|---|
| » code | inteiro | falso | nenhum | Código de status: 200 Sucesso, 3 app_key inválidos, 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 | falso | nenhum | Tempo de Expiração do Pacote, após a expiração, o tráfego não poderá ser usado. | |
| »»» product_type | tiposDeProduto | falso | nenhum | Tipo de Pacote, 9 Pacote de Tráfego Residencial Dinâmico, 11 IP Residencial Dinâmico, 14 IP Estático de Datacenter, 25 IP Residencial Estático | |
| »»» trade_no | string | falso | nenhum | Número da transação do pedido | |
| »»» pedido | objeto | falso | nenhum | nenhum | |
| »»»» created_at | string | falso | nenhum | Hora de criação do pedido | |
| »»»» pay_at | string | falso | nenhum | Hora de pagamento do pedido | |
| »»»» title | string | falso | 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 | Número total de registros | |
| »» total_page | inteiro | falso | nenhum | Número total de páginas |
Valor Enum
| Propriedade | Valor |
|---|---|
| product_type | 9 |
| product_type | 11 |
| product_type | 14 |
| product_type | 25 |
Extração de IP
GET Extrair IP
GET /open/ip/v3
Parâmetros de solicitação
| Nome | Localização | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| app_key | consulta | 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 |
| formato | consulta | string | Não | Obter Formato |
| lb | consulta | string | Não | Separador, válido apenas para formato de texto |
| num | consulta | número | Não | Quantidade de Extração |
| vida | consulta | número | Não | Manter Ciclo - Minutos |
| ep | consulta | string | Não | Rede de Proxy |
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"
]
]
}
}
Retornar Resultado
| Código de Status | Significado do Código de Status | Descrição | Modelo de Dados |
|---|---|---|---|
| 200 | OK | Requisição Bem-Sucedida | Em linha |
Estrutura de Dados de Retorno
Código de Status 200
| Nome | Tipo | Obrigatório | Restrição | Nome Chinês | 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 | falso | nenhum | Mensagem de status | |
| » dados | objeto | falso | nenhum | nenhum | |
| »» lista | [qualquer] | falso | nenhum | nenhum |
OBTER Lista de Cidades
GET /open/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 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 | Nome Chinês | Descrição |
|---|---|---|---|---|---|
| » code | inteiro | falso | nenhum | Código de status: 200 Sucesso, 3 app_key inválida, 156 conta não autenticada com nome real | |
| » msg | string | falso | nenhum | Mensagem de status | |
| » dados | objeto | falso | nenhum | nenhum | |
| »» lista | [objeto] | falso | nenhum | Lista | |
| »»» name_pt_br | string | falso | nenhum | Nome do país ou região | |
| »»» nome_en | string | falso | nenhum | Nome do país ou região | |
| »»» código_do_continente | string | falso | nenhum | Código do continente | |
| »»» código_do_país | string | falso | nenhum | Código do país ou região | |
| »»» itens | [objeto] | falso | nenhum | Estado ou província | |
| »»»» cidade | string | falso | nenhum | Nome da cidade | |
| »»»» estado | string | falso | nenhum | Código do nome da província ou estado | |
| »»»» código_do_continente | string | falso | nenhum | Código do continente | |
| »»»» código_do_país | string | falso | nenhum | Código do país ou região |
GET Pesquisa de Cidade
GET /open/ip/dynamic-citys/search
Parâmetros de Requisição
| Nome | Localização | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| código do país | consulta | string | Sim | 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 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 | Nome Chinês | Descrição |
|---|---|---|---|---|---|
| » code | inteiro | falso | nenhum | Código de status: 200 Sucesso, 3 app_key inválidas, 156 conta não autenticada com nome real | |
| » msg | string | falso | nenhum | Mensagem de status | |
| » dados | objeto | falso | nenhum | nenhum | |
| »» lista | [string] | falso | nenhum | Lista |
GET Lista de estados
GET /open/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 | Nome Chinês | 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 | falso | nenhum | Mensagem de status | |
| » dados | objeto | falso | nenhum | nenhum | |
| »» lista | [objeto] | falso | nenhum | Lista | |
| »»» name_pt_br | string | falso | nenhum | Nome do país ou região | |
| »»» nome_en | string | falso | nenhum | Nome do país ou região | |
| »»» código_do_continente | string | falso | nenhum | Código do continente | |
| »»» código_do_país | string | falso | nenhum | Código do país ou região | |
| »»» itens | [objeto] | falso | nenhum | Estado ou província | |
| »»»» estado | string | falso | nenhum | Código do nome da província ou estado | |
| »»»» código_do_continente | string | falso | nenhum | Código do continente | |
| »»»» código_do_país | string | falso | nenhum | Código do país ou região |
OBTER pesquisa de estado/província
GET /open/ip/dynamic-states/search
Parâmetros de Requisição
| Nome | Localização | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| código do país | consulta | string | Sim | Código do país ou região |
Exemplo de retorno
Resposta 200
{
"code": 200,
"msg": "string",
"data": {
"list": ["string"]
}
}
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 | Nome Chinês | 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 | falso | nenhum | Mensagem de status | |
| » dados | objeto | falso | nenhum | nenhum | |
| »» lista | [string] | falso | nenhum | Lista |
GET Extrair Lista de IPs Estáticos Adquiridos
GET /open/ip/get-static-ip
Parâmetros de solicitação
| Nome | Localização | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| código do país | consulta | string | Não | Código do país ou região |
| product_type | consulta | número | Não | Tipo de Produto, 25: IP Residencial Estático, 14: IP de Data Center |
| trade_no | consulta | string | Não | Filtrar IPs por Número de Pedido |
| página | consulta | número | Não | Número da página |
| tamanho | consulta | número | Não | Tamanho da página |
| estado | consulta | número | Não | Status, 1: válido, 2: inválido, 3: expirando em breve, 4: em manutenção |
Valor Enum
| Propriedade | Valor |
|---|---|
| product_type | 14 |
| product_type | 25 |
| estado | 1 |
| estado | 2 |
| estado | 3 |
| estado | 4 |
Exemplo de retorno
Resposta 200
{}
Resultado de retorno
| Código de Status | Significado do Código de Status | Descrição | Modelo de Dados |
|---|---|---|---|
| 200 | OK | nenhum | Em linha |
Estrutura de Dados de Retorno
GET Obtenha o número de IPs estáticos na área de vendas
GET /open/static-ip-region
Parâmetros da Requisição
| Nome | Localização | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| isp | consulta | string | Não | Tipo de IP |
Descrição do Tipo de IP
| Tipo de IP | Descrição |
|---|---|
| 1 | IP Estático Residencial |
| 0 | IP Estático de Data Center |
Exemplo de retorno
Resposta 200
{
"code": 200,
"msg": "请求成功",
"data": {
"list": [
{
"code": "US",
"number": 55
}
]
}
}
Retornar Resultado
| Código de Status | Significado do Código de Status | Descrição | Modelo de Dados |
|---|---|---|---|
| 200 | OK | nenhum | Em linha |
Estrutura de Dados de Retorno
Código de Status 200
| Nome | Tipo | Obrigatório | Restrição | Nome Chinês | Descrição |
|---|---|---|---|---|---|
| » code | inteiro | falso | nenhum | Código de Status, 200 Sucesso | |
| » msg | string | falso | nenhum | Mensagem de status | |
| » dados | objeto | falso | nenhum | nenhum | |
| »» lista | [objeto] | falso | nenhum | nenhum | |
| »»» código | string | falso | nenhum | Código do país ou região | |
| »»» número | inteiro | falso | nenhum | Quantidade |
Gestão de Pedidos
OBTER Lista de Pedidos
GET /open/order/list
Parâmetros da Requisição
| Nome | Localização | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| página_no | consulta | inteiro | Não | nenhum |
| page_size | consulta | inteiro | Não | nenhum |
| trade_no | consulta | string | Não | Número do pedido |
| estado | consulta | inteiro | Não | Status do pedido |
| product_type | consulta | inteiro | Não | Tipo de produto |
Descrição detalhada
status: Status do pedido
| Status | Descrição |
|---|---|
| 0 | Pagamento pendente |
| 1 | Pago |
| 2 | Cancelado devido ao tempo limite |
| 3 | Reembolsado |
product_type: Tipo de produto
| Tipo de Produto | Descrição |
|---|---|
| 3 | Recarregar Saldo |
| 9 | Pacote de Tráfego Dinâmico |
| 11 | Pacote Dinâmico Global Horário V2 |
| 12 | Pacote de tráfego IDC de longo prazo |
| 13 | Pacote de tráfego IP estático residencial |
| 14 | Pacote de IP estático para data center |
| 15 | Pacote de tráfego de ISP de longo prazo |
| 16 | Pacote de Tráfego Estático |
| 17 | Pacote de Quantidade de IP Dinâmico |
| 18 | web-scraper |
| 19 | Renovação de IP Estático |
| 20 | Cota de Substituição de IP Estático |
| 21 | Pacote de Tráfego Estático v2 |
| 24 | Pacote Adicional de Tráfego Estático |
| 25 | Pacote de IP Estático Residencial |
| 26 | Conclusão do Pedido - Alguns canais de pagamento exigem que os usuários insiram o valor manualmente, como: moeda virtual. Se houver alguma diferença, você precisa entrar em contato com o atendimento ao cliente para fazer um pagamento suplementar através deste produto |
| 27 | Serp |
| 28 | Vídeo |
Valor Enum
| Propriedade | Valor |
|---|---|
| estado | 0 |
| estado | 1 |
| estado | 2 |
| estado | 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 Retorno
Resposta 200
{
"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 Retornado
| Código de Status | Significado do Código de Status | Descrição | Modelo de Dados |
|---|---|---|---|
| 200 | OK | Sucesso | Em linha |
Estrutura de Dados de Retorno
POST Criar Pedido
POST /open/order/create
Devido à variedade de pacotes e às diferentes configurações para cada pacote, preencha os parâmetros de acordo com a situação real. Parâmetros preenchidos incorretamente podem fazer com que a criação do pedido falhe.
exemplos:
Renovar IP Estático
{
"pid": x, // 联系客服获取
"upids": "1,2,3,4,5,6", // 从 /end-point/ip/get-static-ip 获取对应的ID
"pm_id": 1 // 从 /end-point/payment/list 获取
"coupon_sn: "xxx", // 可选 优惠券
}
Parâmetros do Corpo da Requisição
{
"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 da Requisição
| Nome | Localização | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| corpo | corpo | objeto | Sim | nenhum |
| » pid | corpo | inteiro | Sim | ID do pacote |
| » upids | corpo | string | Não | Lista de IDs de Pacotes de Renovação |
| » quantidade | corpo | número | Não | Nova Quantidade do Pacote |
| » pm_id | corpo | inteiro | Sim | ID do método de pagamento |
| » region_list | corpo | string | Não | Especifique a região + quantidade ao comprar um IP estático |
| » coupon_sn | corpo | string | Não | Código do cupom |
| » use_invitation_registration_discount | corpo | booleano | Não | Se deve usar o desconto de registro de convite |
| » renew_duration | corpo | inteiro | Não | Duração da renovação - IP estático opcional |
| » product_sku_bandwidth_id | corpo | inteiro | Não | Pacote 11: ID do pacote de largura de banda |
| » product_sku_concurrency_id | corpo | inteiro | Não | Pacote 11: ID do Pacote Concorrente |
| » recharge_amount | corpo | inteiro | Não | Pacote 3: Valor da Recarga |
Exemplo de Retorno
Resposta 200
{
"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 do Retorno
| Código de Status | Significado do Código de Status | Descrição | Modelo de Dados |
|---|---|---|---|
| 200 | OK | Criado com sucesso | Em linha |
Estrutura de Dados de Retorno
POST Cancelar Pedido
POST /open/order/close
Parâmetros do Corpo da Requisição
{
"trade_no": "string"
}
Parâmetros da Requisição
| Nome | Localização | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| corpo | corpo | objeto | Sim | nenhum |
| » trade_no | corpo | string | Sim | nenhum |
Retornar Resultado
| Código de Status | Significado do Código de Status | Descrição | Modelo de Dados |
|---|---|---|---|
| 200 | OK | Operação bem-sucedida | Nenhum |
Gerenciamento de usuários
GET Obter Informações do Usuário - Ainda Não Aberto
GET /open/user/info
Exemplo de Retorno
Resposta 200
{
"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 Retornado
| Código de Status | Significado do Código de Status | Descrição | Modelo de Dados |
|---|---|---|---|
| 200 | OK | Sucesso | Em linha |
Estrutura de Dados de Retorno
Gestão de Pagamentos
GET Obter Lista de Métodos de Pagamento
GET /open/payment/groups
Parâmetros da Requisição
| Nome | Localização | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| trade_no | consulta | string | Não | Número do pedido - pode ser transmitido quando alguns pedidos precisam obter um método de pagamento específico |
Exemplo de Retorno
Resposta 200
{
"code": 0,
"message": "操作成功",
"data": {
"list": [
{
"name": "支付方式分组",
"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 do Retorno
| Código de Status | Significado do Código de Status | Descrição | Modelo de Dados |
|---|---|---|---|
| 200 | OK | Obtido com sucesso | Em linha |
Estrutura de Dados de Retorno
| Nome | Tipo | Obrigatório | Restrição | Nome Chinês | Descrição |
|---|---|---|---|---|---|
| » code | inteiro | falso | nenhum | Código de status: 200 Sucesso, 3 app_key inválida, 156 conta não autenticada com nome real | |
| » msg | string | falso | nenhum | Mensagem de status | |
| » dados | objeto | falso | nenhum | nenhum | |
| »» nome | string | falso | nenhum | Nome do Grupo | |
| »» logotipos | string[] | falso | nenhum | Lista de Ícones do Grupo | |
| »» itens | object[] | falso | nenhum | Lista de Itens Agrupados | |
| »»» id | inteiro | falso | nenhum | ID do Método de Pagamento | |
| »»» título | string | falso | nenhum | Nome do Método de Pagamento | |
| »»» logotipo | string | falso | nenhum | Logotipo do Método de Pagamento | |
| »»» group | string | falso | nenhum | Identificador de Agrupamento do Método de Pagamento | |
| »»» disabled | booleano | falso | nenhum | Se deve desativar (o padrão é falso) | |
| »» mín. | número | falso | nenhum | Quantidade mínima | |
| »»» máx. | número | falso | nenhum | Quantidade máxima |
Marketing
OBTER Taxa de Bônus de Recarga
OBTER /open/activity/balance-recharge-gift-ratio
Taxa de Bônus de Recarga
Exemplo de Retorno
Resposta 200
{
"code": 0,
"msg": "操作成功",
"data": {
"list": [
{
"amount": 100,
"ratio": 1.2
}
]
}
}
Retornar Resultado
| Código de Status | Significado do Código de Status | Descrição | Modelo de Dados |
|---|---|---|---|
| 200 | OK | OK | Em linha |
Estrutura de Dados de Retorno
| Nome | Tipo | Obrigatório | Restrição | Nome Chinês | Descrição |
|---|---|---|---|---|---|
| » code | inteiro | falso | nenhum | Código de status: 200 Sucesso, 3 app_key inválidas, 156 contas não autenticadas com nome real | |
| » msg | string | falso | nenhum | Mensagem de status | |
| » dados | objeto | falso | nenhum | nenhum | |
| » listagem | [objeto] | falso | nenhum | nenhum | |
| »» quantidade | inteiro | falso | nenhum | Valor do Recarregamento | |
| »» proporção | número | falso | nenhum | Proporção de Recarregamento |
Descrição da Estrutura de Dados (Esquemas)
tipos de produto (tipos de pacote)
| Campo | Tipo | Descrição |
|---|---|---|
| product_type | inteiro | Tipo de pacote |
Descrição dos valores opcionais:
| Valor | Significado |
|---|---|
| 9 | Pacote de Tráfego Residencial Dinâmico |
| 11 | IP Residencial Dinâmico |
| 14 | IP Estático de Datacenter |
| 25 | IP Estático Residencial |
Chave de API
Usada para autenticação de interface, por favor, passe-a através do parâmetro de consulta.
| Nome do parâmetro | Localização | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| app_key | consulta | string | Sim | Chave de Autenticação |
Campos de Resposta Comuns
responseCode
| Campo | Tipo | Exemplo | Descrição |
|---|---|---|---|
| código | inteiro | 200 | Código de status (200 significa sucesso, 3 significa app_key inválida) |
responseMsg
| Campo | Tipo | Exemplo | Descrição |
|---|---|---|---|
| mensagem | string | sucesso | Informações da Resposta |
Resposta bem-sucedida (SuccessResponse)
{
"code": 0,
"message": "操作成功",
"data": {}
}
Resposta de Erro (ErrorResponse)
{
"code": 400,
"message": "参数错误",
"errors": {}
}
Usuário
{
"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 | Nome Chinês | Descrição |
|---|---|---|---|---|---|
| id | inteiro | falso | nenhum | nenhum | |
| string(e-mail) | falso | nenhum | nenhum | ||
| telefone | string | falso | nenhum | nenhum | |
| saldo | número(flutuante) | falso | nenhum | nenhum | |
| estado | inteiro | falso | nenhum | nenhum | |
| is_real_name | booleano | falso | nenhum | nenhum | |
| created_at | string(data-hora) | falso | nenhum | nenhum |
Pedido
{
"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 | Nome Chinês | Descrição |
|---|---|---|---|---|---|
| id | inteiro | falso | nenhum | nenhum | |
| trade_no | string | falso | nenhum | nenhum | |
| product_id | inteiro | falso | nenhum | nenhum | |
| product_name | string | falso | nenhum | nenhum | |
| total_fee | número(flutuante) | falso | nenhum | nenhum | |
| pay_fee | número(flutuante) | falso | nenhum | nenhum | |
| estado | inteiro | falso | nenhum | nenhum | |
| created_at | string(data-hora) | falso | nenhum | nenhum |
Produto
{
"id": 0,
"name": "string",
"type": 0,
"price": 0.1,
"description": "string"
}
| Nome | Tipo | Obrigatório | Restrição | Nome Chinês | Descrição |
|---|---|---|---|---|---|
| id | inteiro | falso | nenhum | nenhum | |
| nome | string | falso | nenhum | nenhum | |
| tipo | inteiro | falso | nenhum | nenhum | |
| preço | número(flutuante) | falso | nenhum | nenhum | |
| Immersive Translate | string | falso | nenhum | nenhum |
WhiteIp
{
"id": 0,
"ip": "string",
"remark": "string",
"created_at": "2019-08-24T14:15:22Z"
}
| Nome | Tipo | Obrigatório | Restrição | Nome Chinês | Descrição |
|---|---|---|---|---|---|
| id | inteiro | falso | nenhum | nenhum | |
| ip | string | falso | nenhum | nenhum | |
| observação | string | falso | nenhum | nenhum | |
| created_at | string(data-hora) | falso | nenhum | nenhum |
WhitelistAccount
{
"id": 0,
"username": "string",
"limit": 0,
"used": 0,
"status": 0
}
| Nome | Tipo | Obrigatório | Restrição | Nome Chinês | Descrição |
|---|---|---|---|---|---|
| id | inteiro | falso | nenhum | nenhum | |
| nome de usuário | string | falso | nenhum | nenhum | |
| limite | inteiro | falso | nenhum | nenhum | |
| usado | inteiro | falso | nenhum | nenhum | |
| estado | inteiro | falso | nenhum | nenhum |
Cupom
{
"id": 0,
"name": "string",
"code": "string",
"discount": 0.1,
"expire_time": "2019-08-24T14:15:22Z"
}
| Nome | Tipo | Obrigatório | Restrição | Nome Chinês | Descrição |
|---|---|---|---|---|---|
| id | inteiro | falso | nenhum | nenhum | |
| nome | string | falso | nenhum | nenhum | |
| código | string | falso | nenhum | nenhum | |
| desconto | número(flutuante) | falso | nenhum | nenhum | |
| tempo_expiracao | string(data-hora) | falso | nenhum | nenhum |
Artigo
{
"id": 0,
"title": "string",
"content": "string",
"created_at": "2019-08-24T14:15:22Z"
}
| Nome | Tipo | Obrigatório | Restrição | Nome Chinês | Descrição |
|---|---|---|---|---|---|
| id | inteiro | falso | nenhum | nenhum | |
| título | string | falso | nenhum | nenhum | |
| conteúdo | string | falso | nenhum | nenhum | |
| created_at | string(data-hora) | falso | nenhum | nenhum |
Paginação
{
"total": 0,
"page_no": 0,
"page_size": 0,
"total_pages": 0
}
| Nome | Tipo | Obrigatório | Restrição | Nome Chinês | Explicação |
|---|---|---|---|---|---|
| total | inteiro | falso | nenhum | nenhum | |
| página_no | inteiro | falso | nenhum | nenhum | |
| page_size | inteiro | falso | nenhum | nenhum | |
| total_pages | inteiro | falso | nenhum | nenhum |