OpenAPIOpenAPI
  • English
  • 简体中文
  • Indonesia
  • हिंदी
  • Русский
  • Tiếng Việt
  • German
  • português
  • English
  • 简体中文
  • Indonesia
  • हिंदी
  • Русский
  • Tiếng Việt
  • German
  • português
  • ProxyLite OpenAPI

ProxyLite OpenAPI

Oferece suporte ao gerenciamento de contas pessoais, recursos de agentes e faturamento de equipe por meio do prefixo OpenAPI do site.

O método de autenticação está sujeito à definição de segurança de cada operação:

  • apiKeyAuth: Passar a API Key pessoal ou de equipe através do parâmetro de consulta app_key; o back-end também é compatível com parâmetros key, appkey, openid e parâmetros do corpo da solicitação POST.
  • bearerAuth: Autorização: Bearer <JWT>, usado para tokens de login da web. Não pense nas chaves de API como JWTs.
  • A chave API da equipe está vinculada a uma equipe fixa; interfaces que suportam espaço de equipe podem omitir team_id e a entrada explícita deve ser consistente com a equipe de vinculação de chave.
  • Interfaces que suportam apenas espaço pessoal rejeitarão a API Key da equipe; as operações da equipe ainda seguem as permissões de recurso do membro detentor.

A resposta JSON contém código, mensagem, dados, request_id. code=200 significa que o negócio foi bem-sucedido; O HTTP 200 também pode conter um código de erro comercial. msg muda com o idioma da solicitação e o cliente deve usar o código para determinar o resultado. Algumas interfaces de exportação também suportam texto, CSV ou XML; consulte a definição da operação para obter detalhes. Os campos valor, fluxo, data e paginação estão sujeitos ao Schema de cada interface.

URLs base:

  • https://api.proxylite.com

Autenticação

  • Autenticação HTTP, esquema: bearer
  • Chave API (apiKeyAuth)
    • Nome do parâmetro: app_key, in: query. Chave de API pessoal ou de equipe. Parâmetro de consulta recomendado app_key; também compatível com key/appkey/openid e corpo de solicitação POST. As chaves da equipe só podem acessar interfaces suportadas da equipe vinculada.

Gerenciamento de contas de agência

Lista de contas de agente (GET /end-point/whitelist-account/list)

Exemplos de código

# Você também pode usar wget
curl -X GET https://api.proxylite.com/end-point/whitelist-account/list \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/whitelist-account/list

Parâmetros

NomeEmTipoObrigatórioDescrição
team_idqueryResourceSpaceIdfalseIdentificador de espaço de recursos; omita o espaço pessoal ou passe uma string vazia; A chave da equipe pode ser omitida e deve ser consistente com a chave quando passada

Exemplos de resposta

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

Respostas

StatusSignificadoDescriçãoEsquema
200OKSolicitação bem-sucedidaInline

Esquema da resposta

Status Code 200

NomeTipoObrigatórioRestriçõesDescrição
» coderesponseCodefalsenenhumCódigo de status, 200 bem-sucedido, 3 app_key inválido
» msgstringfalsenenhummensagem de estado
» dataobjectfalsenenhumnone
»» list[object]falsenenhumnone
»»» idintegerfalsenenhumNúmero da conta
»»» usernamestringfalsenenhumNome da conta do agente
»»» passwordstringfalsenenhumSenha da conta do agente
»»» created_atstringfalsenenhumAdicionar tempo
»»» remarkstringfalsenenhumObservações
»»» product_typeproductTypesfalsenenhumTipo de pacote, 9 pacotes de tráfego residencial dinâmico, 11 IP residencial dinâmico, 14 IP de data center estático, 25 IP residencial estático
»»» usage_flowintegerfalsenenhumTráfego usado, unidade: KB
»»» limit_flowintegerfalsenenhumLimite de tráfego personalizado: a unidade máxima de GB é 102.400, 0 não é limite
»»» statusintegerfalsenenhumStatus ativado: 1 ativado, 0 desativado

Valores enumerados

PropriedadeValor
product_type9
product_type11
product_type14
product_type25
Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth, apiKeyAuth

Detecte limites de tráfego que podem ser definidos em contas proxy

Exemplos de código

# Você também pode usar wget
curl -X POST https://api.proxylite.com/end-point/whitelist-account/check \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/whitelist-account/check

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "account": "string"
}

Parâmetros

NomeEmTipoObrigatórioDescrição
bodybodyobjectfalsenenhum
» team_idbodyanyfalseIdentificação do espaço de recursos públicos; omita team_id ou passe uma string vazia ao solicitar um espaço pessoal e uma string vazia ao responder a um espaço pessoal; tanto o número 0 quanto a string "0" são ilegais, e o espaço da equipe usa uma identificação pública da equipe de 6 a 12 dígitos
»» anonymousbodystringfalsenenhum
»» anonymousbodyTeamPublicIdfalseLogotipo público da equipe, o primeiro caractere é uma letra ASCII e os demais caracteres contêm apenas letras e números ASCII; a chave primária numérica do banco de dados não foi emitida
» accountbodystringfalsePasse o nome da conta ao editar uma conta de agente existente

Exemplos de resposta

Resposta 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "isAgent": 0,
    "trendMax": 0,
    "staticMax": 0,
    "maxLimit": 0,
    "minLimit": 0
  },
  "request_id": "string"
}

Respostas

StatusSignificadoDescriçãoEsquema
200OKSolicitação bem-sucedidaInline

Esquema da resposta

Valores enumerados

PropriedadeValor
isAgent0
isAgent1
Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth, apiKeyAuth

Obtenha a cota da subconta do agente dinâmico e a quantidade usada

Exemplos de código

# Você também pode usar wget
curl -X GET https://api.proxylite.com/end-point/whitelist-account/child-account \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/whitelist-account/child-account

Parâmetros

NomeEmTipoObrigatórioDescrição
team_idqueryResourceSpaceIdfalseIdentificador de espaço de recursos; espaço pessoal omite ou passa uma string vazia

Exemplos de resposta

Resposta 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "totalChildAccount": 0,
    "usedChildAccount": 0
  },
  "request_id": "string"
}

Respostas

StatusSignificadoDescriçãoEsquema
200OKSolicitação bem-sucedidaInline

Esquema da resposta

Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth, apiKeyAuth

Adicione a conta do agente. (POST /end-point/whitelist-account/add)

Exemplos de código

# Você também pode usar wget
curl -X POST https://api.proxylite.com/end-point/whitelist-account/add \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/whitelist-account/add

Body parameter

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

Parâmetros

NomeEmTipoObrigatórioDescrição
bodybodyobjectfalsenenhum
» team_idbodyanyfalseIdentificação do espaço de recursos públicos; omita team_id ou passe uma string vazia ao solicitar um espaço pessoal e uma string vazia ao responder a um espaço pessoal; tanto o número 0 quanto a string "0" são ilegais, e o espaço da equipe usa uma identificação pública da equipe de 6 a 12 dígitos
»» anonymousbodystringfalsenenhum
»» anonymousbodyTeamPublicIdfalseLogotipo público da equipe, o primeiro caractere é uma letra ASCII e os demais caracteres contêm apenas letras e números ASCII; a chave primária numérica do banco de dados não foi emitida
» app_keybodystringfalseChave de autorização
» accountsbodystringtrueSenha da conta, preencha-a no formato nome de usuário:senha. A conta e a senha suportam apenas números e letras. É proibido inserir símbolos ou espaços especiais. Dois pontos separam a conta e a senha. A adição em lote é suportada e as contas dos agentes são separadas por vírgulas (,).
» remarkbodystringfalseDescrição da conta do agente
» product_typebodyproductTypesfalseTipo de pacote, 9 pacotes de tráfego residencial dinâmico, 11 IP residencial dinâmico, 14 IP de data center estático, 25 IP residencial estático

Valores enumerados

ParameterValue
» product_type9
» product_type11
» product_type14
» product_type25

Exemplos de resposta

Resposta 200

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

Respostas

StatusSignificadoDescriçãoEsquema
200OKSolicitação bem-sucedidaInline

Esquema da resposta

Status Code 200

NomeTipoObrigatórioRestriçõesDescrição
» codeintegerfalsenenhumCódigo de status, 200 bem-sucedido, 3 app_key inválido, 156 conta não autenticada.
» msgstringfalsenenhummensagem de estado
» datanullfalsenenhumnone
Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth, apiKeyAuth

Excluir conta proxy (POST /end-point/whitelist-account/delete)

Exemplos de código

# Você também pode usar wget
curl -X POST https://api.proxylite.com/end-point/whitelist-account/delete \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/whitelist-account/delete

Observe que ele não pode ser restaurado após a exclusão e o tráfego usado não pode ser consultado. Haverá um tempo de espera de aproximadamente 5 minutos para exclusão, durante o qual ainda poderão ocorrer cobranças.

Body parameter

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

Parâmetros

NomeEmTipoObrigatórioDescrição
bodybodyobjectfalsenenhum
» team_idbodyanyfalseIdentificação do espaço de recursos públicos; omita team_id ou passe uma string vazia ao solicitar um espaço pessoal e uma string vazia ao responder a um espaço pessoal; tanto o número 0 quanto a string "0" são ilegais, e o espaço da equipe usa uma identificação pública da equipe de 6 a 12 dígitos
»» anonymousbodystringfalsenenhum
»» anonymousbodyTeamPublicIdfalseLogotipo público da equipe, o primeiro caractere é uma letra ASCII e os demais caracteres contêm apenas letras e números ASCII; a chave primária numérica do banco de dados não foi emitida
» app_keybodystringfalseChave de autorização
» accountsbodystringtrueConta de agente, apenas números e letras são suportados. Suporte a operações em lote, vírgulas em inglês (,) contas de agente separadas

Exemplos de resposta

Resposta 200

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

Respostas

StatusSignificadoDescriçãoEsquema
200OKSolicitação bem-sucedidaInline

Esquema da resposta

Status Code 200

NomeTipoObrigatórioRestriçõesDescrição
» codeintegerfalsenenhumCódigo de status, 200 bem-sucedido, 3 app_key inválido, 156 conta não autenticada.
» msgstringfalsenenhummensagem de estado
» datanullfalsenenhumnone
Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth, apiKeyAuth

Desativar conta proxy (POST /end-point/whitelist-account/disable)

Exemplos de código

# Você também pode usar wget
curl -X POST https://api.proxylite.com/end-point/whitelist-account/disable \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/whitelist-account/disable

Haverá um tempo de espera de aproximadamente 5 minutos para desativação, período durante o qual ainda poderão ser incorridas cobranças.

Body parameter

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

Parâmetros

NomeEmTipoObrigatórioDescrição
bodybodyobjectfalsenenhum
» team_idbodyanyfalseIdentificação do espaço de recursos públicos; omita team_id ou passe uma string vazia ao solicitar um espaço pessoal e uma string vazia ao responder a um espaço pessoal; tanto o número 0 quanto a string "0" são ilegais, e o espaço da equipe usa uma identificação pública da equipe de 6 a 12 dígitos
»» anonymousbodystringfalsenenhum
»» anonymousbodyTeamPublicIdfalseLogotipo público da equipe, o primeiro caractere é uma letra ASCII e os demais caracteres contêm apenas letras e números ASCII; a chave primária numérica do banco de dados não foi emitida
» app_keybodystringfalseChave de autorização
» accountsbodystringtrueConta de agente, apenas números e letras são suportados. Suporte a operações em lote, vírgulas em inglês (,) contas de agente separadas

Exemplos de resposta

Resposta 200

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

Respostas

StatusSignificadoDescriçãoEsquema
200OKSolicitação bem-sucedidaInline

Esquema da resposta

Status Code 200

NomeTipoObrigatórioRestriçõesDescrição
» codeintegerfalsenenhumCódigo de status, 200 bem-sucedido, 3 app_key inválido, 156 conta não autenticada.
» msgstringfalsenenhummensagem de estado
» datanullfalsenenhumnone
Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth, apiKeyAuth

Habilitar conta proxy (POST /end-point/whitelist-account/enable)

Exemplos de código

# Você também pode usar wget
curl -X POST https://api.proxylite.com/end-point/whitelist-account/enable \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/whitelist-account/enable

Body parameter

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

Parâmetros

NomeEmTipoObrigatórioDescrição
bodybodyobjectfalsenenhum
» team_idbodyanyfalseIdentificação do espaço de recursos públicos; omita team_id ou passe uma string vazia ao solicitar um espaço pessoal e uma string vazia ao responder a um espaço pessoal; tanto o número 0 quanto a string "0" são ilegais, e o espaço da equipe usa uma identificação pública da equipe de 6 a 12 dígitos
»» anonymousbodystringfalsenenhum
»» anonymousbodyTeamPublicIdfalseLogotipo público da equipe, o primeiro caractere é uma letra ASCII e os demais caracteres contêm apenas letras e números ASCII; a chave primária numérica do banco de dados não foi emitida
» app_keybodystringfalseChave de autorização
» accountsbodystringtrueConta de agente, apenas números e letras são suportados. Suporte a operações em lote, vírgulas em inglês (,) contas de agente separadas

Exemplos de resposta

Resposta 200

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

Respostas

StatusSignificadoDescriçãoEsquema
200OKSolicitação bem-sucedidaInline

Esquema da resposta

Status Code 200

NomeTipoObrigatórioRestriçõesDescrição
» codeintegerfalsenenhumCódigo de status, 200 bem-sucedido, 3 app_key inválido, 156 conta não autenticada.
» msgstringfalsenenhummensagem de estado
» datanullfalsenenhumnone
Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth, apiKeyAuth

Alterar a senha da conta do agente

Exemplos de código

# Você também pode usar wget
curl -X POST https://api.proxylite.com/end-point/whitelist-account/change-password \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

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

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

Body parameter

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

Parâmetros

NomeEmTipoObrigatórioDescrição
bodybodyobjectfalsenenhum
» team_idbodyanyfalseIdentificação do espaço de recursos públicos; omita team_id ou passe uma string vazia ao solicitar um espaço pessoal e uma string vazia ao responder a um espaço pessoal; tanto o número 0 quanto a string "0" são ilegais, e o espaço da equipe usa uma identificação pública da equipe de 6 a 12 dígitos
»» anonymousbodystringfalsenenhum
»» anonymousbodyTeamPublicIdfalseLogotipo público da equipe, o primeiro caractere é uma letra ASCII e os demais caracteres contêm apenas letras e números ASCII; a chave primária numérica do banco de dados não foi emitida
» app_keybodystringfalseChave de autorização
» accountbodystringtrueConta de agente, apenas números e letras são suportados.
» passwordbodystringtrueA nova senha da conta do agente suporta apenas números e letras.

Exemplos de resposta

Resposta 200

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

Respostas

StatusSignificadoDescriçãoEsquema
200OKSolicitação bem-sucedidaInline

Esquema da resposta

Status Code 200

NomeTipoObrigatórioRestriçõesDescrição
» codeintegerfalsenenhumCódigo de status, 200 bem-sucedido, 3 app_key inválido, 156 conta não autenticada.
» msgstringfalsenenhummensagem de estado
» datanullfalsenenhumnone
Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth, apiKeyAuth

Modificar comentários da conta do agente

Exemplos de código

# Você também pode usar wget
curl -X POST https://api.proxylite.com/end-point/whitelist-account/change-remark \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

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

Body parameter

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

Parâmetros

NomeEmTipoObrigatórioDescrição
bodybodyobjectfalsenenhum
» team_idbodyanyfalseIdentificação do espaço de recursos públicos; omita team_id ou passe uma string vazia ao solicitar um espaço pessoal e uma string vazia ao responder a um espaço pessoal; tanto o número 0 quanto a string "0" são ilegais, e o espaço da equipe usa uma identificação pública da equipe de 6 a 12 dígitos
»» anonymousbodystringfalsenenhum
»» anonymousbodyTeamPublicIdfalseLogotipo público da equipe, o primeiro caractere é uma letra ASCII e os demais caracteres contêm apenas letras e números ASCII; a chave primária numérica do banco de dados não foi emitida
» app_keybodystringfalseChave de autorização
» accountbodystringtrueConta de agente, apenas números e letras são suportados.
» remarkbodystringtrueNovas observações para contas de agências, com até 32 caracteres chineses ou 64 caracteres ingleses.

Exemplos de resposta

Resposta 200

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

Respostas

StatusSignificadoDescriçãoEsquema
200OKSolicitação bem-sucedidaInline

Esquema da resposta

Status Code 200

NomeTipoObrigatórioRestriçõesDescrição
» codeintegerfalsenenhumCódigo de status, 200 bem-sucedido, 3 app_key inválido, 156 conta não autenticada.
» msgstringfalsenenhummensagem de estado
» datanullfalsenenhumnone
Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth, apiKeyAuth

Modifique o limite de tráfego da conta proxy

Exemplos de código

# Você também pode usar wget
curl -X POST https://api.proxylite.com/end-point/whitelist-account/change-limit \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

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

Observe que as estatísticas de tráfego podem sofrer atrasos de 5 minutos, ou seja, o tráfego real consumido pode exceder esse limite.

Body parameter

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

Parâmetros

NomeEmTipoObrigatórioDescrição
bodybodyobjectfalsenenhum
» team_idbodyanyfalseIdentificação do espaço de recursos públicos; omita team_id ou passe uma string vazia ao solicitar um espaço pessoal e uma string vazia ao responder a um espaço pessoal; tanto o número 0 quanto a string "0" são ilegais, e o espaço da equipe usa uma identificação pública da equipe de 6 a 12 dígitos
»» anonymousbodystringfalsenenhum
»» anonymousbodyTeamPublicIdfalseLogotipo público da equipe, o primeiro caractere é uma letra ASCII e os demais caracteres contêm apenas letras e números ASCII; a chave primária numérica do banco de dados não foi emitida
» app_keybodystringfalseChave de autorização
» accountbodystringtrueConta de agente, apenas números e letras são suportados.
» limitbodyintegerfalseLimite de tráfego, unidade: GB, 0 significa sem limite superior

Exemplos de resposta

Resposta 200

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

Respostas

StatusSignificadoDescriçãoEsquema
200OKSolicitação bem-sucedidaInline

Esquema da resposta

Status Code 200

NomeTipoObrigatórioRestriçõesDescrição
» codeintegerfalsenenhumCódigo de status, 200 bem-sucedido, 3 app_key inválido, 156 conta não autenticada.
» msgstringfalsenenhummensagem de estado
» datanullfalsenenhumnone
Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth, apiKeyAuth

Crie rapidamente uma conta de agente

Exemplos de código

# Você também pode usar wget
curl -X POST https://api.proxylite.com/end-point/whitelist-account/quick-add \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/whitelist-account/quick-add

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "product_type": 0
}

Parâmetros

NomeEmTipoObrigatórioDescrição
bodybodyobjecttruenenhum
» team_idbodyanyfalseIdentificação do espaço de recursos públicos; omita team_id ou passe uma string vazia ao solicitar um espaço pessoal e uma string vazia ao responder a um espaço pessoal; tanto o número 0 quanto a string "0" são ilegais, e o espaço da equipe usa uma identificação pública da equipe de 6 a 12 dígitos
»» anonymousbodystringfalsenenhum
»» anonymousbodyTeamPublicIdfalseLogotipo público da equipe, o primeiro caractere é uma letra ASCII e os demais caracteres contêm apenas letras e números ASCII; a chave primária numérica do banco de dados não foi emitida
» product_typebodyintegertruenenhum

Exemplos de resposta

Resposta 200

{
  "code": 0,
  "msg": "string",
  "request_id": "string",
  "data": {
    "username": "string",
    "password": "string"
  }
}

Respostas

StatusSignificadoDescriçãoEsquema
200OKUma nova conta e senha serão devolvidas quando o negócio for bem-sucedido.Inline

Esquema da resposta

Status Code 200

NomeTipoObrigatórioRestriçõesDescrição
» codeintegerfalsenenhumnone
» msgstringfalsenenhumnone
» request_idstringfalsenenhumnone
» dataanyfalsenenhumnone

oneOf

NomeTipoObrigatórioRestriçõesDescrição
»» anonymousobjectfalsenenhumnone
»»» usernamestringtruenenhumnone
»»» passwordstringtruenenhumnone

xor

NomeTipoObrigatórioRestriçõesDescrição
»» anonymousnullfalsenenhumnone
Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth, apiKeyAuth

Modifique o limite diário de tráfego da conta do agente

Exemplos de código

# Você também pode usar wget
curl -X POST https://api.proxylite.com/end-point/whitelist-account/change-daily-limit \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

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

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "account": "string",
  "daily_limit": 0
}

Parâmetros

NomeEmTipoObrigatórioDescrição
bodybodyobjecttruenenhum
» team_idbodyanyfalseIdentificação do espaço de recursos públicos; omita team_id ou passe uma string vazia ao solicitar um espaço pessoal e uma string vazia ao responder a um espaço pessoal; tanto o número 0 quanto a string "0" são ilegais, e o espaço da equipe usa uma identificação pública da equipe de 6 a 12 dígitos
»» anonymousbodystringfalsenenhum
»» anonymousbodyTeamPublicIdfalseLogotipo público da equipe, o primeiro caractere é uma letra ASCII e os demais caracteres contêm apenas letras e números ASCII; a chave primária numérica do banco de dados não foi emitida
» accountbodystringtruenenhum
» daily_limitbodyintegerfalseUnidade GB

Exemplos de resposta

Resposta 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Respostas

StatusSignificadoDescriçãoEsquema
200OKOperação bem-sucedidaWebV1SuccessResponse
Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth, apiKeyAuth

Modificar informações da conta do agente (POST /end-point/whitelist-account/change)

Exemplos de código

# Você também pode usar wget
curl -X POST https://api.proxylite.com/end-point/whitelist-account/change \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/whitelist-account/change

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "account": "string",
  "password": "string",
  "remark": "string",
  "limit": 0,
  "daily_limit": 0,
  "status": 0,
  "udp": 0
}

Parâmetros

NomeEmTipoObrigatórioDescrição
bodybodyobjecttruenenhum
» team_idbodyanyfalseIdentificação do espaço de recursos públicos; omita team_id ou passe uma string vazia ao solicitar um espaço pessoal e uma string vazia ao responder a um espaço pessoal; tanto o número 0 quanto a string "0" são ilegais, e o espaço da equipe usa uma identificação pública da equipe de 6 a 12 dígitos
»» anonymousbodystringfalsenenhum
»» anonymousbodyTeamPublicIdfalseLogotipo público da equipe, o primeiro caractere é uma letra ASCII e os demais caracteres contêm apenas letras e números ASCII; a chave primária numérica do banco de dados não foi emitida
» accountbodystringtruenenhum
» passwordbodystringfalsenenhum
» remarkbodystringfalsenenhum
» limitbodyintegerfalseLimite total de tráfego em GB
» daily_limitbodyintegerfalseLimite de tráfego diário em GB
» statusbodyintegerfalsenenhum
» udpbodyintegerfalsenenhum

Valores enumerados

ParameterValue
» status0
» status1
» udp0
» udp1

Exemplos de resposta

Resposta 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Respostas

StatusSignificadoDescriçãoEsquema
200OKOperação bem-sucedidaWebV1SuccessResponse
Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth, apiKeyAuth

Atualize o cache de autenticação da conta proxy do espaço de recursos atual

Exemplos de código

# Você também pode usar wget
curl -X POST https://api.proxylite.com/end-point/whitelist-account/refresh \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/whitelist-account/refresh

Body parameter

{
  "team_id": "A1b2C3d4E5f6"
}

Parâmetros

NomeEmTipoObrigatórioDescrição
bodybodyobjectfalsenenhum
» team_idbodyanyfalseIdentificação do espaço de recursos públicos; omita team_id ou passe uma string vazia ao solicitar um espaço pessoal e uma string vazia ao responder a um espaço pessoal; tanto o número 0 quanto a string "0" são ilegais, e o espaço da equipe usa uma identificação pública da equipe de 6 a 12 dígitos
»» anonymousbodystringfalsenenhum
»» anonymousbodyTeamPublicIdfalseLogotipo público da equipe, o primeiro caractere é uma letra ASCII e os demais caracteres contêm apenas letras e números ASCII; a chave primária numérica do banco de dados não foi emitida

Exemplos de resposta

Resposta 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Respostas

StatusSignificadoDescriçãoEsquema
200OKOperação bem-sucedidaWebV1SuccessResponse
Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth, apiKeyAuth

Cota de conta de agência para tipos de produtos específicos

Exemplos de código

# Você também pode usar wget
curl -X GET https://api.proxylite.com/end-point/whitelist-account/quota?product_type=0 \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/whitelist-account/quota

Parâmetros

NomeEmTipoObrigatórioDescrição
team_idqueryResourceSpaceIdfalsenenhum
product_typequeryintegertruenenhum

Exemplos de resposta

Resposta 200

{
  "code": 0,
  "msg": "string",
  "request_id": "string",
  "data": {
    "usage": 0,
    "limit": 0,
    "expand": 0
  }
}

Respostas

StatusSignificadoDescriçãoEsquema
200OKSolicitação bem-sucedidaInline

Esquema da resposta

Status Code 200

NomeTipoObrigatórioRestriçõesDescrição
» codeintegerfalsenenhumnone
» msgstringfalsenenhumnone
» request_idstringfalsenenhumnone
» dataobjectfalsenenhumnone
»» usageintegertruenenhumnone
»» limitintegertruenenhumnone
»» expandintegertruenenhumnone
Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth, apiKeyAuth

Cotas de conta de agência para todos os tipos de produtos

Exemplos de código

# Você também pode usar wget
curl -X GET https://api.proxylite.com/end-point/whitelist-account/quotas \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/whitelist-account/quotas

Parâmetros

NomeEmTipoObrigatórioDescrição
team_idqueryResourceSpaceIdfalsenenhum

Exemplos de resposta

Resposta 200

{
  "code": 0,
  "msg": "string",
  "request_id": "string",
  "data": {
    "list": [
      {
        "product_type": 0,
        "limit": 0,
        "usage": 0
      }
    ]
  }
}

Respostas

StatusSignificadoDescriçãoEsquema
200OKSolicitação bem-sucedidaInline

Esquema da resposta

Status Code 200

NomeTipoObrigatórioRestriçõesDescrição
» codeintegerfalsenenhumnone
» msgstringfalsenenhumnone
» request_idstringfalsenenhumnone
» dataobjectfalsenenhumnone
»» list[object]falsenenhumnone
»»» product_typeintegerfalsenenhumnone
»»» limitintegerfalsenenhumnone
»»» usageintegerfalsenenhumnone
Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth, apiKeyAuth

Lista de contas de agente (GET /end-point/proxy-account/list)

Exemplos de código

# Você também pode usar wget
curl -X GET https://api.proxylite.com/end-point/proxy-account/list \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/proxy-account/list

Parâmetros

NomeEmTipoObrigatórioDescrição
team_idqueryResourceSpaceIdfalseIdentificador de espaço de recursos; omita o espaço pessoal ou passe uma string vazia; A chave da equipe pode ser omitida e deve ser consistente com a chave quando passada

Exemplos de resposta

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

Respostas

StatusSignificadoDescriçãoEsquema
200OKSolicitação bem-sucedidaInline

Esquema da resposta

Status Code 200

NomeTipoObrigatórioRestriçõesDescrição
» coderesponseCodefalsenenhumCódigo de status, 200 bem-sucedido, 3 app_key inválido
» msgstringfalsenenhummensagem de estado
» dataobjectfalsenenhumnone
»» list[object]falsenenhumnone
»»» idintegerfalsenenhumNúmero da conta
»»» usernamestringfalsenenhumNome da conta do agente
»»» passwordstringfalsenenhumSenha da conta do agente
»»» created_atstringfalsenenhumAdicionar tempo
»»» remarkstringfalsenenhumObservações
»»» product_typeproductTypesfalsenenhumTipo de pacote, 9 pacotes de tráfego residencial dinâmico, 11 IP residencial dinâmico, 14 IP de data center estático, 25 IP residencial estático
»»» usage_flowintegerfalsenenhumTráfego usado, unidade: KB
»»» limit_flowintegerfalsenenhumLimite de tráfego personalizado: a unidade máxima de GB é 102.400, 0 não é limite
»»» statusintegerfalsenenhumStatus ativado: 1 ativado, 0 desativado

Valores enumerados

PropriedadeValor
product_type9
product_type11
product_type14
product_type25
Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth, apiKeyAuth

Adicione a conta do agente. (POST /end-point/proxy-account/add)

Exemplos de código

# Você também pode usar wget
curl -X POST https://api.proxylite.com/end-point/proxy-account/add \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/proxy-account/add

Body parameter

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

Parâmetros

NomeEmTipoObrigatórioDescrição
bodybodyobjectfalsenenhum
» team_idbodyanyfalseIdentificação do espaço de recursos públicos; omita team_id ou passe uma string vazia ao solicitar um espaço pessoal e uma string vazia ao responder a um espaço pessoal; tanto o número 0 quanto a string "0" são ilegais, e o espaço da equipe usa uma identificação pública da equipe de 6 a 12 dígitos
»» anonymousbodystringfalsenenhum
»» anonymousbodyTeamPublicIdfalseLogotipo público da equipe, o primeiro caractere é uma letra ASCII e os demais caracteres contêm apenas letras e números ASCII; a chave primária numérica do banco de dados não foi emitida
» app_keybodystringfalseChave de autorização
» accountsbodystringtrueSenha da conta, preencha-a no formato nome de usuário:senha. A conta e a senha suportam apenas números e letras. É proibido inserir símbolos ou espaços especiais. Dois pontos separam a conta e a senha. A adição em lote é suportada e as contas dos agentes são separadas por vírgulas (,).
» remarkbodystringfalseDescrição da conta do agente
» product_typebodyproductTypesfalseTipo de pacote, 9 pacotes de tráfego residencial dinâmico, 11 IP residencial dinâmico, 14 IP de data center estático, 25 IP residencial estático

Valores enumerados

ParameterValue
» product_type9
» product_type11
» product_type14
» product_type25

Exemplos de resposta

Resposta 200

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

Respostas

StatusSignificadoDescriçãoEsquema
200OKSolicitação bem-sucedidaInline

Esquema da resposta

Status Code 200

NomeTipoObrigatórioRestriçõesDescrição
» codeintegerfalsenenhumCódigo de status, 200 bem-sucedido, 3 app_key inválido, 156 conta não autenticada.
» msgstringfalsenenhummensagem de estado
» datanullfalsenenhumnone
Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth, apiKeyAuth

Excluir conta proxy (POST /end-point/proxy-account/delete)

Exemplos de código

# Você também pode usar wget
curl -X POST https://api.proxylite.com/end-point/proxy-account/delete \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/proxy-account/delete

Observe que ele não pode ser restaurado após a exclusão e o tráfego usado não pode ser consultado. Haverá um tempo de espera de aproximadamente 5 minutos para exclusão, durante o qual ainda poderão ocorrer cobranças.

Body parameter

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

Parâmetros

NomeEmTipoObrigatórioDescrição
bodybodyobjectfalsenenhum
» team_idbodyanyfalseIdentificação do espaço de recursos públicos; omita team_id ou passe uma string vazia ao solicitar um espaço pessoal e uma string vazia ao responder a um espaço pessoal; tanto o número 0 quanto a string "0" são ilegais, e o espaço da equipe usa uma identificação pública da equipe de 6 a 12 dígitos
»» anonymousbodystringfalsenenhum
»» anonymousbodyTeamPublicIdfalseLogotipo público da equipe, o primeiro caractere é uma letra ASCII e os demais caracteres contêm apenas letras e números ASCII; a chave primária numérica do banco de dados não foi emitida
» app_keybodystringfalseChave de autorização
» accountsbodystringtrueConta de agente, apenas números e letras são suportados. Suporte a operações em lote, vírgulas em inglês (,) contas de agente separadas

Exemplos de resposta

Resposta 200

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

Respostas

StatusSignificadoDescriçãoEsquema
200OKSolicitação bem-sucedidaInline

Esquema da resposta

Status Code 200

NomeTipoObrigatórioRestriçõesDescrição
» codeintegerfalsenenhumCódigo de status, 200 bem-sucedido, 3 app_key inválido, 156 conta não autenticada.
» msgstringfalsenenhummensagem de estado
» datanullfalsenenhumnone
Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth, apiKeyAuth

Habilitar conta proxy (POST /end-point/proxy-account/enable)

Exemplos de código

# Você também pode usar wget
curl -X POST https://api.proxylite.com/end-point/proxy-account/enable \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/proxy-account/enable

Body parameter

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

Parâmetros

NomeEmTipoObrigatórioDescrição
bodybodyobjectfalsenenhum
» team_idbodyanyfalseIdentificação do espaço de recursos públicos; omita team_id ou passe uma string vazia ao solicitar um espaço pessoal e uma string vazia ao responder a um espaço pessoal; tanto o número 0 quanto a string "0" são ilegais, e o espaço da equipe usa uma identificação pública da equipe de 6 a 12 dígitos
»» anonymousbodystringfalsenenhum
»» anonymousbodyTeamPublicIdfalseLogotipo público da equipe, o primeiro caractere é uma letra ASCII e os demais caracteres contêm apenas letras e números ASCII; a chave primária numérica do banco de dados não foi emitida
» app_keybodystringfalseChave de autorização
» accountsbodystringtrueConta de agente, apenas números e letras são suportados. Suporte a operações em lote, vírgulas em inglês (,) contas de agente separadas

Exemplos de resposta

Resposta 200

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

Respostas

StatusSignificadoDescriçãoEsquema
200OKSolicitação bem-sucedidaInline

Esquema da resposta

Status Code 200

NomeTipoObrigatórioRestriçõesDescrição
» codeintegerfalsenenhumCódigo de status, 200 bem-sucedido, 3 app_key inválido, 156 conta não autenticada.
» msgstringfalsenenhummensagem de estado
» datanullfalsenenhumnone
Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth, apiKeyAuth

Desativar conta proxy (POST /end-point/proxy-account/disable)

Exemplos de código

# Você também pode usar wget
curl -X POST https://api.proxylite.com/end-point/proxy-account/disable \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/proxy-account/disable

Haverá um tempo de espera de aproximadamente 5 minutos para desativação, período durante o qual ainda poderão ser incorridas cobranças.

Body parameter

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

Parâmetros

NomeEmTipoObrigatórioDescrição
bodybodyobjectfalsenenhum
» team_idbodyanyfalseIdentificação do espaço de recursos públicos; omita team_id ou passe uma string vazia ao solicitar um espaço pessoal e uma string vazia ao responder a um espaço pessoal; tanto o número 0 quanto a string "0" são ilegais, e o espaço da equipe usa uma identificação pública da equipe de 6 a 12 dígitos
»» anonymousbodystringfalsenenhum
»» anonymousbodyTeamPublicIdfalseLogotipo público da equipe, o primeiro caractere é uma letra ASCII e os demais caracteres contêm apenas letras e números ASCII; a chave primária numérica do banco de dados não foi emitida
» app_keybodystringfalseChave de autorização
» accountsbodystringtrueConta de agente, apenas números e letras são suportados. Suporte a operações em lote, vírgulas em inglês (,) contas de agente separadas

Exemplos de resposta

Resposta 200

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

Respostas

StatusSignificadoDescriçãoEsquema
200OKSolicitação bem-sucedidaInline

Esquema da resposta

Status Code 200

NomeTipoObrigatórioRestriçõesDescrição
» codeintegerfalsenenhumCódigo de status, 200 bem-sucedido, 3 app_key inválido, 156 conta não autenticada.
» msgstringfalsenenhummensagem de estado
» datanullfalsenenhumnone
Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth, apiKeyAuth

Modificar informações da conta do agente (POST /end-point/proxy-account/change)

Exemplos de código

# Você também pode usar wget
curl -X POST https://api.proxylite.com/end-point/proxy-account/change \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/proxy-account/change

Modifique a senha da conta proxy, comentários, limite de tráfego, limite de tráfego diário, status ativado ou opção UDP.

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "app_key": "string",
  "account": "string",
  "password": "string",
  "remark": "string",
  "limit": 0,
  "daily_limit": 0,
  "status": 0,
  "udp": 0
}

Parâmetros

NomeEmTipoObrigatórioDescrição
bodybodyobjectfalsenenhum
» team_idbodyanyfalseIdentificação do espaço de recursos públicos; omita team_id ou passe uma string vazia ao solicitar um espaço pessoal e uma string vazia ao responder a um espaço pessoal; tanto o número 0 quanto a string "0" são ilegais, e o espaço da equipe usa uma identificação pública da equipe de 6 a 12 dígitos
»» anonymousbodystringfalsenenhum
»» anonymousbodyTeamPublicIdfalseLogotipo público da equipe, o primeiro caractere é uma letra ASCII e os demais caracteres contêm apenas letras e números ASCII; a chave primária numérica do banco de dados não foi emitida
» app_keybodystringfalseChave de autorização
» accountbodystringtrueNome da conta do agente
» passwordbodystringfalseNova senha, de 6 a 16 dígitos ou letras; se não for aprovado, não será modificado.
» remarkbodystringfalseNova nota
» limitbodyintegerfalseLimite de tráfego, unidade GB, 0 significa sem limite
» daily_limitbodyintegerfalseLimite de tráfego diário em GB, 0 significa sem limite
» statusbodyintegerfalseStatus ativado
» udpbodyintegerfalseSwitch de suporte UDP, efetivo apenas para tipos de pacote 14, 16, 21 e 25

Valores enumerados

ParameterValue
» status0
» status1
» udp0
» udp1

Exemplos de resposta

Resposta 200

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

Respostas

StatusSignificadoDescriçãoEsquema
200OKSolicitação bem-sucedidaInline

Esquema da resposta

Status Code 200

NomeTipoObrigatórioRestriçõesDescrição
» codeintegerfalsenenhumCódigo de status, 200 sucessos
» msgstringfalsenenhummensagem de estado
» datanullfalsenenhumnone
Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth, apiKeyAuth

Gerar informações de conexão proxy

Exemplos de código

# Você também pode usar wget
curl -X GET https://api.proxylite.com/end-point/whitelist-account/format?ac=0 \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/whitelist-account/format

Suporta chaves de API pessoais e de equipe. Somente as contas do agente que têm acesso ao espaço de recursos atual são retornadas e os tipos de pacote 9, 11 e 12 são suportados. JSON/XML retorna uma lista estruturada de contas; txt/csv retorna uma string de conexão emendada no formato f.

Parâmetros

NomeEmTipoObrigatórioDescrição
acqueryinteger,stringtrueID da conta do agente ou nome de usuário; conta de parâmetro compatível
aequerystringfalsenenhum
stquerystringfalsenenhum
ctquerystringfalsenenhum
lfqueryintegerfalsenenhum
nqueryintegerfalsenenhum
fqueryintegerfalseAfeta apenas o formato da cadeia de conexão de txt/csv
typequerystringfalsenenhum
lbquerystringfalsenenhum
epquerystringfalsenenhum
team_idqueryResourceSpaceIdfalsenenhum

Valores enumerados

ParameterValue
f1
f2
f3
f4
f5
typejson
typexml
typetxt
typecsv

Exemplos de resposta

Resposta 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "username": "string",
        "password": "string",
        "server": "string",
        "port": 0
      }
    ]
  },
  "request_id": "string"
}
"string"
<?xml version="1.0" encoding="UTF-8" ?>
<WebV1SuccessResponse>
  <code>200</code>
  <msg>SUCCESS</msg>
  <data/>
  <request_id>string</request_id>
</WebV1SuccessResponse>

Respostas

StatusSignificadoDescriçãoEsquema
200OKHTTP bem-sucedido; verifique o código comercial, 200 significa sucesso.WebV1SuccessResponse
Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth, apiKeyAuth

Gerenciamento de pedidos

Criação de pedidos, consulta, cancelamento, etc.

lista de pedidos

Exemplos de código

# Você também pode usar wget
curl -X GET https://api.proxylite.com/end-point/order/list \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/order/list

Os pedidos de espaço da equipe também retornam ao criador, indicando o verdadeiro membro do pedido; administradores e superadministradores podem ver as informações de contato completas, e outras funções retornam informações de contato insensíveis.

Parâmetros

NomeEmTipoObrigatórioDescrição
team_idqueryResourceSpaceIdfalseIdentificador do espaço de recursos do pedido; espaço pessoal omite ou passa uma string vazia
page_noqueryintegerfalsenenhum
page_sizequeryintegerfalsenenhum
trade_noquerystringfalsenúmero do pedido
start_timequerystring(date-time)falseHora de início (inclusive), como 01/01/2024 00:00:00
end_timequerystring(date-time)falseHorário de término (não incluído)
statusqueryintegerfalseStatus do pedido
product_typequeryintegerfalsetipo de produto
invoicequeryintegerfalseStatus da fatura: 0 sem limite 1 faturada -1 não faturada (pode ser reemitida)
pay_fee_statusqueryintegerfalseTriagem de pagamentos longos e curtos: 1 Pagamento a maior 2 Pagamento a curto prazo

Detailed descriptions

status: Status do pedido

EstadoDescrição
0Pagamento pendente
1Pago
2Cancelado por horas extras e falta de pagamento
3Reembolsado

product_type: tipo de produto

Tipo de produtoDescrição
3Recarga de saldo
9Pacote de tráfego dinâmico
11Pacote de tempo global dinâmico V2
12Pacote de tráfego IDC de longo prazo
13Pacote de tráfego IP estático residencial
14Pacote IP estático do data center
15Pacote de tráfego ISP de longo prazo
16Pacote de tráfego estático
17Pacote de quantidade de IP dinâmico
18raspador de teia
19Renovação de IP estático
20Cota de substituição de IP estático
21Pacote de tráfego estático v2
24Pacote complementar de tráfego estático
25Pacote IP Estático Residencial
26Ordem de reposição - Alguns canais de pagamento exigem que os usuários preencham manualmente o valor, como moeda virtual. Se ocorrer um pagamento curto, você precisará entrar em contato com o atendimento ao cliente para efetuar o reembolso por meio deste produto
27Serpente
28Vídeo

Valores enumerados

ParameterValue
status0
status1
status2
status3
product_type3
product_type9
product_type11
product_type12
product_type14
product_type16
product_type17
product_type18
product_type19
product_type21
product_type24
product_type25
product_type26
product_type27
product_type28
invoice-1
invoice0
invoice1
pay_fee_status1
pay_fee_status2

Exemplos de resposta

Resposta 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "id": 0,
        "trade_no": "string",
        "out_trade_no": "string",
        "product_id": 0,
        "product_type": 0,
        "amount": 0,
        "unit_price": 0.1,
        "total_fee": 0.1,
        "goods_fee": 0.1,
        "pay_fee": 0.1,
        "discount_fee": 0.1,
        "handling_fee": 0.1,
        "refund_fee": 0.1,
        "pm_id": 0,
        "pm_title": "string",
        "pm_logo": "string",
        "status": 0,
        "title": "string",
        "detail": "string",
        "region_desc": "string",
        "pay_at": "2019-08-24T14:15:22Z",
        "pay_timestamp": 0,
        "created_at": "2019-08-24T14:15:22Z",
        "pay_fee_status": 0,
        "invoice": {
          "name": "string",
          "org_name": "string",
          "first_name": "string",
          "last_name": "string",
          "phone": "string",
          "email": "[email protected]",
          "role_type": 0,
          "vat_id": "string",
          "address_country": "string",
          "address_city": "string",
          "address_line1": "string",
          "address_line2": "string",
          "address_postal_code": "string"
        }
      }
    ],
    "pagination": {
      "total": 0,
      "page_no": 0,
      "page_size": 0,
      "total_pages": 0
    }
  },
  "request_id": "string"
}

Respostas

StatusSignificadoDescriçãoEsquema
200OKsucessoInline

Esquema da resposta

Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth, apiKeyAuth

Criar pedido

Exemplos de código

# Você também pode usar wget
curl -X POST https://api.proxylite.com/end-point/order/create \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/order/create

Como existem muitos tipos de pacotes e cada pacote possui configurações diferentes, preencha os parâmetros de acordo com a situação real. O preenchimento incorreto dos parâmetros pode resultar em falha na criação do pedido.

exemplos:

Renovar IP estático

{
    "pid": ID do pacote, // obtido da interface /openapi/product
    "upids": "1,2,3,4,5,6", // Obtenha o campo id correspondente da interface /openapi/ip/get-static-ip
    "pm_id": 1 // Obtido da interface /openapi/payment/list ou /openapi/payment/groups
  }

Compra de IP residencial estático

{
  "pid": ID do pacote, // obtido da interface /openapi/product
  "pm_id": ID do método de pagamento, // obtido da interface /openapi/payment/list ou /openapi/payment/groups
  "region_list": "JP,15,333|DE,10,444|US,5,555" // Formato: região, quantidade, ASN|região, quantidade, ASN (número ASN opcional)
}

Compra de IP de data center estático

{
  "pid": ID do pacote, // obtido da interface /openapi/product
  "pm_id": ID do método de pagamento, // obtido da interface /openapi/payment/list ou /openapi/payment/groups
  "region_list": "JP,15,333|DE,10,444|US,5,555" // Formato: região, quantidade, ASN|região, quantidade, ASN (número ASN opcional)
}

Compra dinâmica de tráfego residencial

{
  "pid": ID do pacote, // obtido da interface /openapi/product
  "pm_id": ID do método de pagamento // Obtido na interface /openapi/payment/list ou /openapi/payment/groups
}

Compra de tráfego de rotação estática

{
  "pid": ID do pacote, // obtido da interface /openapi/product
  "pm_id": ID do método de pagamento // Obtido na interface /openapi/payment/list ou /openapi/payment/groups
}

Compra dinâmica de tráfego ilimitado

{
  "pid": ID do pacote, // obtido da interface /openapi/product
  "pm_id": ID do método de pagamento, // obtido da interface /openapi/payment/list ou /openapi/payment/groups
  "product_sku_bandwidth_id": ID de especificação de largura de banda,
  "product_sku_concurrency_id": ID de especificação de simultaneidade
}

Recarga de saldo

{
  "pid": ID do pacote, // obtido da interface /openapi/product
  "pm_id": ID do método de pagamento, // obtido da interface /openapi/payment/list ou /openapi/payment/groups
  "recharge_amount": valor da recarga
}

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "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,
  "product_sku_duration_id": 0,
  "etd": 1,
  "recharge_amount": 0
}

Parâmetros

NomeEmTipoObrigatórioDescrição
bodybodyobjecttruenenhum
» team_idbodyanyfalseIdentificação do espaço de recursos públicos; omita team_id ou passe uma string vazia ao solicitar um espaço pessoal e uma string vazia ao responder a um espaço pessoal; tanto o número 0 quanto a string "0" são ilegais, e o espaço da equipe usa uma identificação pública da equipe de 6 a 12 dígitos
»» anonymousbodystringfalsenenhum
»» anonymousbodyTeamPublicIdfalseLogotipo público da equipe, o primeiro caractere é uma letra ASCII e os demais caracteres contêm apenas letras e números ASCII; a chave primária numérica do banco de dados não foi emitida
» pidbodyintegertrueID do pacote, do campo id retornado pela interface /openapi/product
» upidsbodystringfalseLista de IDs de pacotes de renovação (separados por vírgula), do campo id retornado pela interface /openapi/user-product/list ou /openapi/ip/get-static-ip
» amountbodynumberfalseNúmero de novos pacotes adquiridos
» pm_idbodyintegertrueID da forma de pagamento, do campo id retornado pela interface /openapi/payment/list ou /openapi/payment/groups
» region_listbodystringfalseAo adquirir um IP estático, especifique a região + quantidade + número ASN. O formato é: região, quantidade, ASN
» coupon_snbodystringfalseNúmero do cupom
» use_invitation_registration_discountbodybooleanfalseSe deve usar o desconto de registro de convite
» renew_durationbodyintegerfalseRenovação de IP estático de tempo opcional
» product_sku_bandwidth_idbodyintegerfalsePacote 11: ID do pacote de largura de banda
» product_sku_concurrency_idbodyintegerfalsePacote 11: ID do pacote simultâneo
» product_sku_duration_idbodyintegerfalseTipo de pacote=11Obrigatório: ID de especificação de duração
» etdbodyintegerfalseMúltiplo de duração, obtido do pacote extension_of_time_days, 2 representa o número de dias × 2, o preço aumentará
» recharge_amountbodyintegerfalsePacote 3: Valor de recarga

Exemplos de resposta

Resposta 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "id": 0,
    "trade_no": "string",
    "out_trade_no": "string",
    "product_id": 0,
    "product_type": 0,
    "amount": 0,
    "unit_price": 0.1,
    "total_fee": 0.1,
    "goods_fee": 0.1,
    "pay_fee": 0.1,
    "discount_fee": 0.1,
    "handling_fee": 0.1,
    "refund_fee": 0.1,
    "pm_id": 0,
    "pm_title": "string",
    "pm_logo": "string",
    "status": 0,
    "title": "string",
    "detail": "string",
    "region_desc": "string",
    "pay_at": "2019-08-24T14:15:22Z",
    "pay_timestamp": 0,
    "created_at": "2019-08-24T14:15:22Z",
    "pay_fee_status": 0,
    "invoice": {
      "name": "string",
      "org_name": "string",
      "first_name": "string",
      "last_name": "string",
      "phone": "string",
      "email": "[email protected]",
      "role_type": 0,
      "vat_id": "string",
      "address_country": "string",
      "address_city": "string",
      "address_line1": "string",
      "address_line2": "string",
      "address_postal_code": "string"
    }
  },
  "request_id": "string"
}

Respostas

StatusSignificadoDescriçãoEsquema
200OKCriado com sucessoInline

Esquema da resposta

Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth, apiKeyAuth

Cancelar pedido

Exemplos de código

# Você também pode usar wget
curl -X POST https://api.proxylite.com/end-point/order/close \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/order/close

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "trade_no": "string"
}

Parâmetros

NomeEmTipoObrigatórioDescrição
bodybodyobjecttruenenhum
» team_idbodyanyfalseIdentificação do espaço de recursos públicos; omita team_id ou passe uma string vazia ao solicitar um espaço pessoal e uma string vazia ao responder a um espaço pessoal; tanto o número 0 quanto a string "0" são ilegais, e o espaço da equipe usa uma identificação pública da equipe de 6 a 12 dígitos
»» anonymousbodystringfalsenenhum
»» anonymousbodyTeamPublicIdfalseLogotipo público da equipe, o primeiro caractere é uma letra ASCII e os demais caracteres contêm apenas letras e números ASCII; a chave primária numérica do banco de dados não foi emitida
» trade_nobodystringtruenenhum

Exemplos de resposta

Resposta 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Respostas

StatusSignificadoDescriçãoEsquema
200OKOperação bem-sucedidaWebV1SuccessResponse
Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth, apiKeyAuth

Detalhes do pedido

Exemplos de código

# Você também pode usar wget
curl -X GET https://api.proxylite.com/end-point/order/info?trade_no=string \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/order/info

Parâmetros

NomeEmTipoObrigatórioDescrição
team_idqueryResourceSpaceIdfalsenenhum
trade_noquerystringtruenenhum

Exemplos de resposta

Resposta 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "id": 0,
    "trade_no": "string",
    "out_trade_no": "string",
    "product_id": 0,
    "product_type": 0,
    "amount": 0,
    "unit_price": 0.1,
    "total_fee": 0.1,
    "goods_fee": 0.1,
    "pay_fee": 0.1,
    "discount_fee": 0.1,
    "handling_fee": 0.1,
    "refund_fee": 0.1,
    "pm_id": 0,
    "pm_title": "string",
    "pm_logo": "string",
    "status": 0,
    "title": "string",
    "detail": "string",
    "region_desc": "string",
    "pay_at": "2019-08-24T14:15:22Z",
    "pay_timestamp": 0,
    "created_at": "2019-08-24T14:15:22Z",
    "pay_fee_status": 0,
    "invoice": {
      "name": "string",
      "org_name": "string",
      "first_name": "string",
      "last_name": "string",
      "phone": "string",
      "email": "[email protected]",
      "role_type": 0,
      "vat_id": "string",
      "address_country": "string",
      "address_city": "string",
      "address_line1": "string",
      "address_line2": "string",
      "address_postal_code": "string"
    }
  },
  "request_id": "string"
}

Respostas

StatusSignificadoDescriçãoEsquema
200OKHTTP bem-sucedido; continue julgando o código do corpo da respostaInline

Esquema da resposta

Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth, apiKeyAuth

Detalhes do pedido V2

Exemplos de código

# Você também pode usar wget
curl -X GET https://api.proxylite.com/end-point/order/info-v2?order_id=string \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/order/info-v2

Parâmetros

NomeEmTipoObrigatórioDescrição
team_idqueryResourceSpaceIdfalsenenhum
order_idquerystringtrueID do pedido criptografado do lado do cliente

Exemplos de resposta

Resposta 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "id": 0,
    "trade_no": "string",
    "out_trade_no": "string",
    "product_id": 0,
    "product_type": 0,
    "amount": 0,
    "unit_price": 0.1,
    "total_fee": 0.1,
    "goods_fee": 0.1,
    "pay_fee": 0.1,
    "discount_fee": 0.1,
    "handling_fee": 0.1,
    "refund_fee": 0.1,
    "pm_id": 0,
    "pm_title": "string",
    "pm_logo": "string",
    "status": 0,
    "title": "string",
    "detail": "string",
    "region_desc": "string",
    "pay_at": "2019-08-24T14:15:22Z",
    "pay_timestamp": 0,
    "created_at": "2019-08-24T14:15:22Z",
    "pay_fee_status": 0,
    "invoice": {
      "name": "string",
      "org_name": "string",
      "first_name": "string",
      "last_name": "string",
      "phone": "string",
      "email": "[email protected]",
      "role_type": 0,
      "vat_id": "string",
      "address_country": "string",
      "address_city": "string",
      "address_line1": "string",
      "address_line2": "string",
      "address_postal_code": "string"
    }
  },
  "request_id": "string"
}

Respostas

StatusSignificadoDescriçãoEsquema
200OKSucesso HTTP; quando o pedido for pago ou cancelado, os dados do pedido poderão ser carregados com um código de erro comercialInline

Esquema da resposta

Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth, apiKeyAuth

Reemitir fatura para pedidos históricos

Exemplos de código

# Você também pode usar wget
curl -X POST https://api.proxylite.com/end-point/order/reissue-invoice \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/order/reissue-invoice

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "trade_no_list": [
    "string"
  ]
}

Parâmetros

NomeEmTipoObrigatórioDescrição
bodybodyobjecttruenenhum
» team_idbodyanyfalseIdentificação do espaço de recursos públicos; omita team_id ou passe uma string vazia ao solicitar um espaço pessoal e uma string vazia ao responder a um espaço pessoal; tanto o número 0 quanto a string "0" são ilegais, e o espaço da equipe usa uma identificação pública da equipe de 6 a 12 dígitos
»» anonymousbodystringfalsenenhum
»» anonymousbodyTeamPublicIdfalseLogotipo público da equipe, o primeiro caractere é uma letra ASCII e os demais caracteres contêm apenas letras e números ASCII; a chave primária numérica do banco de dados não foi emitida
» trade_no_listbody[string]truenenhum

Exemplos de resposta

Resposta 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Respostas

StatusSignificadoDescriçãoEsquema
200OKOperação bem-sucedidaWebV1SuccessResponse
Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth

Pré-verificação do pedido

Exemplos de código

# Você também pode usar wget
curl -X POST https://api.proxylite.com/end-point/order/check \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/order/check

Chamado antes de criar um pedido, é usado para visualizar preços, descontos, detalhes de renovação de IP, etc. O pedido não será realmente criado. Os parâmetros são exatamente iguais a /openapi/order/create.

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "pid": 0,
  "upids": "string",
  "amount": 1,
  "pm_id": 0,
  "region_list": "string",
  "coupon_sn": "string",
  "renew_duration": "1m",
  "product_sku_bandwidth_id": 0,
  "product_sku_concurrency_id": 0,
  "product_sku_duration_id": 0,
  "etd": 1,
  "recharge_amount": 0
}

Parâmetros

NomeEmTipoObrigatórioDescrição
bodybodyobjecttruenenhum
» team_idbodyanyfalseIdentificação do espaço de recursos públicos; omita team_id ou passe uma string vazia ao solicitar um espaço pessoal e uma string vazia ao responder a um espaço pessoal; tanto o número 0 quanto a string "0" são ilegais, e o espaço da equipe usa uma identificação pública da equipe de 6 a 12 dígitos
»» anonymousbodystringfalsenenhum
»» anonymousbodyTeamPublicIdfalseLogotipo público da equipe, o primeiro caractere é uma letra ASCII e os demais caracteres contêm apenas letras e números ASCII; a chave primária numérica do banco de dados não foi emitida
» pidbodyintegertrueID do pacote
» upidsbodystringfalseRenovação de IP: lista de IDs de pacotes de usuários, separados por vírgulas
» amountbodyintegerfalseQuantidade de compra
» pm_idbodyintegertrueID da forma de pagamento
» region_listbodystringfalseRegião de compra de IP estático + quantidade, formato: ID da região, quantidade
» coupon_snbodystringfalseNúmero do cupom
» renew_durationbodystringfalsePeríodo de renovação do IP: 1m=1 mês, 2m=2 meses, em=final do próximo mês
» product_sku_bandwidth_idbodyintegerfalseTipo de pacote=11Obrigatório: ID de especificação de largura de banda
» product_sku_concurrency_idbodyintegerfalseTipo de pacote=11Obrigatório: ID de especificação de simultaneidade
» product_sku_duration_idbodyintegerfalseTipo de pacote=11Obrigatório: ID de especificação de duração
» etdbodyintegerfalseDuração múltipla, obtida do pacote extension_of_time_days
» recharge_amountbodynumberfalseTipo de pacote=3Obrigatório: valor de recarga

Valores enumerados

ParameterValue
» renew_duration1m
» renew_duration2m
» renew_durationem

Exemplos de resposta

Resposta 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "product_id": 0,
    "amount": 0,
    "discount_fee": 0.1,
    "total_fee": 0.1,
    "pay_fee": 0.1,
    "product_type": 0,
    "title": "string",
    "detail": "string",
    "ip_result": [
      {
        "ip": "string",
        "price": 0.1,
        "country_code": "string",
        "current_time": "2019-08-24T14:15:22Z",
        "renewal_time": "2019-08-24T14:15:22Z",
        "country": {
          "name_zh_cn": "string",
          "flag": "string",
          "square_flag": "string"
        }
      }
    ]
  },
  "request_id": "string"
}

Respostas

StatusSignificadoDescriçãoEsquema
200OKSimulação bem-sucedidaInline

Esquema da resposta

Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth, apiKeyAuth

Gerenciamento de chaves de API

Gerenciamento de chaves de API para espaços de recursos pessoais e de equipe

Lista de chaves de API

Exemplos de código

# Você também pode usar wget
curl -X GET https://api.proxylite.com/end-point/api-keys \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/api-keys

Parâmetros

NomeEmTipoObrigatórioDescrição
team_idqueryResourceSpaceIdfalseIdentificador de espaço de recursos; espaço pessoal omite ou passa uma string vazia
pagequeryintegerfalsenenhum
pageSizequeryintegerfalsenenhum

Exemplos de resposta

Resposta 200

{
  "code": 0,
  "msg": "string",
  "request_id": "string",
  "data": {
    "list": [
      {
        "id": 1,
        "api_key": "string",
        "team_user_id": 0,
        "remark": "string",
        "status": 0,
        "created_at": "string",
        "updated_at": "string"
      }
    ],
    "total": 0,
    "page": 1,
    "pageSize": 1
  }
}

Respostas

StatusSignificadoDescriçãoEsquema
200OKHTTP bem-sucedido; continue julgando o código do corpo da respostaInline

Esquema da resposta

Status Code 200

NomeTipoObrigatórioRestriçõesDescrição
» codeintegertruenenhumnone
» msgstringtruenenhumnone
» request_idstringtruenenhumnone
» dataobjecttruenenhumnone
»» list[UserApiKeyMetadata]truenenhumnone
»»» idintegertruenenhumAPI Key ID
»»» api_keystringtruenenhumA resposta da criação é a Chave completa; a lista da equipe é o valor mascarado
»»» team_user_idintegertruenenhumA chave da equipe, na verdade, contém o ID do membro e a chave pessoal é 0
»»» remarkstringtruenenhumObservações
»»» statusintegertruenenhum0=desativar, 1=ativar
»»» created_atstringtruenenhumhora de criação
»»» updated_atstring,nullfalsenenhumHora de atualização
»» totalintegertruenenhumnone
»» pageintegertruenenhumnone
»» pageSizeintegertruenenhumnone

Valores enumerados

PropriedadeValor
status0
status1
Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth

Criar chave de API

Exemplos de código

# Você também pode usar wget
curl -X POST https://api.proxylite.com/end-point/api-keys/create \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/api-keys/create

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "remark": "string"
}

Parâmetros

NomeEmTipoObrigatórioDescrição
bodybodyobjecttruenenhum
» team_idbodyanyfalseIdentificação do espaço de recursos públicos; omita team_id ou passe uma string vazia ao solicitar um espaço pessoal e uma string vazia ao responder a um espaço pessoal; tanto o número 0 quanto a string "0" são ilegais, e o espaço da equipe usa uma identificação pública da equipe de 6 a 12 dígitos
»» anonymousbodystringfalsenenhum
»» anonymousbodyTeamPublicIdfalseLogotipo público da equipe, o primeiro caractere é uma letra ASCII e os demais caracteres contêm apenas letras e números ASCII; a chave primária numérica do banco de dados não foi emitida
» remarkbodystringfalsenenhum

Exemplos de resposta

Resposta 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "id": 1,
    "api_key": "string",
    "team_user_id": 0,
    "remark": "string",
    "status": 0,
    "created_at": "string",
    "updated_at": "string"
  },
  "request_id": "string"
}

Respostas

StatusSignificadoDescriçãoEsquema
200OKRetorne a chave API completa quando o negócio for bem-sucedido, só que desta vezInline

Esquema da resposta

Valores enumerados

PropriedadeValor
status0
status1
Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth

Habilitar chave de API

Exemplos de código

# Você também pode usar wget
curl -X POST https://api.proxylite.com/end-point/api-keys/enable \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/api-keys/enable

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "id": 1
}

Parâmetros

NomeEmTipoObrigatórioDescrição
bodybodyobjecttruenenhum
» team_idbodyanyfalseIdentificação do espaço de recursos públicos; omita team_id ou passe uma string vazia ao solicitar um espaço pessoal e uma string vazia ao responder a um espaço pessoal; tanto o número 0 quanto a string "0" são ilegais, e o espaço da equipe usa uma identificação pública da equipe de 6 a 12 dígitos
»» anonymousbodystringfalsenenhum
»» anonymousbodyTeamPublicIdfalseLogotipo público da equipe, o primeiro caractere é uma letra ASCII e os demais caracteres contêm apenas letras e números ASCII; a chave primária numérica do banco de dados não foi emitida
» idbodyintegertrueAPI Key ID

Exemplos de resposta

Resposta 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Respostas

StatusSignificadoDescriçãoEsquema
200OKOperação bem-sucedidaWebV1SuccessResponse
Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth

Desativar chave API

Exemplos de código

# Você também pode usar wget
curl -X POST https://api.proxylite.com/end-point/api-keys/disable \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/api-keys/disable

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "id": 1
}

Parâmetros

NomeEmTipoObrigatórioDescrição
bodybodyobjecttruenenhum
» team_idbodyanyfalseIdentificação do espaço de recursos públicos; omita team_id ou passe uma string vazia ao solicitar um espaço pessoal e uma string vazia ao responder a um espaço pessoal; tanto o número 0 quanto a string "0" são ilegais, e o espaço da equipe usa uma identificação pública da equipe de 6 a 12 dígitos
»» anonymousbodystringfalsenenhum
»» anonymousbodyTeamPublicIdfalseLogotipo público da equipe, o primeiro caractere é uma letra ASCII e os demais caracteres contêm apenas letras e números ASCII; a chave primária numérica do banco de dados não foi emitida
» idbodyintegertrueAPI Key ID

Exemplos de resposta

Resposta 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Respostas

StatusSignificadoDescriçãoEsquema
200OKOperação bem-sucedidaWebV1SuccessResponse
Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth

Excluir chave de API

Exemplos de código

# Você também pode usar wget
curl -X POST https://api.proxylite.com/end-point/api-keys/delete \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/api-keys/delete

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "id": 1
}

Parâmetros

NomeEmTipoObrigatórioDescrição
bodybodyobjecttruenenhum
» team_idbodyanyfalseIdentificação do espaço de recursos públicos; omita team_id ou passe uma string vazia ao solicitar um espaço pessoal e uma string vazia ao responder a um espaço pessoal; tanto o número 0 quanto a string "0" são ilegais, e o espaço da equipe usa uma identificação pública da equipe de 6 a 12 dígitos
»» anonymousbodystringfalsenenhum
»» anonymousbodyTeamPublicIdfalseLogotipo público da equipe, o primeiro caractere é uma letra ASCII e os demais caracteres contêm apenas letras e números ASCII; a chave primária numérica do banco de dados não foi emitida
» idbodyintegertrueAPI Key ID

Exemplos de resposta

Resposta 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Respostas

StatusSignificadoDescriçãoEsquema
200OKOperação bem-sucedidaWebV1SuccessResponse
Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth

Modificar comentários da chave de API

Exemplos de código

# Você também pode usar wget
curl -X POST https://api.proxylite.com/end-point/api-keys/update-remark \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/api-keys/update-remark

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "id": 1,
  "remark": "string"
}

Parâmetros

NomeEmTipoObrigatórioDescrição
bodybodyobjecttruenenhum
» team_idbodyanyfalseIdentificação do espaço de recursos públicos; omita team_id ou passe uma string vazia ao solicitar um espaço pessoal e uma string vazia ao responder a um espaço pessoal; tanto o número 0 quanto a string "0" são ilegais, e o espaço da equipe usa uma identificação pública da equipe de 6 a 12 dígitos
»» anonymousbodystringfalsenenhum
»» anonymousbodyTeamPublicIdfalseLogotipo público da equipe, o primeiro caractere é uma letra ASCII e os demais caracteres contêm apenas letras e números ASCII; a chave primária numérica do banco de dados não foi emitida
» idbodyintegertruenenhum
» remarkbodystringtruenenhum

Exemplos de resposta

Resposta 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Respostas

StatusSignificadoDescriçãoEsquema
200OKOperação bem-sucedidaWebV1SuccessResponse
Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth

Fatura de renovação mensal

Faturamento em tempo real, pré-verificação, realização de pedidos e histórico de renovações mensais agregadas

Fatura de renovação de resumo mensal atual

Exemplos de código

# Você também pode usar wget
curl -X GET https://api.proxylite.com/end-point/monthly-renewal-bill \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/monthly-renewal-bill

Parâmetros

NomeEmTipoObrigatórioDescrição
team_idqueryResourceSpaceIdfalsenenhum

Exemplos de resposta

Resposta 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "batch": {
      "type": "current",
      "start_at": "string",
      "end_at": "string",
      "target_expired_at": "string",
      "timezone": "string"
    },
    "currency": "string",
    "total_fee": 0,
    "items": [
      {
        "id": 0,
        "user_product_id": 1,
        "product_id": 1,
        "product_type": 0,
        "parent_product_type": 0,
        "title": "string",
        "expired_at": "string",
        "target_expired_at": "string",
        "renew_days": 1,
        "unit_month_price": 0,
        "pay_fee": 0,
        "currency": "string",
        "bandwidth": 0,
        "bandwidth_mbsp": 0,
        "concurrency": 0,
        "ip": "string",
        "country_code": "string",
        "paid_at": "string",
        "refunded_at": "string",
        "created_at": "string",
        "updated_at": "string"
      }
    ]
  },
  "request_id": "string"
}

Respostas

StatusSignificadoDescriçãoEsquema
200OKSolicitação bem-sucedidaInline

Esquema da resposta

Valores enumerados

PropriedadeValor
typecurrent
typenext
Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth, apiKeyAuth

Verifique o resumo mensal dos pedidos de renovação

Exemplos de código

# Você também pode usar wget
curl -X POST https://api.proxylite.com/end-point/monthly-renewal-bill/check \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/monthly-renewal-bill/check

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "user_product_ids": [
    1
  ],
  "user_coupon_id": 1,
  "coupon_sn": "string"
}

Parâmetros

NomeEmTipoObrigatórioDescrição
bodybodyMonthlyRenewalRequesttruenenhum

Exemplos de resposta

Resposta 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "batch": {
      "type": "current",
      "start_at": "string",
      "end_at": "string",
      "target_expired_at": "string",
      "timezone": "string"
    },
    "currency": "string",
    "total_fee": 0,
    "discount_fee": 0,
    "pay_fee": 0,
    "items": [
      {
        "id": 0,
        "user_product_id": 1,
        "product_id": 1,
        "product_type": 0,
        "parent_product_type": 0,
        "title": "string",
        "expired_at": "string",
        "target_expired_at": "string",
        "renew_days": 1,
        "unit_month_price": 0,
        "pay_fee": 0,
        "currency": "string",
        "bandwidth": 0,
        "bandwidth_mbsp": 0,
        "concurrency": 0,
        "ip": "string",
        "country_code": "string",
        "paid_at": "string",
        "refunded_at": "string",
        "created_at": "string",
        "updated_at": "string"
      }
    ],
    "user_coupon_id": 0
  },
  "request_id": "string"
}

Respostas

StatusSignificadoDescriçãoEsquema
200OKSolicitação bem-sucedidaInline

Esquema da resposta

Valores enumerados

PropriedadeValor
typecurrent
typenext
Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth

Crie um pedido de renovação resumido mensal

Exemplos de código

# Você também pode usar wget
curl -X POST https://api.proxylite.com/end-point/monthly-renewal-bill/create \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/monthly-renewal-bill/create

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "user_product_ids": [
    1
  ],
  "user_coupon_id": 1,
  "coupon_sn": "string"
}

Parâmetros

NomeEmTipoObrigatórioDescrição
bodybodyMonthlyRenewalRequesttruenenhum

Exemplos de resposta

Resposta 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "trade_no": "string",
    "total_fee": 0,
    "discount_fee": 0,
    "pay_fee": 0,
    "currency": "string",
    "user_coupon_id": 0
  },
  "request_id": "string"
}

Respostas

StatusSignificadoDescriçãoEsquema
200OKSolicitação bem-sucedidaInline

Esquema da resposta

Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth

Resumo mensal das contas do histórico de renovação

Exemplos de código

# Você também pode usar wget
curl -X GET https://api.proxylite.com/end-point/monthly-renewal-bill/history \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/monthly-renewal-bill/history

Parâmetros

NomeEmTipoObrigatórioDescrição
team_idqueryResourceSpaceIdfalsenenhum
trade_noquerystringfalsenenhum
start_datequerystring(date)falsenenhum
end_datequerystring(date)falsenenhum
pagequeryintegerfalsenenhum
sizequeryintegerfalsenenhum

Exemplos de resposta

Resposta 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "total": 0,
    "page": 1,
    "size": 1,
    "list": [
      {
        "id": 1,
        "trade_no": "string",
        "status": 0,
        "pay_fee": 0,
        "currency": "string",
        "pay_at": "string",
        "created_at": "string",
        "pay_method": 0,
        "pm_id": 0,
        "pay_channel": 0,
        "pm_title": "string",
        "pm_logo": "string",
        "items": [
          {
            "id": 0,
            "user_product_id": 1,
            "product_id": 1,
            "product_type": 0,
            "parent_product_type": 0,
            "title": "string",
            "expired_at": "string",
            "target_expired_at": "string",
            "renew_days": 1,
            "unit_month_price": 0,
            "pay_fee": 0,
            "currency": "string",
            "bandwidth": 0,
            "bandwidth_mbsp": 0,
            "concurrency": 0,
            "ip": "string",
            "country_code": "string",
            "paid_at": "string",
            "refunded_at": "string",
            "created_at": "string",
            "updated_at": "string"
          }
        ]
      }
    ]
  },
  "request_id": "string"
}

Respostas

StatusSignificadoDescriçãoEsquema
200OKSolicitação bem-sucedidaInline

Esquema da resposta

Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth, apiKeyAuth

Gestão de faturas

Cabeçalho da fatura, aplicativo de faturamento e pedidos faturáveis

Detalhes do cabeçalho da fatura

Exemplos de código

# Você também pode usar wget
curl -X GET https://api.proxylite.com/end-point/user-invoice/info \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/user-invoice/info

Parâmetros

NomeEmTipoObrigatórioDescrição
team_idqueryResourceSpaceIdfalsenenhum
invoice_codequerystringfalsenenhum

Exemplos de resposta

Resposta 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "invoice_code": "string",
    "name": "string",
    "org_name": "string",
    "first_name": "string",
    "last_name": "string",
    "phone": "string",
    "email": "[email protected]",
    "role_type": 1,
    "invoice_type": 0,
    "vat_id": "string",
    "tax_no": "string",
    "address_country": "string",
    "address_city": "string",
    "address_line1": "string",
    "address_line2": "string",
    "address_postal_code": "string",
    "bank_name": "string",
    "bank_account": "string",
    "is_def": true
  },
  "request_id": "string"
}

Respostas

StatusSignificadoDescriçãoEsquema
200OKHTTP bem-sucedido; continue julgando o código do corpo da respostaInline

Esquema da resposta

Valores enumerados

PropriedadeValor
role_type1
role_type2
invoice_type0
invoice_type1
invoice_type2
Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth, apiKeyAuth

Criar ou modificar o cabeçalho da fatura

Exemplos de código

# Você também pode usar wget
curl -X POST https://api.proxylite.com/end-point/user-invoice/create \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/user-invoice/create

Body parameter

{
  "invoice_code": "string",
  "name": "string",
  "org_name": "string",
  "first_name": "string",
  "last_name": "string",
  "phone": "string",
  "email": "[email protected]",
  "role_type": 1,
  "invoice_type": 0,
  "vat_id": "string",
  "tax_no": "string",
  "address_country": "string",
  "address_city": "string",
  "address_line1": "string",
  "address_line2": "string",
  "address_postal_code": "string",
  "bank_name": "string",
  "bank_account": "string",
  "is_def": true,
  "team_id": "A1b2C3d4E5f6",
  "new_invoice_code": false
}

Parâmetros

NomeEmTipoObrigatórioDescrição
bodybodyanytruenenhum

Exemplos de resposta

Resposta 200

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

Respostas

StatusSignificadoDescriçãoEsquema
200OKA solicitação foi bem-sucedida, os dados são nulosInline

Esquema da resposta

Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth

Lista de cabeçalho da fatura

Exemplos de código

# Você também pode usar wget
curl -X GET https://api.proxylite.com/end-point/user-invoice/list \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/user-invoice/list

Parâmetros

NomeEmTipoObrigatórioDescrição
team_idqueryResourceSpaceIdfalsenenhum

Exemplos de resposta

Resposta 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "invoice_code": "string",
        "name": "string",
        "org_name": "string",
        "first_name": "string",
        "last_name": "string",
        "phone": "string",
        "email": "[email protected]",
        "role_type": 1,
        "invoice_type": 0,
        "vat_id": "string",
        "tax_no": "string",
        "address_country": "string",
        "address_city": "string",
        "address_line1": "string",
        "address_line2": "string",
        "address_postal_code": "string",
        "bank_name": "string",
        "bank_account": "string",
        "is_def": true,
        "created_at": 0
      }
    ]
  },
  "request_id": "string"
}

Respostas

StatusSignificadoDescriçãoEsquema
200OKSolicitação bem-sucedidaInline

Esquema da resposta

Valores enumerados

PropriedadeValor
role_type1
role_type2
invoice_type0
invoice_type1
invoice_type2
Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth, apiKeyAuth

Excluir cabeçalho da fatura

Exemplos de código

# Você também pode usar wget
curl -X POST https://api.proxylite.com/end-point/user-invoice/delete \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/user-invoice/delete

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "invoice_code": "string"
}

Parâmetros

NomeEmTipoObrigatórioDescrição
bodybodyobjecttruenenhum
» team_idbodyanyfalseIdentificação do espaço de recursos públicos; omita team_id ou passe uma string vazia ao solicitar um espaço pessoal e uma string vazia ao responder a um espaço pessoal; tanto o número 0 quanto a string "0" são ilegais, e o espaço da equipe usa uma identificação pública da equipe de 6 a 12 dígitos
»» anonymousbodystringfalsenenhum
»» anonymousbodyTeamPublicIdfalseLogotipo público da equipe, o primeiro caractere é uma letra ASCII e os demais caracteres contêm apenas letras e números ASCII; a chave primária numérica do banco de dados não foi emitida
» invoice_codebodystringtruenenhum

Exemplos de resposta

Resposta 200

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

Respostas

StatusSignificadoDescriçãoEsquema
200OKA solicitação foi bem-sucedida, os dados são nulosInline

Esquema da resposta

Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth

Lista de registros de faturamento

Exemplos de código

# Você também pode usar wget
curl -X GET https://api.proxylite.com/end-point/user-invoice/record-list \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/user-invoice/record-list

Parâmetros

NomeEmTipoObrigatórioDescrição
team_idqueryResourceSpaceIdfalsenenhum
statusqueryintegerfalsenenhum

Valores enumerados

ParameterValue
status0
status1
status2
status3
status4

Exemplos de resposta

Resposta 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "id": 1,
        "invoice_no": "string",
        "invoice_amount": 0,
        "invoice_download_url": "string",
        "status": 0,
        "remark": "string",
        "order_ids": [
          0
        ],
        "created_at": 0,
        "invoice_info": {
          "invoice_code": "string",
          "name": "string",
          "org_name": "string",
          "role_type": 1,
          "invoice_type": 0
        }
      }
    ]
  },
  "request_id": "string"
}

Respostas

StatusSignificadoDescriçãoEsquema
200OKSolicitação bem-sucedidaInline

Esquema da resposta

Valores enumerados

PropriedadeValor
role_type1
role_type2
invoice_type0
invoice_type1
invoice_type2
Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth, apiKeyAuth

Enviar solicitação de cobrança

Exemplos de código

# Você também pode usar wget
curl -X POST https://api.proxylite.com/end-point/user-invoice/submit \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/user-invoice/submit

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "invoice_code": "string",
  "order_ids": [
    0
  ]
}

Parâmetros

NomeEmTipoObrigatórioDescrição
bodybodyobjecttruenenhum
» team_idbodyanyfalseIdentificação do espaço de recursos públicos; omita team_id ou passe uma string vazia ao solicitar um espaço pessoal e uma string vazia ao responder a um espaço pessoal; tanto o número 0 quanto a string "0" são ilegais, e o espaço da equipe usa uma identificação pública da equipe de 6 a 12 dígitos
»» anonymousbodystringfalsenenhum
»» anonymousbodyTeamPublicIdfalseLogotipo público da equipe, o primeiro caractere é uma letra ASCII e os demais caracteres contêm apenas letras e números ASCII; a chave primária numérica do banco de dados não foi emitida
» invoice_codebodystringtruenenhum
» order_idsbody[integer]truenenhum

Exemplos de resposta

Resposta 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "invoice_id": 1
  },
  "request_id": "string"
}

Respostas

StatusSignificadoDescriçãoEsquema
200OKSolicitação bem-sucedidaInline

Esquema da resposta

Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth

Cancelar solicitação de faturamento

Exemplos de código

# Você também pode usar wget
curl -X POST https://api.proxylite.com/end-point/user-invoice/cancel \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/user-invoice/cancel

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "invoice_id": 1,
  "reason": "string"
}

Parâmetros

NomeEmTipoObrigatórioDescrição
bodybodyobjecttruenenhum
» team_idbodyanyfalseIdentificação do espaço de recursos públicos; omita team_id ou passe uma string vazia ao solicitar um espaço pessoal e uma string vazia ao responder a um espaço pessoal; tanto o número 0 quanto a string "0" são ilegais, e o espaço da equipe usa uma identificação pública da equipe de 6 a 12 dígitos
»» anonymousbodystringfalsenenhum
»» anonymousbodyTeamPublicIdfalseLogotipo público da equipe, o primeiro caractere é uma letra ASCII e os demais caracteres contêm apenas letras e números ASCII; a chave primária numérica do banco de dados não foi emitida
» invoice_idbodyintegertruenenhum
» reasonbodystringfalsenenhum

Exemplos de resposta

Resposta 200

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

Respostas

StatusSignificadoDescriçãoEsquema
200OKA solicitação foi bem-sucedida, os dados são nulosInline

Esquema da resposta

Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth

Estatísticas do valor da fatura

Exemplos de código

# Você também pode usar wget
curl -X GET https://api.proxylite.com/end-point/user-invoice/statistics \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/user-invoice/statistics

Parâmetros

NomeEmTipoObrigatórioDescrição
team_idqueryResourceSpaceIdfalsenenhum

Exemplos de resposta

Resposta 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "invoiceable_amount": 0,
    "invoiced_amount": 0,
    "processing_amount": 0
  },
  "request_id": "string"
}

Respostas

StatusSignificadoDescriçãoEsquema
200OKSolicitação bem-sucedidaInline

Esquema da resposta

Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth, apiKeyAuth

Lista de pedidos que podem ser faturados

Exemplos de código

# Você também pode usar wget
curl -X GET https://api.proxylite.com/end-point/user-invoice/invoiceable-orders \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/user-invoice/invoiceable-orders

Parâmetros

NomeEmTipoObrigatórioDescrição
team_idqueryResourceSpaceIdfalsenenhum

Exemplos de resposta

Resposta 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "id": 1,
        "order_no": "string",
        "pay_fee": 0,
        "created_at": 0
      }
    ]
  },
  "request_id": "string"
}

Respostas

StatusSignificadoDescriçãoEsquema
200OKSolicitação bem-sucedidaInline

Esquema da resposta

Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth, apiKeyAuth

Gestão de equipe

Criação de equipe, consulta, mudança de nome e dissolução

Crie uma equipe

Exemplos de código

# Você também pode usar wget
curl -X POST https://api.proxylite.com/end-point/team/create \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/team/create

Body parameter

{
  "name": "string"
}

Parâmetros

NomeEmTipoObrigatórioDescrição
bodybodyobjecttruenenhum
» namebodystringtrueNome da equipe

Exemplos de resposta

Resposta 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "id": "A1b2C3d4E5f6",
    "name": "string",
    "super_admin_user_id": 1,
    "status": 0,
    "current_role": 1,
    "dissolving_at": "string",
    "dissolved_at": "string",
    "created_at": "string",
    "updated_at": "string"
  },
  "request_id": "string"
}

Respostas

StatusSignificadoDescriçãoEsquema
200OKHTTP bem-sucedido; continue julgando o código do corpo da respostaInline

Esquema da resposta

Valores enumerados

PropriedadeValor
status0
status1
status2
status3
current_role1
current_role2
current_role3
current_role4
current_rolenull
Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth

Lista de equipes acessíveis ao usuário atual

Exemplos de código

# Você também pode usar wget
curl -X GET https://api.proxylite.com/end-point/team/list \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/team/list

Parâmetros

NomeEmTipoObrigatórioDescrição
pagequeryintegerfalsenenhum
page_sizequeryintegerfalsenenhum

Exemplos de resposta

Resposta 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "id": "A1b2C3d4E5f6",
        "name": "string",
        "super_admin_user_id": 1,
        "status": 0,
        "current_role": 1,
        "dissolving_at": "string",
        "dissolved_at": "string",
        "created_at": "string",
        "updated_at": "string"
      }
    ],
    "total": 0,
    "page": 1,
    "page_size": 1
  },
  "request_id": "string"
}

Respostas

StatusSignificadoDescriçãoEsquema
200OKHTTP bem-sucedido; continue julgando o código do corpo da respostaInline

Esquema da resposta

Valores enumerados

PropriedadeValor
status0
status1
status2
status3
current_role1
current_role2
current_role3
current_role4
current_rolenull
Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth

Detalhes da equipe

Exemplos de código

# Você também pode usar wget
curl -X GET https://api.proxylite.com/end-point/team/detail?team_id=A1b2C3d4E5f6 \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/team/detail

Parâmetros

NomeEmTipoObrigatórioDescrição
team_idqueryTeamPublicIdtruenenhum

Exemplos de resposta

Resposta 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "id": "A1b2C3d4E5f6",
    "name": "string",
    "super_admin_user_id": 1,
    "status": 0,
    "current_role": 1,
    "dissolving_at": "string",
    "dissolved_at": "string",
    "created_at": "string",
    "updated_at": "string"
  },
  "request_id": "string"
}

Respostas

StatusSignificadoDescriçãoEsquema
200OKHTTP bem-sucedido; continue julgando o código do corpo da respostaInline

Esquema da resposta

Valores enumerados

PropriedadeValor
status0
status1
status2
status3
current_role1
current_role2
current_role3
current_role4
current_rolenull
Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth

Modificar nome da equipe

Exemplos de código

# Você também pode usar wget
curl -X POST https://api.proxylite.com/end-point/team/update-name \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/team/update-name

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "name": "string"
}

Parâmetros

NomeEmTipoObrigatórioDescrição
bodybodyobjecttruenenhum
» team_idbodyTeamPublicIdtrueLogotipo público da equipe, o primeiro caractere é uma letra ASCII e os demais caracteres contêm apenas letras e números ASCII; a chave primária numérica do banco de dados não foi emitida
» namebodystringtruenenhum

Exemplos de resposta

Resposta 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "id": "A1b2C3d4E5f6",
    "name": "string",
    "super_admin_user_id": 1,
    "status": 0,
    "current_role": 1,
    "dissolving_at": "string",
    "dissolved_at": "string",
    "created_at": "string",
    "updated_at": "string"
  },
  "request_id": "string"
}

Respostas

StatusSignificadoDescriçãoEsquema
200OKHTTP bem-sucedido; continue julgando o código do corpo da respostaInline

Esquema da resposta

Valores enumerados

PropriedadeValor
status0
status1
status2
status3
current_role1
current_role2
current_role3
current_role4
current_rolenull
Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth

Dissolver a equipe

Exemplos de código

# Você também pode usar wget
curl -X POST https://api.proxylite.com/end-point/team/dissolve \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/team/dissolve

Somente superadministradores de equipe podem fazer isso. O nome na solicitação deve corresponder exatamente ao nome atual da equipe. Esta interface impõe a verificação de operações em duas etapas: code=348 é retornado quando não está no estado de confiança de 15 minutos, O chamador deve obter o código de verificação de acordo com os métodos disponíveis nos dados de resposta e, em seguida, tentar novamente com verify_type e verify_code. Pode ser chamado repetidamente para continuar o processo de dissolução inacabado.

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "name": "华东研发团队",
  "verify_type": "email",
  "verify_code": "123456"
}

Parâmetros

NomeEmTipoObrigatórioDescrição
bodybodyobjecttruenenhum
» team_idbodyTeamPublicIdtrueLogotipo público da equipe, o primeiro caractere é uma letra ASCII e os demais caracteres contêm apenas letras e números ASCII; a chave primária numérica do banco de dados não foi emitida
» namebodystringtrueConfirmação do nome da equipe, deve ser exatamente igual ao nome atual da equipe
» verify_typebodystringfalseMétodo de verificação secundária; enviar junto com verify_code quando a verificação for necessária
» verify_codebodystringfalseCódigo de verificação em duas etapas; não é necessário quando estiver no estado de confiança de 15 minutos

Valores enumerados

ParameterValue
» verify_typephone
» verify_typeemail
» verify_typewechat
» verify_typetotp

Exemplos de resposta

Resposta 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "id": "A1b2C3d4E5f6",
    "name": "string",
    "super_admin_user_id": 1,
    "status": 0,
    "current_role": 1,
    "dissolving_at": "string",
    "dissolved_at": "string",
    "created_at": "string",
    "updated_at": "string"
  },
  "request_id": "string"
}

Respostas

StatusSignificadoDescriçãoEsquema
200OKHTTP bem-sucedido; continue julgando o código do corpo da respostaInline

Esquema da resposta

Valores enumerados

PropriedadeValor
status0
status1
status2
status3
current_role1
current_role2
current_role3
current_role4
current_rolenull
Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth

Consultar o status de dissolução da equipe

Exemplos de código

# Você também pode usar wget
curl -X GET https://api.proxylite.com/end-point/team/dissolve-status?team_id=A1b2C3d4E5f6 \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/team/dissolve-status

Parâmetros

NomeEmTipoObrigatórioDescrição
team_idqueryTeamPublicIdtruenenhum

Exemplos de resposta

Resposta 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "id": "A1b2C3d4E5f6",
    "name": "string",
    "super_admin_user_id": 1,
    "status": 0,
    "current_role": 1,
    "dissolving_at": "string",
    "dissolved_at": "string",
    "created_at": "string",
    "updated_at": "string"
  },
  "request_id": "string"
}

Respostas

StatusSignificadoDescriçãoEsquema
200OKHTTP bem-sucedido; continue julgando o código do corpo da respostaInline

Esquema da resposta

Valores enumerados

PropriedadeValor
status0
status1
status2
status3
current_role1
current_role2
current_role3
current_role4
current_rolenull
Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth

membro da equipe

Listas de membros da equipe, ajustes de funções, remoções e saídas

Lista de membros da equipe

Exemplos de código

# Você também pode usar wget
curl -X GET https://api.proxylite.com/end-point/team/members?team_id=A1b2C3d4E5f6 \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/team/members

Parâmetros

NomeEmTipoObrigatórioDescrição
team_idqueryTeamPublicIdtruenenhum
pagequeryintegerfalsenenhum
page_sizequeryintegerfalsenenhum

Exemplos de resposta

Resposta 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "team_member_id": 1,
        "team_id": "A1b2C3d4E5f6",
        "user_id": 1,
        "role": 1,
        "status": 0,
        "joined_at": "string",
        "nickname": "string",
        "username": "string"
      }
    ],
    "total": 0,
    "page": 1,
    "page_size": 1
  },
  "request_id": "string"
}

Respostas

StatusSignificadoDescriçãoEsquema
200OKHTTP bem-sucedido; continue julgando o código do corpo da respostaInline

Esquema da resposta

Valores enumerados

PropriedadeValor
role1
role2
role3
role4
status0
status1
status2
status3
Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth

Lista unificada de membros da equipe

Exemplos de código

# Você também pode usar wget
curl -X GET https://api.proxylite.com/end-point/team/people?team_id=A1b2C3d4E5f6 \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/team/people

Membros válidos são retornados; superadministradores e administradores também veem convites pendentes. Outros status de convite permanecem apenas na lista do histórico de convites.

Parâmetros

NomeEmTipoObrigatórioDescrição
team_idqueryTeamPublicIdtruenenhum
pagequeryintegerfalsenenhum
page_sizequeryintegerfalsenenhum

Exemplos de resposta

Resposta 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "record_type": "member",
        "record_id": 1,
        "team_id": "A1b2C3d4E5f6",
        "user_id": 0,
        "inviter_user_id": 0,
        "invite_type": 0,
        "invite_country_code": 999,
        "invite_target": "string",
        "delivery_type": 0,
        "role": 1,
        "status": 0,
        "display_name": "string",
        "nickname": "string",
        "username": "string",
        "email": "string",
        "phone": "string",
        "joined_at": "string",
        "expired_at": "string",
        "created_at": "string"
      }
    ],
    "total": 0,
    "page": 1,
    "page_size": 1
  },
  "request_id": "string"
}

Respostas

StatusSignificadoDescriçãoEsquema
200OKHTTP bem-sucedido; continue julgando o código do corpo da respostaInline

Esquema da resposta

Valores enumerados

PropriedadeValor
record_typemember
record_typeinvitation
invite_type0
invite_type1
invite_type2
invite_type3
delivery_type0
delivery_type1
delivery_type2
delivery_type3
role1
role2
role3
role4
status0
status1
Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth

Ajustar as funções dos membros

Exemplos de código

# Você também pode usar wget
curl -X POST https://api.proxylite.com/end-point/team/members/update-role \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/team/members/update-role

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "team_member_id": 1,
  "role": 2
}

Parâmetros

NomeEmTipoObrigatórioDescrição
bodybodyobjecttruenenhum
» team_idbodyTeamPublicIdtrueLogotipo público da equipe, o primeiro caractere é uma letra ASCII e os demais caracteres contêm apenas letras e números ASCII; a chave primária numérica do banco de dados não foi emitida
» team_member_idbodyintegertruenenhum
» rolebodyintegertruenenhum

Valores enumerados

ParameterValue
» role2
» role3

Exemplos de resposta

Resposta 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "team_member_id": 1,
    "team_id": "A1b2C3d4E5f6",
    "user_id": 1,
    "role": 1,
    "status": 0,
    "joined_at": "string",
    "nickname": "string",
    "username": "string"
  },
  "request_id": "string"
}

Respostas

StatusSignificadoDescriçãoEsquema
200OKHTTP bem-sucedido; continue julgando o código do corpo da respostaInline

Esquema da resposta

Valores enumerados

PropriedadeValor
role1
role2
role3
role4
status0
status1
status2
status3
Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth

Remover membro da equipe

Exemplos de código

# Você também pode usar wget
curl -X POST https://api.proxylite.com/end-point/team/members/remove \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/team/members/remove

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "team_member_id": 1
}

Parâmetros

NomeEmTipoObrigatórioDescrição
bodybodyobjecttruenenhum
» team_idbodyTeamPublicIdtrueLogotipo público da equipe, o primeiro caractere é uma letra ASCII e os demais caracteres contêm apenas letras e números ASCII; a chave primária numérica do banco de dados não foi emitida
» team_member_idbodyintegertruenenhum

Exemplos de resposta

Resposta 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "team_member_id": 1,
    "team_id": "A1b2C3d4E5f6",
    "user_id": 1,
    "role": 1,
    "status": 0,
    "joined_at": "string",
    "nickname": "string",
    "username": "string"
  },
  "request_id": "string"
}

Respostas

StatusSignificadoDescriçãoEsquema
200OKHTTP foi bem-sucedido; quando o negócio dá certo data.status=3Inline

Esquema da resposta

Valores enumerados

PropriedadeValor
role1
role2
role3
role4
status0
status1
status2
status3
Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth

Saia do time

Exemplos de código

# Você também pode usar wget
curl -X POST https://api.proxylite.com/end-point/team/members/leave \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/team/members/leave

Body parameter

{
  "team_id": "A1b2C3d4E5f6"
}

Parâmetros

NomeEmTipoObrigatórioDescrição
bodybodyobjecttruenenhum
» team_idbodyTeamPublicIdtrueLogotipo público da equipe, o primeiro caractere é uma letra ASCII e os demais caracteres contêm apenas letras e números ASCII; a chave primária numérica do banco de dados não foi emitida

Exemplos de resposta

Resposta 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "team_member_id": 1,
    "team_id": "A1b2C3d4E5f6",
    "user_id": 1,
    "role": 1,
    "status": 0,
    "joined_at": "string",
    "nickname": "string",
    "username": "string"
  },
  "request_id": "string"
}

Respostas

StatusSignificadoDescriçãoEsquema
200OKHTTP foi bem-sucedido; quando o negócio é bem-sucedido, data.status=2Inline

Esquema da resposta

Valores enumerados

PropriedadeValor
role1
role2
role3
role4
status0
status1
status2
status3
Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth

Convite da equipe

Criação, consulta e processamento de convites de membros da equipe

Crie um convite de equipe

Exemplos de código

# Você também pode usar wget
curl -X POST https://api.proxylite.com/end-point/team/invitations/create \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/team/invitations/create

Crie convites por usuário cadastrado, email ou número de celular. Quando o e-mail ou número de celular corresponder a um usuário neste site, a resposta será normalizada para convite_type=1. O front-end pode enviar o modelo de caminho relativo do URL de convite deste site, e o servidor apenas substitui nele por um token de convite único. Depois que o alvo não registrado se registrar com o número de celular convidado ou concluir a verificação usando o e-mail convidado, o servidor vinculará o convite ainda válido ao novo usuário, rotacionará o token e reenviará apenas uma mensagem não lida no site; o token antigo no e-mail ou mensagem de texto original se tornará inválido. Se o convite por e-mail não tiver sido vinculado automaticamente, a conta atual registrada com o endereço de e-mail convidado poderá ser aceita diretamente, sem esperar por email_verify.

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "invite_type": 1,
  "role": 2,
  "user_id": 1,
  "email": "[email protected]",
  "country_code": 1,
  "phone": "string",
  "invitation_url_template": "/team/invitation/{{token}}"
}

Parâmetros

NomeEmTipoObrigatórioDescrição
bodybodyobjecttruenenhum
» team_idbodyTeamPublicIdtrueLogotipo público da equipe, o primeiro caractere é uma letra ASCII e os demais caracteres contêm apenas letras e números ASCII; a chave primária numérica do banco de dados não foi emitida
» invite_typebodyintegertrue1=Usuário registrado, 2=E-mail, 3=Número de celular
» rolebodyintegertrue2=administrador, 3=membro comum
» user_idbodyintegerfalseObrigatório quando convite_type=1
» emailbodystring(email)falseObrigatório quando convite_type=2
» country_codebodyintegerfalseObrigatório quando convite_type=3
» phonebodystringfalseObrigatório quando convite_type=3
» invitation_url_templatebodystringfalseO modelo de caminho relativo definido pelo front end deste site; deve começar com um único /, não deve conter nomes de domínio ou novas linhas e deve e pode conter apenas um espaço reservado
» anonymousbodyobjectfalsenenhum
»» invite_typebodyanyfalsenenhum
» anonymousbodyobjectfalsenenhum
»» invite_typebodyanyfalsenenhum
» anonymousbodyobjectfalsenenhum
»» invite_typebodyanyfalsenenhum

Valores enumerados

ParameterValue
» invite_type1
» invite_type2
» invite_type3
» role2
» role3

Exemplos de resposta

Resposta 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "invitation": {
      "id": 1,
      "team_id": "A1b2C3d4E5f6",
      "inviter_user_id": 1,
      "invitee_user_id": 0,
      "invite_type": 1,
      "invite_country_code": 999,
      "invite_target": "string",
      "delivery_type": 1,
      "role": 2,
      "status": 0,
      "accepted_by_user_id": 0,
      "expired_at": "2026-07-17 10:00:00",
      "accepted_at": null,
      "rejected_at": null,
      "cancelled_at": null,
      "created_at": "2026-07-10 10:00:00"
    },
    "invitation_token": "string",
    "invitation_url": "http://example.com",
    "notification_channels": {
      "email": "queued",
      "sms": "queued",
      "site_inner_message": "created"
    }
  },
  "request_id": "string"
}

Respostas

StatusSignificadoDescriçãoEsquema
200OKHTTP bem-sucedido; continue a julgar o código do corpo da resposta, 200 significa sucesso nos negóciosInline

Esquema da resposta

Valores enumerados

PropriedadeValor
invite_type1
invite_type2
invite_type3
delivery_type1
delivery_type2
delivery_type3
role2
role3
status0
status1
status2
status3
status4
emailqueued
emailfailed
emailskipped
smsqueued
smsfailed
smsskipped
site_inner_messagecreated
site_inner_messageexists
site_inner_messagefailed
Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth

Lista de convites da equipe

Exemplos de código

# Você também pode usar wget
curl -X GET https://api.proxylite.com/end-point/team/invitations?team_id=A1b2C3d4E5f6 \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/team/invitations

Acessível apenas para superadministradores ou administradores da equipe; convites pendentes que expiraram serão atualizados para expirados antes de serem retornados.

Parâmetros

NomeEmTipoObrigatórioDescrição
team_idqueryTeamPublicIdtrueIdentidade pública da equipe
pagequeryintegerfalseNúmero da página, começando em 1
page_sizequeryintegerfalseQuantidade por página

Exemplos de resposta

Resposta 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "id": 1,
        "team_id": "A1b2C3d4E5f6",
        "inviter_user_id": 1,
        "invitee_user_id": 0,
        "invite_type": 1,
        "invite_country_code": 999,
        "invite_target": "string",
        "delivery_type": 1,
        "role": 2,
        "status": 0,
        "accepted_by_user_id": 0,
        "expired_at": "2026-07-17 10:00:00",
        "accepted_at": null,
        "rejected_at": null,
        "cancelled_at": null,
        "created_at": "2026-07-10 10:00:00"
      }
    ],
    "total": 0,
    "page": 1,
    "page_size": 1
  },
  "request_id": "string"
}

Respostas

StatusSignificadoDescriçãoEsquema
200OKHTTP bem-sucedido; continue julgando o código do corpo da respostaInline

Esquema da resposta

Valores enumerados

PropriedadeValor
invite_type1
invite_type2
invite_type3
delivery_type1
delivery_type2
delivery_type3
role2
role3
status0
status1
status2
status3
status4
Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth

Visualizar convite da equipe

Exemplos de código

# Você também pode usar wget
curl -X GET https://api.proxylite.com/end-point/team/invitations/preview?invitation_token=string \
  -H 'Accept: application/json'

GET /end-point/team/invitations/preview

Visualize convites anonimamente usando um Invitation_token único; nenhum ID numérico de convite é usado no link.

Parâmetros

NomeEmTipoObrigatórioDescrição
invitation_tokenquerystringtrueO token único de texto simples não vazio transportado pelo link de convite

Exemplos de resposta

Resposta 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "team_name": "string",
    "role": 2,
    "status": 0,
    "expired_at": "string"
  },
  "request_id": "string"
}

Respostas

StatusSignificadoDescriçãoEsquema
200OKHTTP bem-sucedido; continue julgando o código do corpo da respostaInline

Esquema da resposta

Valores enumerados

PropriedadeValor
role2
role3
status0
status1
status2
status3
status4
Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: None

Reenviar notificação de convite de equipe

Exemplos de código

# Você também pode usar wget
curl -X POST https://api.proxylite.com/end-point/team/invitations/resend \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/team/invitations/resend

Reinvestir no canal de envio original; usuários registrados também enviam mensagens do site. O reenvio do token irá rotacioná-lo e todos os links de convite anteriores se tornarão inválidos imediatamente.

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "invitation_id": 1
}

Parâmetros

NomeEmTipoObrigatórioDescrição
bodybodyobjecttruenenhum
» team_idbodyTeamPublicIdtrueLogotipo público da equipe, o primeiro caractere é uma letra ASCII e os demais caracteres contêm apenas letras e números ASCII; a chave primária numérica do banco de dados não foi emitida
» invitation_idbodyintegertrueID do convite

Exemplos de resposta

Resposta 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "invitation": {
      "id": 1,
      "team_id": "A1b2C3d4E5f6",
      "inviter_user_id": 1,
      "invitee_user_id": 0,
      "invite_type": 1,
      "invite_country_code": 999,
      "invite_target": "string",
      "delivery_type": 1,
      "role": 2,
      "status": 0,
      "accepted_by_user_id": 0,
      "expired_at": "2026-07-17 10:00:00",
      "accepted_at": null,
      "rejected_at": null,
      "cancelled_at": null,
      "created_at": "2026-07-10 10:00:00"
    },
    "invitation_url": "http://example.com",
    "notification_channels": {
      "email": "queued",
      "sms": "queued",
      "site_inner_message": "created"
    }
  },
  "request_id": "string"
}

Respostas

StatusSignificadoDescriçãoEsquema
200OKHTTP bem-sucedido; continue julgando o código do corpo da respostaInline

Esquema da resposta

Valores enumerados

PropriedadeValor
invite_type1
invite_type2
invite_type3
delivery_type1
delivery_type2
delivery_type3
role2
role3
status0
status1
status2
status3
status4
emailqueued
emailfailed
emailskipped
smsqueued
smsfailed
smsskipped
site_inner_messagecreated
site_inner_messageexists
site_inner_messagefailed
Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth

Aceitar convite da equipe

Exemplos de código

# Você também pode usar wget
curl -X POST https://api.proxylite.com/end-point/team/invitations/accept \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/team/invitations/accept

O usuário conectado no momento usa um Invitation_token único para aceitar o convite, que deve corresponder ao destino do convite e pertencer ao site ao qual o convite pertence; não há necessidade de passar team_id.

Body parameter

{
  "invitation_token": "string"
}

Parâmetros

NomeEmTipoObrigatórioDescrição
bodybodyobjecttruenenhum
» invitation_tokenbodystringtrueToken de convite único em texto não criptografado

Exemplos de resposta

Resposta 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "team_member_id": 1,
    "team_id": "A1b2C3d4E5f6",
    "user_id": 1,
    "role": 1,
    "status": 0,
    "joined_at": "string",
    "nickname": "string",
    "username": "string"
  },
  "request_id": "string"
}

Respostas

StatusSignificadoDescriçãoEsquema
200OKHTTP foi bem-sucedido; quando o negócio é bem-sucedido, os dados são um objeto membroInline

Esquema da resposta

Valores enumerados

PropriedadeValor
role1
role2
role3
role4
status0
status1
status2
status3
Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth

Recusar convite da equipe

Exemplos de código

# Você também pode usar wget
curl -X POST https://api.proxylite.com/end-point/team/invitations/reject \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/team/invitations/reject

O usuário conectado no momento usa um Invitation_token único para rejeitar convites que correspondam ao usuário; não há necessidade de passar team_id.

Body parameter

{
  "invitation_token": "string"
}

Parâmetros

NomeEmTipoObrigatórioDescrição
bodybodyobjecttruenenhum
» invitation_tokenbodystringtrueToken de convite único em texto não criptografado

Exemplos de resposta

Resposta 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "id": 1,
    "team_id": "A1b2C3d4E5f6",
    "inviter_user_id": 1,
    "invitee_user_id": 0,
    "invite_type": 1,
    "invite_country_code": 999,
    "invite_target": "string",
    "delivery_type": 1,
    "role": 2,
    "status": 0,
    "accepted_by_user_id": 0,
    "expired_at": "2026-07-17 10:00:00",
    "accepted_at": null,
    "rejected_at": null,
    "cancelled_at": null,
    "created_at": "2026-07-10 10:00:00"
  },
  "request_id": "string"
}

Respostas

StatusSignificadoDescriçãoEsquema
200OKHTTP foi bem-sucedido; quando o negócio é bem-sucedido, data.status=2Inline

Esquema da resposta

Valores enumerados

PropriedadeValor
invite_type1
invite_type2
invite_type3
delivery_type1
delivery_type2
delivery_type3
role2
role3
status0
status1
status2
status3
status4
Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth

Cancelar convite da equipe

Exemplos de código

# Você também pode usar wget
curl -X POST https://api.proxylite.com/end-point/team/invitations/cancel \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/team/invitations/cancel

Para cancelar um convite pendente dentro de uma equipe específica, o operador deve ter autoridade para convidar o personagem alvo.

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "invitation_id": 1
}

Parâmetros

NomeEmTipoObrigatórioDescrição
bodybodyobjecttruenenhum
» team_idbodyTeamPublicIdtrueLogotipo público da equipe, o primeiro caractere é uma letra ASCII e os demais caracteres contêm apenas letras e números ASCII; a chave primária numérica do banco de dados não foi emitida
» invitation_idbodyintegertrueID do convite

Exemplos de resposta

Resposta 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "id": 1,
    "team_id": "A1b2C3d4E5f6",
    "inviter_user_id": 1,
    "invitee_user_id": 0,
    "invite_type": 1,
    "invite_country_code": 999,
    "invite_target": "string",
    "delivery_type": 1,
    "role": 2,
    "status": 0,
    "accepted_by_user_id": 0,
    "expired_at": "2026-07-17 10:00:00",
    "accepted_at": null,
    "rejected_at": null,
    "cancelled_at": null,
    "created_at": "2026-07-10 10:00:00"
  },
  "request_id": "string"
}

Respostas

StatusSignificadoDescriçãoEsquema
200OKHTTP foi bem-sucedido; quando o negócio dá certo data.status=3Inline

Esquema da resposta

Valores enumerados

PropriedadeValor
invite_type1
invite_type2
invite_type3
delivery_type1
delivery_type2
delivery_type3
role2
role3
status0
status1
status2
status3
status4
Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth

Ativos da equipe

Consulta de ativos de equipe e transferência de espaço pessoal/de equipe

Informações do pacote da equipe

Exemplos de código

# Você também pode usar wget
curl -X GET https://api.proxylite.com/end-point/team/product-info?team_id=A1b2C3d4E5f6 \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/team/product-info

Retorna o resumo do pacote do espaço de recursos da equipe especificado. Os campos são consistentes com os campos do pacote de /web_v1/user/info. Não retorna o perfil, o saldo ou o ID numérico interno da equipe do superadministrador da equipe. Use /web_v1/credit/info para obter detalhes do pacote de crédito.

Parâmetros

NomeEmTipoObrigatórioDescrição
team_idqueryTeamPublicIdtruenenhum

Exemplos de resposta

Resposta 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "team_id": "A1b2C3d4E5f6",
    "product_types": [
      0
    ],
    "product_residence_remain_count": 0,
    "product_residence_total_count": 0,
    "pdrue2_timestamp": 0,
    "remain": 0,
    "total_amount": 0,
    "scraping_remain": 0,
    "scraping_total_amount": 0,
    "scraping_timestamp": "string",
    "scraping_timestamp2": 0,
    "common_scraping_remain": 0,
    "common_scraping_total_amount": 0,
    "common_scraping_timestamp": "string",
    "common_scraping_timestamp2": 0,
    "pdidcr_count": 0,
    "pdidcr_total": 0,
    "pdidcr_traffic_remain": 0,
    "pdidcr_traffic_total": 0,
    "p_sitai_ip_count": 0,
    "p_sitai_ip": 0,
    "p_sitai_ip_total": 0,
    "p_sitai_remain": 0,
    "p_sitai_total": 0,
    "pdidc_count": 0,
    "pdidc_total": 0,
    "pdidc_ip_count": 0,
    "pdidc_ip_all_count": 0,
    "pdispr_count": 0,
    "pdispr_total": 0,
    "pdispr_traffic_remain": 0,
    "pdispr_traffic_total": 0,
    "product_datacenter_isp_traffic_ip_count": 0,
    "product_datacenter_isp_traffc_ip": 0,
    "product_datacenter_isp_traffc_ip_total": 0,
    "product_datacenter_isp_traffic_ip": 0,
    "product_datacenter_isp_traffic_ip_total": 0,
    "product_datacenter_isp_traffc_remain": 0,
    "product_datacenter_isp_traffc_total": 0,
    "product_datacenter_isp_traffic_remain": 0,
    "product_datacenter_isp_traffic_total": 0,
    "product_datacenter_isp_ip": 0,
    "product_datacenter_isp_ip_total": 0,
    "product_datacenter_isp_ip_count": 0,
    "product_datacenter_isp_ip_all_count": 0,
    "product_datacenter_isp_ip_traffic_remain": 0,
    "product_datacenter_isp_ip_traffic_total": 0,
    "product_agent_residence_remain_count": 0,
    "product_agent_residence_total_count": 0,
    "product_serp_remain": 0,
    "product_serp_total": 0,
    "product_serp_timestamp": "string",
    "product_serp_timestamp2": 0,
    "product_video_remain": 0,
    "product_video_total": 0,
    "product_video_timestamp": "string",
    "product_video_timestamp2": 0
  },
  "request_id": "string"
}

Respostas

StatusSignificadoDescriçãoEsquema
200OKHTTP bem-sucedido; continue julgando o código do corpo da respostaInline

Esquema da resposta

Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth

Lista de recursos da equipe

Exemplos de código

# Você também pode usar wget
curl -X GET https://api.proxylite.com/end-point/team/assets?team_id=A1b2C3d4E5f6 \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/team/assets

Parâmetros

NomeEmTipoObrigatórioDescrição
team_idqueryTeamPublicIdtruenenhum
pagequeryintegerfalsenenhum
page_sizequeryintegerfalsenenhum

Exemplos de resposta

Resposta 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "id": 1,
        "user_id": 1,
        "team_id": "A1b2C3d4E5f6",
        "team_user_id": 0,
        "product_id": 1,
        "product_type": 0,
        "parent_product_type": 0,
        "status": 0,
        "total_amount": 0,
        "remain": 0,
        "bandwidth": 0,
        "concurrency": 0,
        "expired_at": "string",
        "created_at": "string",
        "ip": "string",
        "country_code": "string",
        "country_name": "string",
        "asn": "string",
        "port": 0
      }
    ],
    "total": 0,
    "page": 1,
    "page_size": 1
  },
  "request_id": "string"
}

Respostas

StatusSignificadoDescriçãoEsquema
200OKHTTP bem-sucedido; continue julgando o código do corpo da respostaInline

Esquema da resposta

Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth

Ativos pessoais que podem ser atribuídos à equipe

Exemplos de código

# Você também pode usar wget
curl -X GET https://api.proxylite.com/end-point/team/assets/personal-candidates?team_id=A1b2C3d4E5f6 \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/team/assets/personal-candidates

Parâmetros

NomeEmTipoObrigatórioDescrição
team_idqueryTeamPublicIdtruenenhum
pagequeryintegerfalsenenhum
page_sizequeryintegerfalsenenhum

Exemplos de resposta

Resposta 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "id": 1,
        "user_id": 1,
        "team_id": "A1b2C3d4E5f6",
        "team_user_id": 0,
        "product_id": 1,
        "product_type": 0,
        "parent_product_type": 0,
        "status": 0,
        "total_amount": 0,
        "remain": 0,
        "bandwidth": 0,
        "concurrency": 0,
        "expired_at": "string",
        "created_at": "string",
        "ip": "string",
        "country_code": "string",
        "country_name": "string",
        "asn": "string",
        "port": 0
      }
    ],
    "total": 0,
    "page": 1,
    "page_size": 1
  },
  "request_id": "string"
}

Respostas

StatusSignificadoDescriçãoEsquema
200OKHTTP bem-sucedido; continue julgando o código do corpo da respostaInline

Esquema da resposta

Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth

Transferir ativos pessoais para a equipe

Exemplos de código

# Você também pode usar wget
curl -X POST https://api.proxylite.com/end-point/team/assets/move-in \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/team/assets/move-in

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "user_product_id": 1
}

Parâmetros

NomeEmTipoObrigatórioDescrição
bodybodyobjecttruenenhum
» team_idbodyTeamPublicIdtrueLogotipo público da equipe, o primeiro caractere é uma letra ASCII e os demais caracteres contêm apenas letras e números ASCII; a chave primária numérica do banco de dados não foi emitida
» user_product_idbodyintegertruenenhum

Exemplos de resposta

Resposta 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "id": 1,
    "user_id": 1,
    "team_id": "A1b2C3d4E5f6",
    "team_user_id": 0,
    "product_id": 1,
    "product_type": 0,
    "parent_product_type": 0,
    "status": 0,
    "total_amount": 0,
    "remain": 0,
    "bandwidth": 0,
    "concurrency": 0,
    "expired_at": "string",
    "created_at": "string",
    "ip": "string",
    "country_code": "string",
    "country_name": "string",
    "asn": "string",
    "port": 0
  },
  "request_id": "string"
}

Respostas

StatusSignificadoDescriçãoEsquema
200OKHTTP bem-sucedido; continue julgando o código do corpo da respostaInline

Esquema da resposta

Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth

Os ativos da equipe foram transferidos de volta para os indivíduos

Exemplos de código

# Você também pode usar wget
curl -X POST https://api.proxylite.com/end-point/team/assets/move-out \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/team/assets/move-out

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "user_product_id": 1
}

Parâmetros

NomeEmTipoObrigatórioDescrição
bodybodyobjecttruenenhum
» team_idbodyTeamPublicIdtrueLogotipo público da equipe, o primeiro caractere é uma letra ASCII e os demais caracteres contêm apenas letras e números ASCII; a chave primária numérica do banco de dados não foi emitida
» user_product_idbodyintegertruenenhum

Exemplos de resposta

Resposta 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "id": 1,
    "user_id": 1,
    "team_id": "A1b2C3d4E5f6",
    "team_user_id": 0,
    "product_id": 1,
    "product_type": 0,
    "parent_product_type": 0,
    "status": 0,
    "total_amount": 0,
    "remain": 0,
    "bandwidth": 0,
    "concurrency": 0,
    "expired_at": "string",
    "created_at": "string",
    "ip": "string",
    "country_code": "string",
    "country_name": "string",
    "asn": "string",
    "port": 0
  },
  "request_id": "string"
}

Respostas

StatusSignificadoDescriçãoEsquema
200OKHTTP bem-sucedido; continue julgando o código do corpo da respostaInline

Esquema da resposta

Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth

Gestão de pontos

Informações sobre pacotes de pontos, reposição automática, registros e estatísticas de consumo

Obtenha informações sobre o pacote de pontos (GET /web_v1/credit/info)

Exemplos de código

# Você também pode usar wget
curl -X GET https://api.proxylite.com/web_v1/credit/info \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /web_v1/credit/info

Consulte o resumo do pacote de pontos do espaço de recursos atual. O espaço da equipe requer permissão USE_ASSETS; esta interface suporta status de login, chave de API pessoal e chave de API de equipe ao mesmo tempo.

Parâmetros

NomeEmTipoObrigatórioDescrição
team_idqueryResourceSpaceIdfalseIdentificador de espaço de recursos; o espaço pessoal é omitido ou uma string vazia é passada; A chave de API da equipe pode ser omitida e deve ser consistente com a chave quando transmitida

Exemplos de resposta

Resposta 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Respostas

StatusSignificadoDescriçãoEsquema
200OKHTTP foi bem-sucedido; quando o negócio é bem-sucedido, os dados são nível de pontos, valor total, valor restante, tempo de reinicialização e status de reposição automática.Inline

Esquema da resposta

Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth, apiKeyAuth

Configure o saldo para reabastecer pontos automaticamente

Exemplos de código

# Você também pode usar wget
curl -X POST https://api.proxylite.com/web_v1/credit/update-auto-supplement \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /web_v1/credit/update-auto-supplement

Defina a chave de reabastecimento automático do espaço de recursos atual no estado de login. O espaço da equipe requer permissão USE_OWNER_PAYMENT_CAPABILITIES, atualmente apenas superadministradores da equipe podem operar; o espaço da equipe é fechado por padrão.

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "status": 0
}

Parâmetros

NomeEmTipoObrigatórioDescrição
bodybodyobjecttruenenhum
» team_idbodyanyfalseIdentificação do espaço de recursos públicos; omita team_id ou passe uma string vazia ao solicitar um espaço pessoal e uma string vazia ao responder a um espaço pessoal; tanto o número 0 quanto a string "0" são ilegais, e o espaço da equipe usa uma identificação pública da equipe de 6 a 12 dígitos
»» anonymousbodystringfalsenenhum
»» anonymousbodyTeamPublicIdfalseLogotipo público da equipe, o primeiro caractere é uma letra ASCII e os demais caracteres contêm apenas letras e números ASCII; a chave primária numérica do banco de dados não foi emitida
» statusbodyintegertrue0=desligado, 1=ligado

Valores enumerados

ParameterValue
» status0
» status1

Exemplos de resposta

Resposta 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Respostas

StatusSignificadoDescriçãoEsquema
200OKHTTP foi bem-sucedido; quando o negócio é bem-sucedido, data.status é o status atualizado do switch.Inline

Esquema da resposta

Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth

Obtenha registro de consumo de pontos (GET /web_v1/credit/consumption-logs)

Exemplos de código

# Você também pode usar wget
curl -X GET https://api.proxylite.com/web_v1/credit/consumption-logs \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /web_v1/credit/consumption-logs

Consulte o registro de consumo de pontos do espaço de recursos atual no estado de login ou na página da chave de API. Os espaços de equipe exigem permissão de VIEW_BILLING.

Parâmetros

NomeEmTipoObrigatórioDescrição
team_idqueryResourceSpaceIdfalsenenhum
pagequeryintegerfalsenenhum
page_sizequeryintegerfalsenenhum
start_datequerystring(date)falseData de início, interpretada pelo fuso horário do site
end_datequerystring(date)falseData de término, interpretada pelo fuso horário do site
consumption_typequerystringfalseTipo de consumo

Exemplos de resposta

Resposta 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Respostas

StatusSignificadoDescriçãoEsquema
200OKHTTP foi bem-sucedido; quando o negócio é bem-sucedido, os dados incluem lista, página, page_size, total_count e total_pageInline

Esquema da resposta

Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth, apiKeyAuth

Obter registro de redefinição de pontos (GET /web_v1/credit/reset-logs)

Exemplos de código

# Você também pode usar wget
curl -X GET https://api.proxylite.com/web_v1/credit/reset-logs \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /web_v1/credit/reset-logs

Consulte o registro de redefinição de pontos do espaço de recursos atual no estado de login ou na página da chave de API. Os espaços de equipe exigem permissão de VIEW_BILLING.

Parâmetros

NomeEmTipoObrigatórioDescrição
team_idqueryResourceSpaceIdfalsenenhum
pagequeryintegerfalsenenhum
page_sizequeryintegerfalsenenhum

Exemplos de resposta

Resposta 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Respostas

StatusSignificadoDescriçãoEsquema
200OKHTTP foi bem-sucedido; quando o negócio é bem-sucedido, os dados contêm registros de redefinição de pontos e informações de paginação.Inline

Esquema da resposta

Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth, apiKeyAuth

Obtenha estatísticas de pontos (GET /web_v1/credit/stats)

Exemplos de código

# Você também pode usar wget
curl -X GET https://api.proxylite.com/web_v1/credit/stats \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /web_v1/credit/stats

Faça login ou chave API para consultar as estatísticas de pontos agregadas por tipo de consumo do espaço de recursos atual. Os espaços de equipe exigem permissão de VIEW_BILLING.

Parâmetros

NomeEmTipoObrigatórioDescrição
team_idqueryResourceSpaceIdfalsenenhum
start_datequerystring(date)falseData de início, interpretada pelo fuso horário do site
end_datequerystring(date)falseData de término, interpretada pelo fuso horário do site

Exemplos de resposta

Resposta 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Respostas

StatusSignificadoDescriçãoEsquema
200OKHTTP foi bem-sucedido; quando o negócio é bem-sucedido, os dados contêm por tipo e totalInline

Esquema da resposta

Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth, apiKeyAuth

Obtenha estatísticas diárias de pontos (GET /web_v1/credit/daily-stats)

Exemplos de código

# Você também pode usar wget
curl -X GET https://api.proxylite.com/web_v1/credit/daily-stats \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /web_v1/credit/daily-stats

Faça login ou chave de API para consultar o consumo diário de pontos do espaço de recursos atual, cujo padrão é os últimos 7 dias. Os membros comuns da equipe apenas retornam o seu consumo real; administradores, superadministradores e membros financeiros com permissões VIEW_BILLING retornam os dados completos da equipe. Os registros da equipe de membros consumidores não registrados só são visíveis na visualização completa. A consulta da chave de API pode conter até 31 dias naturais (inclusive) e a data de início não pode ser posterior à data de término.

Parâmetros

NomeEmTipoObrigatórioDescrição
team_idqueryResourceSpaceIdfalsenenhum
start_datequerystring(date)falseData de início, padrão 6 dias atrás
end_datequerystring(date)falseData de término, o padrão é hoje
consumption_typequerystringfalseTipos de consumo opcionais
fill_gapsqueryintegerfalseSe deve preencher datas faltantes

Valores enumerados

ParameterValue
fill_gaps0
fill_gaps1

Exemplos de resposta

Resposta 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Respostas

StatusSignificadoDescriçãoEsquema
200OKHTTP foi bem-sucedido; quando o negócio é bem-sucedido, os dados contêm estatísticas diárias e resumoInline

Esquema da resposta

Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth, apiKeyAuth

Obtenha estatísticas de pontos por hora (GET /web_v1/credit/hourly-stats)

Exemplos de código

# Você também pode usar wget
curl -X GET https://api.proxylite.com/web_v1/credit/hourly-stats \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /web_v1/credit/hourly-stats

Faça login ou chave de API para consultar o consumo de pontos por hora do espaço de recursos atual, cujo padrão é os últimos 7 dias. Os espaços de equipe exigem permissão de VIEW_BILLING. A consulta da chave de API pode conter até 31 dias naturais (inclusive) e a data de início não pode ser posterior à data de término.

Parâmetros

NomeEmTipoObrigatórioDescrição
team_idqueryResourceSpaceIdfalsenenhum
start_datequerystring(date)falseData de início, padrão 6 dias atrás
end_datequerystring(date)falseData de término, o padrão é hoje
consumption_typequerystringfalseTipos de consumo opcionais
fill_gapsqueryintegerfalseSe deve preencher horas faltantes

Valores enumerados

ParameterValue
fill_gaps0
fill_gaps1

Exemplos de resposta

Resposta 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Respostas

StatusSignificadoDescriçãoEsquema
200OKHTTP foi bem-sucedido; quando o negócio é bem-sucedido, os dados contêm estatísticas horárias e resumoInline

Esquema da resposta

Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth, apiKeyAuth

Obtenha informações sobre o pacote de pontos (GET /end-point/credit/info)

Exemplos de código

# Você também pode usar wget
curl -X GET https://api.proxylite.com/end-point/credit/info \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/credit/info

Consulte o resumo do pacote de pontos do espaço de recursos atual. O espaço da equipe requer permissão USE_ASSETS; esta interface suporta status de login, chave de API pessoal e chave de API de equipe ao mesmo tempo.

Parâmetros

NomeEmTipoObrigatórioDescrição
team_idqueryResourceSpaceIdfalseIdentificador de espaço de recursos; o espaço pessoal é omitido ou uma string vazia é passada; A chave de API da equipe pode ser omitida e deve ser consistente com a chave quando transmitida

Exemplos de resposta

Resposta 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Respostas

StatusSignificadoDescriçãoEsquema
200OKHTTP foi bem-sucedido; quando o negócio é bem-sucedido, os dados são nível de pontos, valor total, valor restante, tempo de reinicialização e status de reposição automática.Inline

Esquema da resposta

Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth, apiKeyAuth

Obtenha registro de consumo de pontos (GET /end-point/credit/consumption-logs)

Exemplos de código

# Você também pode usar wget
curl -X GET https://api.proxylite.com/end-point/credit/consumption-logs \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/credit/consumption-logs

Consulte o registro de consumo de pontos do espaço de recursos atual no estado de login ou na página da chave de API. Os espaços de equipe exigem permissão de VIEW_BILLING.

Parâmetros

NomeEmTipoObrigatórioDescrição
team_idqueryResourceSpaceIdfalsenenhum
pagequeryintegerfalsenenhum
page_sizequeryintegerfalsenenhum
start_datequerystring(date)falseData de início, interpretada pelo fuso horário do site
end_datequerystring(date)falseData de término, interpretada pelo fuso horário do site
consumption_typequerystringfalseTipo de consumo

Exemplos de resposta

Resposta 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Respostas

StatusSignificadoDescriçãoEsquema
200OKHTTP foi bem-sucedido; quando o negócio é bem-sucedido, os dados incluem lista, página, page_size, total_count e total_pageInline

Esquema da resposta

Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth, apiKeyAuth

Obter registro de redefinição de pontos (GET /end-point/credit/reset-logs)

Exemplos de código

# Você também pode usar wget
curl -X GET https://api.proxylite.com/end-point/credit/reset-logs \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/credit/reset-logs

Consulte o registro de redefinição de pontos do espaço de recursos atual no estado de login ou na página da chave de API. Os espaços de equipe exigem permissão de VIEW_BILLING.

Parâmetros

NomeEmTipoObrigatórioDescrição
team_idqueryResourceSpaceIdfalsenenhum
pagequeryintegerfalsenenhum
page_sizequeryintegerfalsenenhum

Exemplos de resposta

Resposta 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Respostas

StatusSignificadoDescriçãoEsquema
200OKHTTP foi bem-sucedido; quando o negócio é bem-sucedido, os dados contêm registros de redefinição de pontos e informações de paginação.Inline

Esquema da resposta

Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth, apiKeyAuth

Obtenha estatísticas de pontos (GET /end-point/credit/stats)

Exemplos de código

# Você também pode usar wget
curl -X GET https://api.proxylite.com/end-point/credit/stats \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/credit/stats

Faça login ou chave API para consultar as estatísticas de pontos agregadas por tipo de consumo do espaço de recursos atual. Os espaços de equipe exigem permissão de VIEW_BILLING.

Parâmetros

NomeEmTipoObrigatórioDescrição
team_idqueryResourceSpaceIdfalsenenhum
start_datequerystring(date)falseData de início, interpretada pelo fuso horário do site
end_datequerystring(date)falseData de término, interpretada pelo fuso horário do site

Exemplos de resposta

Resposta 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Respostas

StatusSignificadoDescriçãoEsquema
200OKHTTP foi bem-sucedido; quando o negócio é bem-sucedido, os dados contêm por tipo e totalInline

Esquema da resposta

Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth, apiKeyAuth

Obtenha estatísticas diárias de pontos (GET /end-point/credit/daily-stats)

Exemplos de código

# Você também pode usar wget
curl -X GET https://api.proxylite.com/end-point/credit/daily-stats \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/credit/daily-stats

Faça login ou chave de API para consultar o consumo diário de pontos do espaço de recursos atual, cujo padrão é os últimos 7 dias. Os membros comuns da equipe apenas retornam o seu consumo real; administradores, superadministradores e membros financeiros com permissões VIEW_BILLING retornam os dados completos da equipe. Os registros da equipe de membros consumidores não registrados só são visíveis na visualização completa. A consulta da chave de API pode conter até 31 dias naturais (inclusive) e a data de início não pode ser posterior à data de término.

Parâmetros

NomeEmTipoObrigatórioDescrição
team_idqueryResourceSpaceIdfalsenenhum
start_datequerystring(date)falseData de início, padrão 6 dias atrás
end_datequerystring(date)falseData de término, o padrão é hoje
consumption_typequerystringfalseTipos de consumo opcionais
fill_gapsqueryintegerfalseSe deve preencher datas faltantes

Valores enumerados

ParameterValue
fill_gaps0
fill_gaps1

Exemplos de resposta

Resposta 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Respostas

StatusSignificadoDescriçãoEsquema
200OKHTTP foi bem-sucedido; quando o negócio é bem-sucedido, os dados contêm estatísticas diárias e resumoInline

Esquema da resposta

Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth, apiKeyAuth

Obtenha estatísticas de pontos por hora (GET /end-point/credit/hourly-stats)

Exemplos de código

# Você também pode usar wget
curl -X GET https://api.proxylite.com/end-point/credit/hourly-stats \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/credit/hourly-stats

Faça login ou chave de API para consultar o consumo de pontos por hora do espaço de recursos atual, cujo padrão é os últimos 7 dias. Os espaços de equipe exigem permissão de VIEW_BILLING. A consulta da chave de API pode conter até 31 dias naturais (inclusive) e a data de início não pode ser posterior à data de término.

Parâmetros

NomeEmTipoObrigatórioDescrição
team_idqueryResourceSpaceIdfalsenenhum
start_datequerystring(date)falseData de início, padrão 6 dias atrás
end_datequerystring(date)falseData de término, o padrão é hoje
consumption_typequerystringfalseTipos de consumo opcionais
fill_gapsqueryintegerfalseSe deve preencher horas faltantes

Valores enumerados

ParameterValue
fill_gaps0
fill_gaps1

Exemplos de resposta

Resposta 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Respostas

StatusSignificadoDescriçãoEsquema
200OKHTTP foi bem-sucedido; quando o negócio é bem-sucedido, os dados contêm estatísticas horárias e resumoInline

Esquema da resposta

Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth, apiKeyAuth

Xcrawl Activity Log

Xcrawl registros de tarefa única e tarefa em lote, detalhes e consulta de resumo

Obtenha uma lista de tarefas recentes do Xcrawl

Exemplos de código

# Você também pode usar wget
curl -X GET https://api.proxylite.com/web_v1/xcrawl-activity-log/recent-runs \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /web_v1/xcrawl-activity-log/recent-runs

Faça login para consultar a lista de tarefas única e o resumo do espaço de recursos atual. O espaço da equipe requer USE_ASSETS; membros comuns só podem visualizar as tarefas geradas por suas próprias credenciais, e administradores e superadministradores podem visualizar as tarefas de toda a equipe.

Parâmetros

NomeEmTipoObrigatórioDescrição
team_idqueryResourceSpaceIdfalsenenhum
pagequeryintegerfalsenenhum
page_sizequeryintegerfalsenenhum
endpointquerystringfalsetipo de terminal
statusquerystringfalsenenhum
start_timequerystringfalseHorário do fuso horário do usuário, formato Y-m-d H:i:s
end_timequerystringfalseFuso horário do usuário, incluindo limite final
urlquerystringfalseURL de destino ou ID do raspador de dados
job_idquerystringfalsePrefixo do ID da tarefa

Valores enumerados

ParameterValue
statuspending
statuscrawling
statuscompleted
statusfailed

Exemplos de resposta

Resposta 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Respostas

StatusSignificadoDescriçãoEsquema
200OKHTTP foi bem-sucedido; quando o negócio é bem-sucedido, os dados contêm lista de paginação e metadadosInline

Esquema da resposta

Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth

Obtenha o resultado do rastreamento Xcrawl

Exemplos de código

# Você também pode usar wget
curl -X GET https://api.proxylite.com/web_v1/xcrawl-activity-log/crawl-result?job_id=string \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /web_v1/xcrawl-activity-log/crawl-result

No estado de login, consulte o resultado do rastreamento da tarefa especificada no espaço de recursos atual. O espaço da equipe requer USE_ASSETS e verifica a propriedade da tarefa com base no intervalo de credenciais visíveis do membro.

Parâmetros

NomeEmTipoObrigatórioDescrição
team_idqueryResourceSpaceIdfalsenenhum
job_idquerystringtrueID da tarefa

Exemplos de resposta

Resposta 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Respostas

StatusSignificadoDescriçãoEsquema
200OKHTTP foi bem-sucedido; quando o negócio é bem-sucedido, os dados contêm job_id e crawl_resultInline

Esquema da resposta

Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth

Obtenha detalhes e registros da missão Xcrawl

Exemplos de código

# Você também pode usar wget
curl -X GET https://api.proxylite.com/web_v1/xcrawl-activity-log/activity-logs?job_id=string \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /web_v1/xcrawl-activity-log/activity-logs

No estado de login, consulte o espaço de recursos atual para especificar uma única tarefa e seus detalhes de resultado. O espaço da equipe requer USE_ASSETS e verifica a propriedade da tarefa com base no intervalo de credenciais visíveis do membro.

Parâmetros

NomeEmTipoObrigatórioDescrição
team_idqueryResourceSpaceIdfalsenenhum
job_idquerystringtrueID da tarefa
pagequeryintegerfalsenúmero da página do subresultado de rastreamento/dados
page_sizequeryintegerfalsenúmero de rastreamento/dados de páginas de subresultados

Exemplos de resposta

Resposta 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Respostas

StatusSignificadoDescriçãoEsquema
200OKHTTP foi bem-sucedido; quando o negócio é bem-sucedido, os dados contêm trabalhos e detalhes alterados por endpoint.Inline

Esquema da resposta

Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth

Obtenha estatísticas agregadas de URL de dados

Exemplos de código

# Você também pode usar wget
curl -X GET https://api.proxylite.com/web_v1/xcrawl-activity-log/data-url-summary \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /web_v1/xcrawl-activity-log/data-url-summary

Tarefas de raspagem de dados que agregam o espaço de recursos atual no estado de login. Os espaços de equipe exigem USE_ASSETS e os resultados seguem o escopo de credencial visível do membro.

Parâmetros

NomeEmTipoObrigatórioDescrição
team_idqueryResourceSpaceIdfalsenenhum
limitqueryintegerfalseQuantidade de devolução; 0 retorna uma lista vazia

Exemplos de resposta

Resposta 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Respostas

StatusSignificadoDescriçãoEsquema
200OKHTTP foi bem-sucedido; quando o negócio é bem-sucedido, data.list é o resultado da agregação do scraper.Inline

Esquema da resposta

Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth

Obtenha uma lista de tarefas recentes de rastreamento em lote

Exemplos de código

# Você também pode usar wget
curl -X GET https://api.proxylite.com/web_v1/xcrawl-activity-log/batch-recent-runs \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /web_v1/xcrawl-activity-log/batch-recent-runs

Faça login para consultar a lista de tarefas em lote e o resumo do espaço de recursos atual. O espaço da equipe requer USE_ASSETS; membros comuns só podem visualizar as tarefas geradas por suas próprias credenciais, e administradores e superadministradores podem visualizar as tarefas de toda a equipe.

Parâmetros

NomeEmTipoObrigatórioDescrição
team_idqueryResourceSpaceIdfalsenenhum
pagequeryintegerfalsenenhum
page_sizequeryintegerfalsenenhum
endpointquerystringfalseTipo de endpoint, geralmente batch_scrape
statusquerystringfalsenenhum
start_timequerystringfalseHorário do fuso horário do usuário, formato Y-m-d H:i:s
end_timequerystringfalseFuso horário do usuário, incluindo limite final
batch_idquerystringfalsePrefixo do ID da tarefa em lote

Valores enumerados

ParameterValue
statuspending
statuscrawling
statuscompleted
statusfailed

Exemplos de resposta

Resposta 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Respostas

StatusSignificadoDescriçãoEsquema
200OKHTTP foi bem-sucedido; quando o negócio é bem-sucedido, os dados contêm lista de paginação e metadadosInline

Esquema da resposta

Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth

Obtenha detalhes e registros de tarefas de rastreamento em lote

Exemplos de código

# Você também pode usar wget
curl -X GET https://api.proxylite.com/web_v1/xcrawl-activity-log/batch-activity-logs?batch_id=string \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /web_v1/xcrawl-activity-log/batch-activity-logs

No estado de login, consulte as tarefas em lote especificadas e seus resultados de subitem no espaço de recursos atual. O espaço da equipe requer USE_ASSETS e verifica a propriedade da tarefa com base no intervalo de credenciais visíveis do membro.

Parâmetros

NomeEmTipoObrigatórioDescrição
team_idqueryResourceSpaceIdfalsenenhum
batch_idquerystringtrueID da tarefa em lote
pagequeryintegerfalseNúmero da página do subitem
page_sizequeryintegerfalseNúmero de subpáginas

Exemplos de resposta

Resposta 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Respostas

StatusSignificadoDescriçãoEsquema
200OKHTTP foi bem-sucedido; quando o negócio é bem-sucedido, os dados contêm detalhes do trabalho e da tarefa em loteInline

Esquema da resposta

Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth

Gerenciamento de contas

Obtenha uma visão geral da sua conta pessoal

Exemplos de código

# Você também pode usar wget
curl -X GET https://api.proxylite.com/end-point/account/profile \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/account/profile

Somente o status de login do espaço pessoal ou da chave de API pessoal é suportado; A chave de API da equipe não é compatível.

Exemplos de resposta

Resposta 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "id": 0,
    "username": "string",
    "nickname": "string",
    "email": "string",
    "balance": "string",
    "gift_balance": "string",
    "currency": "string",
    "language": "string",
    "timezone": "string"
  },
  "request_id": "string"
}

Respostas

StatusSignificadoDescriçãoEsquema
200OKHTTP bem-sucedido; verifique o código comercial, 200 significa sucesso.Inline

Esquema da resposta

Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth, apiKeyAuth

Verifique o extrato de saldo pessoal

Exemplos de código

# Você também pode usar wget
curl -X GET https://api.proxylite.com/end-point/wallet/change-list \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/wallet/change-list

Somente o status de login do espaço pessoal ou da chave de API pessoal é suportado; A chave de API da equipe não é compatível.

Parâmetros

NomeEmTipoObrigatórioDescrição
re_typequeryintegerfalsenenhum
transaction_typequeryintegerfalsenenhum
balance_typequeryintegerfalsenenhum
pagequeryintegerfalsenenhum
page_sizequeryintegerfalsenenhum

Valores enumerados

ParameterValue
re_type0
re_type1

Exemplos de resposta

Resposta 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "id": 0,
        "re_type": 0,
        "transaction_type": 0,
        "balance_type": 0,
        "fee": "string"
      }
    ],
    "page": 0,
    "page_size": 0,
    "total_count": 0
  },
  "request_id": "string"
}

Respostas

StatusSignificadoDescriçãoEsquema
200OKHTTP bem-sucedido; verifique o código comercial, 200 significa sucesso.Inline

Esquema da resposta

Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth, apiKeyAuth

Exportação de registros

Crie uma tarefa de exportação de log do agente

Exemplos de código

# Você também pode usar wget
curl -X POST https://api.proxylite.com/end-point/user-usage-flow-log-export/create \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/user-usage-flow-log-export/create

Somente o status de login do espaço pessoal ou da chave de API pessoal é suportado; A chave de API da equipe não é compatível. O horário de início deve ser anterior ao horário de término e o intervalo de tempo não excede 31 dias; o mesmo usuário só tem permissão para uma tarefa de exportação em espera ou processamento, e o limite superior de logs é de 5 milhões.

Body parameter

{
  "start_time": 0,
  "end_time": 0,
  "type": "dynamic"
}

Parâmetros

NomeEmTipoObrigatórioDescrição
bodybodyobjecttruenenhum
» start_timebodyintegertrueCarimbo de data e hora inicial do Unix, segundos
» end_timebodyintegertruecarimbo de data/hora Unix final, segundos
» typebodystringfalsenenhum

Valores enumerados

ParameterValue
» typedynamic
» typehost_pool

Exemplos de resposta

Resposta 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "task_id": 0,
    "status": "string"
  },
  "request_id": "string"
}

Respostas

StatusSignificadoDescriçãoEsquema
200OKHTTP bem-sucedido; verifique o código comercial, 200 significa sucesso.Inline

Esquema da resposta

Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth, apiKeyAuth

Consultar detalhes da tarefa de exportação de log

Exemplos de código

# Você também pode usar wget
curl -X GET https://api.proxylite.com/end-point/user-usage-flow-log-export/detail?task_id=1 \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/user-usage-flow-log-export/detail

Somente o status de login do espaço pessoal ou da chave de API pessoal é suportado; A chave de API da equipe não é compatível.

Parâmetros

NomeEmTipoObrigatórioDescrição
task_idqueryintegertruenenhum

Exemplos de resposta

Resposta 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "id": 0,
    "user_id": 0,
    "start_time": "string",
    "end_time": "string",
    "status": "pending",
    "file_size": 0,
    "record_count": 0,
    "created_at": "string",
    "completed_at": "string",
    "file_url": "string",
    "download_url": "string",
    "error_message": "string"
  },
  "request_id": "string"
}

Respostas

StatusSignificadoDescriçãoEsquema
200OKHTTP bem-sucedido; verifique o código comercial, 200 significa sucesso.Inline

Esquema da resposta

Valores enumerados

PropriedadeValor
statuspending
statusprocessing
statuscompleted
statusfailed
statuscanceled
statusno_data
Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth, apiKeyAuth

Consultar lista de tarefas de exportação de log

Exemplos de código

# Você também pode usar wget
curl -X GET https://api.proxylite.com/end-point/user-usage-flow-log-export/list \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/user-usage-flow-log-export/list

Somente o status de login do espaço pessoal ou da chave de API pessoal é suportado; A chave de API da equipe não é compatível.

Parâmetros

NomeEmTipoObrigatórioDescrição
pagequeryintegerfalsenenhum
sizequeryintegerfalsenenhum

Exemplos de resposta

Resposta 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "id": 0,
        "user_id": 0,
        "start_time": "string",
        "end_time": "string",
        "status": "pending",
        "file_size": 0,
        "record_count": 0,
        "created_at": "string",
        "completed_at": "string",
        "file_url": "string",
        "download_url": "string",
        "error_message": "string"
      }
    ],
    "total": 0,
    "page": 0,
    "size": 0
  },
  "request_id": "string"
}

Respostas

StatusSignificadoDescriçãoEsquema
200OKHTTP bem-sucedido; verifique o código comercial, 200 significa sucesso.Inline

Esquema da resposta

Valores enumerados

PropriedadeValor
statuspending
statusprocessing
statuscompleted
statusfailed
statuscanceled
statusno_data
Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth, apiKeyAuth

Cancelar a tarefa de exportação de log que ainda não foi executada

Exemplos de código

# Você também pode usar wget
curl -X POST https://api.proxylite.com/end-point/user-usage-flow-log-export/cancel \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/user-usage-flow-log-export/cancel

Somente o status de login do espaço pessoal ou da chave de API pessoal é suportado; A chave de API da equipe não é compatível. Somente tarefas em estado de espera na fila podem ser canceladas e tarefas que já foram executadas não podem ser canceladas.

Body parameter

{
  "task_id": 1
}

Parâmetros

NomeEmTipoObrigatórioDescrição
bodybodyobjecttruenenhum
» task_idbodyintegertruenenhum

Exemplos de resposta

Resposta 200

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

Respostas

StatusSignificadoDescriçãoEsquema
200OKHTTP bem-sucedido; verifique o código comercial, 200 significa sucesso.Inline

Esquema da resposta

Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth, apiKeyAuth

Cupom

Consultar lista de cupons pessoais

Exemplos de código

# Você também pode usar wget
curl -X POST https://api.proxylite.com/end-point/user-coupon/list \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/user-coupon/list

Somente o status de login do espaço pessoal ou da chave de API pessoal é suportado; A chave de API da equipe não é compatível.

Body parameter

{
  "status": 0,
  "page": 1,
  "size": 20
}

Parâmetros

NomeEmTipoObrigatórioDescrição
bodybodyobjectfalsenenhum
» statusbodyintegerfalsenenhum
» pagebodyintegerfalsenenhum
» sizebodyintegerfalsenenhum

Valores enumerados

ParameterValue
» status0
» status1
» status2

Exemplos de resposta

Resposta 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "id": 0,
        "coupon_id": 0,
        "type": 0,
        "status": 0,
        "source": 0,
        "title": "string",
        "title_en": "string",
        "description": "string",
        "description_en": "string",
        "start_amount": "string",
        "start_amount_usd": "string",
        "start_amount_hkd": "string",
        "deduction_amount": "string",
        "deduction_amount_usd": "string",
        "deduction_amount_hkd": "string",
        "discount_rate": "string",
        "discount_ceiling_amount": "string",
        "discount_ceiling_amount_usd": "string",
        "discount_ceiling_amount_hkd": "string",
        "created_at": "string",
        "effect_at": "string",
        "expired_at": "string",
        "used_at": "string",
        "product_types": "string",
        "created_timestamp": 0,
        "effect_timestamp": 0,
        "expired_timestamp": 0,
        "used_timestamp": 0,
        "is_expired": true
      }
    ],
    "page": 0,
    "page_size": 0,
    "page_count": 0
  },
  "request_id": "string"
}

Respostas

StatusSignificadoDescriçãoEsquema
200OKHTTP bem-sucedido; verifique o código comercial, 200 significa sucesso.Inline

Esquema da resposta

Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth, apiKeyAuth

Verifique os detalhes pessoais do cupom

Exemplos de código

# Você também pode usar wget
curl -X POST https://api.proxylite.com/end-point/user-coupon/info \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/user-coupon/info

Somente o status de login do espaço pessoal ou da chave de API pessoal é suportado; A chave de API da equipe não é compatível.

Body parameter

{
  "id": 1
}

Parâmetros

NomeEmTipoObrigatórioDescrição
bodybodyobjecttruenenhum
» idbodyintegertruenenhum

Exemplos de resposta

Resposta 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "id": 0,
    "coupon_id": 0,
    "type": 0,
    "status": 0,
    "source": 0,
    "title": "string",
    "title_en": "string",
    "description": "string",
    "description_en": "string",
    "start_amount": "string",
    "start_amount_usd": "string",
    "start_amount_hkd": "string",
    "deduction_amount": "string",
    "deduction_amount_usd": "string",
    "deduction_amount_hkd": "string",
    "discount_rate": "string",
    "discount_ceiling_amount": "string",
    "discount_ceiling_amount_usd": "string",
    "discount_ceiling_amount_hkd": "string",
    "created_at": "string",
    "effect_at": "string",
    "expired_at": "string",
    "used_at": "string",
    "product_types": "string",
    "created_timestamp": 0,
    "effect_timestamp": 0,
    "expired_timestamp": 0,
    "used_timestamp": 0,
    "is_expired": true
  },
  "request_id": "string"
}

Respostas

StatusSignificadoDescriçãoEsquema
200OKHTTP bem-sucedido; verifique o código comercial, 200 significa sucesso.Inline

Esquema da resposta

Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth, apiKeyAuth

Gerenciamento de notificações

Verifique as notificações do site

Exemplos de código

# Você também pode usar wget
curl -X GET https://api.proxylite.com/end-point/notify/list \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/notify/list

Somente o status de login do espaço pessoal ou da chave de API pessoal é suportado; A chave de API da equipe não é compatível.

Parâmetros

NomeEmTipoObrigatórioDescrição
pagequeryintegerfalsenenhum
sizequeryintegerfalsenenhum
readqueryintegerfalsenenhum
typequeryintegerfalsenenhum

Valores enumerados

ParameterValue
read0
read1

Exemplos de resposta

Resposta 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "id": 0,
        "title": "string",
        "content": "string",
        "type": 0,
        "read_status": 0,
        "created_at": "string",
        "created_timestamp": 0
      }
    ],
    "page": 0,
    "size": 0,
    "total": 0,
    "total_unread_count": 0,
    "unread_count_by_type": {}
  },
  "request_id": "string"
}

Respostas

StatusSignificadoDescriçãoEsquema
200OKHTTP bem-sucedido; verifique o código comercial, 200 significa sucesso.Inline

Esquema da resposta

Valores enumerados

PropriedadeValor
read_status0
read_status1
Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth, apiKeyAuth

Verifique os detalhes da notificação do site

Exemplos de código

# Você também pode usar wget
curl -X GET https://api.proxylite.com/end-point/notify/detail?id=1 \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/notify/detail

Somente o status de login do espaço pessoal ou da chave de API pessoal é suportado; A chave de API da equipe não é compatível.

Parâmetros

NomeEmTipoObrigatórioDescrição
idqueryintegertruenenhum

Exemplos de resposta

Resposta 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "id": 0,
    "title": "string",
    "content": "string",
    "type": 0,
    "read_status": 0,
    "created_at": "string",
    "created_timestamp": 0
  },
  "request_id": "string"
}

Respostas

StatusSignificadoDescriçãoEsquema
200OKHTTP bem-sucedido; verifique o código comercial, 200 significa sucesso.Inline

Esquema da resposta

Valores enumerados

PropriedadeValor
read_status0
read_status1
Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth, apiKeyAuth

Marcar notificações do site como lidas

Exemplos de código

# Você também pode usar wget
curl -X POST https://api.proxylite.com/end-point/notify/read \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/notify/read

Somente o status de login do espaço pessoal ou da chave de API pessoal é suportado; A chave de API da equipe não é compatível.

Body parameter

{
  "id": 1
}

Parâmetros

NomeEmTipoObrigatórioDescrição
bodybodyobjecttruenenhum
» idbodyintegertruenenhum

Exemplos de resposta

Resposta 200

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

Respostas

StatusSignificadoDescriçãoEsquema
200OKHTTP bem-sucedido; verifique o código comercial, 200 significa sucesso.Inline

Esquema da resposta

Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth, apiKeyAuth

Marcar notificações do site como lidas em lotes

Exemplos de código

# Você também pode usar wget
curl -X POST https://api.proxylite.com/end-point/notify/batch-read \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/notify/batch-read

Somente o status de login do espaço pessoal ou da chave de API pessoal é suportado; A chave de API da equipe não é compatível.

Body parameter

{
  "ids": [
    1
  ]
}

Parâmetros

NomeEmTipoObrigatórioDescrição
bodybodyobjecttruenenhum
» idsbody[integer]truenenhum

Exemplos de resposta

Resposta 200

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

Respostas

StatusSignificadoDescriçãoEsquema
200OKHTTP bem-sucedido; verifique o código comercial, 200 significa sucesso.Inline

Esquema da resposta

Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth, apiKeyAuth

Configuração do canal de notificação de consulta

Exemplos de código

# Você também pode usar wget
curl -X GET https://api.proxylite.com/end-point/user-notify \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/user-notify

Somente o status de login do espaço pessoal ou da chave de API pessoal é suportado; A chave de API da equipe não é compatível.

Exemplos de resposta

Resposta 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "scene": 0,
        "email_notify": true,
        "phone_notify": true,
        "browser_notify": true,
        "site_inner_message_notify": true,
        "webhook_notify": true,
        "telegram_notify": true
      }
    ]
  },
  "request_id": "string"
}

Respostas

StatusSignificadoDescriçãoEsquema
200OKHTTP bem-sucedido; verifique o código comercial, 200 significa sucesso.Inline

Esquema da resposta

Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth, apiKeyAuth

E-mail de notificação de consulta

Exemplos de código

# Você também pode usar wget
curl -X GET https://api.proxylite.com/end-point/user-notification-email/list \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/user-notification-email/list

Somente o status de login do espaço pessoal ou da chave de API pessoal é suportado; A chave de API da equipe não é compatível.

Exemplos de resposta

Resposta 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "id": 0,
        "email": "string",
        "created_at": 0
      }
    ],
    "max_count": 0,
    "current_count": 0
  },
  "request_id": "string"
}

Respostas

StatusSignificadoDescriçãoEsquema
200OKHTTP bem-sucedido; verifique o código comercial, 200 significa sucesso.Inline

Esquema da resposta

Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth, apiKeyAuth

Cenário de notificação de consulta

Exemplos de código

# Você também pode usar wget
curl -X GET https://api.proxylite.com/end-point/user-notification-email/scenes \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/user-notification-email/scenes

Somente o status de login do espaço pessoal ou da chave de API pessoal é suportado; A chave de API da equipe não é compatível.

Exemplos de resposta

Resposta 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "id": 0,
        "name": "string",
        "description": "string"
      }
    ]
  },
  "request_id": "string"
}

Respostas

StatusSignificadoDescriçãoEsquema
200OKHTTP bem-sucedido; verifique o código comercial, 200 significa sucesso.Inline

Esquema da resposta

Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth, apiKeyAuth

Consultar cenário de assinatura de e-mail

Exemplos de código

# Você também pode usar wget
curl -X GET https://api.proxylite.com/end-point/user-notification-email/email-scenes?id=1 \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/user-notification-email/email-scenes

Somente o status de login do espaço pessoal ou da chave de API pessoal é suportado; A chave de API da equipe não é compatível.

Parâmetros

NomeEmTipoObrigatórioDescrição
idqueryintegertruenenhum

Exemplos de resposta

Resposta 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "scenes": [
      0
    ],
    "subscribe_all": true
  },
  "request_id": "string"
}

Respostas

StatusSignificadoDescriçãoEsquema
200OKHTTP bem-sucedido; verifique o código comercial, 200 significa sucesso.Inline

Esquema da resposta

Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth, apiKeyAuth

Configuração do agente

Consultar opção de cache do agente pessoal

Exemplos de código

# Você também pode usar wget
curl -X GET https://api.proxylite.com/end-point/proxy-cache/status \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/proxy-cache/status

Somente o status de login do espaço pessoal ou da chave de API pessoal é suportado; A chave de API da equipe não é compatível.

Exemplos de resposta

Resposta 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "status": 0
  },
  "request_id": "string"
}

Respostas

StatusSignificadoDescriçãoEsquema
200OKHTTP bem-sucedido; verifique o código comercial, 200 significa sucesso.Inline

Esquema da resposta

Valores enumerados

PropriedadeValor
status0
status1
Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth, apiKeyAuth

Definir opção de cache de proxy pessoal

Exemplos de código

# Você também pode usar wget
curl -X POST https://api.proxylite.com/end-point/proxy-cache/change \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/proxy-cache/change

Somente o status de login do espaço pessoal ou da chave de API pessoal é suportado; A chave de API da equipe não é compatível.

Body parameter

{
  "status": 0
}

Parâmetros

NomeEmTipoObrigatórioDescrição
bodybodyobjecttruenenhum
» statusbodyintegertruenenhum

Valores enumerados

ParameterValue
» status0
» status1

Exemplos de resposta

Resposta 200

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

Respostas

StatusSignificadoDescriçãoEsquema
200OKHTTP bem-sucedido; verifique o código comercial, 200 significa sucesso.Inline

Esquema da resposta

Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth, apiKeyAuth

Consultar switch UDP de agente pessoal

Exemplos de código

# Você também pode usar wget
curl -X GET https://api.proxylite.com/end-point/user-proxy-config/udp \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/user-proxy-config/udp

Somente o status de login do espaço pessoal ou da chave de API pessoal é suportado; A chave de API da equipe não é compatível.

Exemplos de resposta

Resposta 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "enabled": 0
  },
  "request_id": "string"
}

Respostas

StatusSignificadoDescriçãoEsquema
200OKHTTP bem-sucedido; verifique o código comercial, 200 significa sucesso.Inline

Esquema da resposta

Valores enumerados

PropriedadeValor
enabled0
enabled1
Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth, apiKeyAuth

Definir switch UDP de agente pessoal

Exemplos de código

# Você também pode usar wget
curl -X POST https://api.proxylite.com/end-point/user-proxy-config/udp \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/user-proxy-config/udp

Somente o status de login do espaço pessoal ou da chave de API pessoal é suportado; A chave de API da equipe não é compatível.

Body parameter

{
  "udp": 0
}

Parâmetros

NomeEmTipoObrigatórioDescrição
bodybodyobjecttruenenhum
» udpbodyintegertruenenhum

Valores enumerados

ParameterValue
» udp0
» udp1

Exemplos de resposta

Resposta 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "enabled": 0
  },
  "request_id": "string"
}

Respostas

StatusSignificadoDescriçãoEsquema
200OKHTTP bem-sucedido; verifique o código comercial, 200 significa sucesso.Inline

Esquema da resposta

Valores enumerados

PropriedadeValor
enabled0
enabled1
Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth, apiKeyAuth

Carteira da equipe

Consultar carteira da equipe

Exemplos de código

# Você também pode usar wget
curl -X GET https://api.proxylite.com/end-point/team/wallet/detail?team_id=A1b2C3d4E5f6 \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/team/wallet/detail

Requer permissão VIEW_BILLING. A carteira da equipe é independente dos superadministradores e dos saldos pessoais dos membros.

Parâmetros

NomeEmTipoObrigatórioDescrição
team_idqueryTeamPublicIdtruenenhum

Exemplos de resposta

Resposta 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "team_id": "A1b2C3d4E5f6",
    "balance": 0.1,
    "total_recharge_fee": 0.1,
    "updated_at": "string"
  },
  "request_id": "string"
}

Respostas

StatusSignificadoDescriçãoEsquema
200OKHTTP bem-sucedido; continue julgando o código do corpo da respostaInline

Esquema da resposta

Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth, apiKeyAuth

Verifique o fluxo da carteira da equipe

Exemplos de código

# Você também pode usar wget
curl -X GET https://api.proxylite.com/end-point/team/wallet/records?team_id=A1b2C3d4E5f6 \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/team/wallet/records

Requer permissão VIEW_BILLING. O valor do giro é sempre um número positivo, e o aumento ou diminuição dos recursos é representado pelo campo de direção.

Parâmetros

NomeEmTipoObrigatórioDescrição
team_idqueryTeamPublicIdtruenenhum
pagequeryintegerfalsenenhum
page_sizequeryintegerfalsenenhum

Exemplos de resposta

Resposta 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "id": 1,
        "team_id": "A1b2C3d4E5f6",
        "operator_user_id": 0,
        "creator": {
          "user_id": 0,
          "display_name": "string",
          "nickname": "string",
          "username": "string",
          "email": "string",
          "phone": "string"
        },
        "direction": 0,
        "transaction_type": 1,
        "amount": 0.1,
        "after_balance": 0.1,
        "link_id": 0,
        "request_id": "string",
        "remark": "string",
        "created_at": "string"
      }
    ],
    "total": 0,
    "page": 1,
    "page_size": 1
  },
  "request_id": "string"
}

Respostas

StatusSignificadoDescriçãoEsquema
200OKHTTP bem-sucedido; continue julgando o código do corpo da respostaInline

Esquema da resposta

Valores enumerados

PropriedadeValor
direction0
direction1
transaction_type1
transaction_type2
transaction_type3
transaction_type4
transaction_type5
Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth, apiKeyAuth

Transferir saldo pessoal para carteira da equipe

Exemplos de código

# Você também pode usar wget
curl -X POST https://api.proxylite.com/end-point/team/wallet/transfer-in \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/team/wallet/transfer-in

Somente superadministradores de equipe têm permissões TRANSFER_BALANCE. A carteira da equipe é adicionada após dedução atômica do saldo de recarga pessoal; o valor transferido não está incluído em total_recharge_fee e a transferência de volta para o saldo pessoal não é suportada.

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "amount": 9999999999.9999
}

Parâmetros

NomeEmTipoObrigatórioDescrição
bodybodyobjecttruenenhum
» team_idbodyTeamPublicIdtrueLogotipo público da equipe, o primeiro caractere é uma letra ASCII e os demais caracteres contêm apenas letras e números ASCII; a chave primária numérica do banco de dados não foi emitida
» amountbodynumber(double)truenenhum

Exemplos de resposta

Resposta 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "team_id": "A1b2C3d4E5f6",
    "balance": 0.1,
    "total_recharge_fee": 0.1,
    "updated_at": "string"
  },
  "request_id": "string"
}

Respostas

StatusSignificadoDescriçãoEsquema
200OKHTTP bem-sucedido; continue julgando o código do corpo da respostaInline

Esquema da resposta

Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth

Transferir o saldo da equipe de volta para a conta pessoal

Exemplos de código

# Você também pode usar wget
curl -X POST https://api.proxylite.com/end-point/team/wallet/transfer-out \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/team/wallet/transfer-out

Só pode ser chamado quando o superadministrador estiver logado. Deduções atômicas da carteira da equipe e aumento do saldo de recarga pessoal; não altere o valor de recarga cumulativa da equipe ou individual. A equipe dissolvida pode ser usada para recuperar o equilíbrio, mas a equipe dissolvida não pode ser chamada.

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "amount": 9999999999.9999
}

Parâmetros

NomeEmTipoObrigatórioDescrição
bodybodyobjecttruenenhum
» team_idbodyTeamPublicIdtrueLogotipo público da equipe, o primeiro caractere é uma letra ASCII e os demais caracteres contêm apenas letras e números ASCII; a chave primária numérica do banco de dados não foi emitida
» amountbodynumber(double)trueNão deve exceder o saldo atual disponível da equipe

Exemplos de resposta

Resposta 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "team_id": "A1b2C3d4E5f6",
    "balance": 0.1,
    "total_recharge_fee": 0.1,
    "updated_at": "string"
  },
  "request_id": "string"
}

Respostas

StatusSignificadoDescriçãoEsquema
200OKHTTP bem-sucedido; continue julgando o código do corpo da respostaInline

Esquema da resposta

Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth

Extração de IP

Extrair IP (GET /end-point/ip/get-ip)

Exemplos de código

# Você também pode usar wget
curl -X GET https://api.proxylite.com/end-point/ip/get-ip?app_key=pa%24%24word \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/ip/get-ip

Parâmetros

NomeEmTipoObrigatórioDescrição
team_idqueryResourceSpaceIdfalseA chave da equipe pode ser omitida; quando repassado, deve ser consistente com a equipe à qual a Chave está vinculada.
app_keyquerystring(password)truechave de acesso
ccquerystringfalsePaís ou região
statequerystringfalseprovíncia ou estado
cityquerystringfalsecidade
formatquerystringfalseObter formato
lbquerystringfalseSeparador, válido apenas em formato de texto
numquerynumberfalseExtrair quantidade
lifequerynumberfalsePeríodo de espera - minutos
epquerystringfalserede proxy

Valores enumerados

ParameterValue
epus
ephk
epde

Exemplos de resposta

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

Respostas

StatusSignificadoDescriçãoEsquema
200OKSolicitação bem-sucedidaInline

Esquema da resposta

Status Code 200

NomeTipoObrigatórioRestriçõesDescrição
» codeintegertruenenhumCódigo de status, 200 bem-sucedido, 3 app_key inválido, 156 conta não autenticada.
» msgstringtruenenhummensagem de estado
» dataobjectfalsenenhumnone
»» list[any]falsenenhumnone
Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth, apiKeyAuth

Lista de cidades (GET /end-point/ip/dynamic-area-city-list)

Exemplos de código

# Você também pode usar wget
curl -X GET https://api.proxylite.com/end-point/ip/dynamic-area-city-list \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/ip/dynamic-area-city-list

Exemplos de resposta

Resposta 200

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

Respostas

StatusSignificadoDescriçãoEsquema
200OKSolicitação bem-sucedidaInline

Esquema da resposta

Status Code 200

NomeTipoObrigatórioRestriçõesDescrição
» codeintegertruenenhumCódigo de status, 200 bem-sucedido, 3 app_key inválido, 156 conta não autenticada.
» msgstringtruenenhummensagem de estado
» dataobjectfalsenenhumnone
»» list[object]falsenenhumlista
»»» name_zh_cnstringfalsenenhumNome do país ou região
»»» name_enstringfalsenenhumNome do país ou região
»»» continent_codestringfalsenenhumcódigo do continente
»»» country_codestringfalsenenhumCódigo do país ou região
»»» items[any]falsenenhumprovíncia ou estado
»»»» citystringfalsenenhumnome da cidade
»»»» statestringfalsenenhumCódigo do nome da província ou estado
»»»» continent_codestringfalsenenhumcódigo do continente
»»»» country_codestringfalsenenhumCódigo do país ou região
Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth

Estatísticas de quantidade de extração de IP por dia

Exemplos de código

# Você também pode usar wget
curl -X GET https://api.proxylite.com/end-point/user-extract-ip/days \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/user-extract-ip/days

Parâmetros

NomeEmTipoObrigatórioDescrição
team_idqueryResourceSpaceIdfalsenenhum
start_datequerystring(date)falsePadrão há 6 dias
end_datequerystring(date)falsePadrão hoje
product_typequeryintegerfalsenenhum

Valores enumerados

ParameterValue
product_type9
product_type17
product_type22

Exemplos de resposta

Resposta 200

{
  "code": 0,
  "msg": "string",
  "request_id": "string",
  "data": {
    "list": [
      {
        "count": 0,
        "date": "2019-08-24"
      }
    ]
  }
}

Respostas

StatusSignificadoDescriçãoEsquema
200OKSolicitação bem-sucedidaInline

Esquema da resposta

Status Code 200

NomeTipoObrigatórioRestriçõesDescrição
» codeintegerfalsenenhumnone
» msgstringfalsenenhumnone
» request_idstringfalsenenhumnone
» dataobjectfalsenenhumnone
»» list[object]falsenenhumnone
»»» countintegertruenenhumnone
»»» datestring(date)truenenhumnone
Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth, apiKeyAuth

Extrair IP (GET /end-point/ip/v3)

Exemplos de código

# Você também pode usar wget
curl -X GET https://api.proxylite.com/end-point/ip/v3?app_key=pa%24%24word \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/ip/v3

Parâmetros

NomeEmTipoObrigatórioDescrição
team_idqueryResourceSpaceIdfalseA chave da equipe pode ser omitida; quando repassado, deve ser consistente com a equipe à qual a Chave está vinculada.
app_keyquerystring(password)truechave de acesso
ccquerystringfalsePaís ou região
statequerystringfalseprovíncia ou estado
cityquerystringfalsecidade
formatquerystringfalseObter formato
lbquerystringfalseSeparador, válido apenas em formato de texto
numquerynumberfalseExtrair quantidade
lifequerynumberfalsePeríodo de espera - minutos
epquerystringfalserede proxy

Valores enumerados

ParameterValue
epus
ephk
epde

Exemplos de resposta

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

Respostas

StatusSignificadoDescriçãoEsquema
200OKSolicitação bem-sucedidaInline

Esquema da resposta

Status Code 200

NomeTipoObrigatórioRestriçõesDescrição
» codeintegertruenenhumCódigo de status, 200 bem-sucedido, 3 app_key inválido, 156 conta não autenticada.
» msgstringtruenenhummensagem de estado
» dataobjectfalsenenhumnone
»» list[any]falsenenhumnone
Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth, apiKeyAuth

Lista dinâmica de cidades regionais V4

Exemplos de código

# Você também pode usar wget
curl -X GET https://api.proxylite.com/end-point/ip/dcl4?username=string \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/ip/dcl4

Obtenha a lista de cidades por nome de usuário, é necessária autenticação de login e a conta deve pertencer ao usuário atual

Parâmetros

NomeEmTipoObrigatórioDescrição
usernamequerystringtrueNome de usuário da conta do agente

Exemplos de resposta

Resposta 200

{
  "code": 200,
  "msg": "string",
  "data": {
    "cache": true,
    "list": [
      {
        "City": "Los Angeles",
        "Area": "US",
        "State": "California"
      }
    ]
  }
}

Respostas

StatusSignificadoDescriçãoEsquema
200OKSolicitação bem-sucedidaInline

Esquema da resposta

Status Code 200

NomeTipoObrigatórioRestriçõesDescrição
» codeintegerfalsenenhumCódigo de status, 200 sucessos
» msgstringfalsenenhummensagem de estado
» dataobjectfalsenenhumnone
»» cachebooleanfalsenenhumQuer venha do cache
»» list[object]falsenenhumnone
»»» Citystringfalsenenhumcidade
»»» Areastringfalsenenhumárea
»»» StatestringfalsenenhumEstado/Província
Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth, apiKeyAuth

Lista regional dinâmica de estados/províncias V4

Exemplos de código

# Você também pode usar wget
curl -X GET https://api.proxylite.com/end-point/ip/dsl4?username=string \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/ip/dsl4

Obtenha a lista de estados/províncias por nome de usuário, a autenticação de login é necessária e a conta deve pertencer ao usuário atual

Parâmetros

NomeEmTipoObrigatórioDescrição
usernamequerystringtrueNome de usuário da conta do agente

Exemplos de resposta

Resposta 200

{
  "code": 200,
  "msg": "string",
  "data": {
    "cache": true,
    "list": [
      {
        "City": "Los Angeles",
        "Area": "US",
        "State": "California"
      }
    ]
  }
}

Respostas

StatusSignificadoDescriçãoEsquema
200OKSolicitação bem-sucedidaInline

Esquema da resposta

Status Code 200

NomeTipoObrigatórioRestriçõesDescrição
» codeintegerfalsenenhumCódigo de status, 200 sucessos
» msgstringfalsenenhummensagem de estado
» dataobjectfalsenenhumnone
»» cachebooleanfalsenenhumQuer venha do cache
»» list[object]falsenenhumnone
»»» Citystringfalsenenhumcidade
»»» Areastringfalsenenhumárea
»»» StatestringfalsenenhumEstado/Província
Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth, apiKeyAuth

Lista dinâmica de fusão regional de estado/província de cidade V4

Exemplos de código

# Você também pode usar wget
curl -X GET https://api.proxylite.com/end-point/ip/dal4?username=string \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/ip/dal4

Obtenha uma lista mesclada de estados/províncias e cidades por nome de usuário, agrupados por região. A autenticação de login é necessária e a conta deve pertencer ao usuário atual

Parâmetros

NomeEmTipoObrigatórioDescrição
usernamequerystringtrueNome de usuário da conta do agente

Exemplos de resposta

Resposta 200

{
  "code": 200,
  "msg": "string",
  "data": {
    "cache": true,
    "list": [
      {
        "Area": "US",
        "states": [
          {
            "State": "California",
            "cities": [
              "Los Angeles"
            ]
          }
        ]
      }
    ]
  }
}

Respostas

StatusSignificadoDescriçãoEsquema
200OKSolicitação bem-sucedidaInline

Esquema da resposta

Status Code 200

NomeTipoObrigatórioRestriçõesDescrição
» codeintegerfalsenenhumCódigo de status, 200 sucessos
» msgstringfalsenenhummensagem de estado
» dataobjectfalsenenhumnone
»» cachebooleanfalsenenhumQuer venha do cache
»» list[object]falsenenhumLista de áreas
»»» Areastringfalsenenhumcódigo de área
»»» states[object]falsenenhumLista de estados/províncias
»»»» StatestringfalsenenhumNome do estado/província
»»»» cities[string]falsenenhumLista de cidades
Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth, apiKeyAuth

Lista de cidades (GET /end-point/ip/dynamic-citys)

Exemplos de código

# Você também pode usar wget
curl -X GET https://api.proxylite.com/end-point/ip/dynamic-citys \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/ip/dynamic-citys

Exemplos de resposta

Resposta 200

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

Respostas

StatusSignificadoDescriçãoEsquema
200OKSolicitação bem-sucedidaInline

Esquema da resposta

Status Code 200

NomeTipoObrigatórioRestriçõesDescrição
» codeintegertruenenhumCódigo de status, 200 bem-sucedido, 3 app_key inválido, 156 conta não autenticada.
» msgstringtruenenhummensagem de estado
» dataobjectfalsenenhumnone
»» list[object]falsenenhumlista
»»» name_zh_cnstringfalsenenhumNome do país ou região
»»» name_enstringfalsenenhumNome do país ou região
»»» continent_codestringfalsenenhumcódigo do continente
»»» country_codestringfalsenenhumCódigo do país ou região
»»» items[any]falsenenhumprovíncia ou estado
»»»» citystringfalsenenhumnome da cidade
»»»» statestringfalsenenhumCódigo do nome da província ou estado
»»»» continent_codestringfalsenenhumcódigo do continente
»»»» country_codestringfalsenenhumCódigo do país ou região
Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth

Pesquisa de cidade

Exemplos de código

# Você também pode usar wget
curl -X GET https://api.proxylite.com/end-point/ip/dynamic-citys/search?country_code=string&state=string \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

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

Parâmetros

NomeEmTipoObrigatórioDescrição
country_codequerystringtrueCódigo do país ou região
statequerystringtrueCódigo do estado ou província

Exemplos de resposta

Resposta 200

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

Respostas

StatusSignificadoDescriçãoEsquema
200OKSolicitação bem-sucedidaInline

Esquema da resposta

Status Code 200

NomeTipoObrigatórioRestriçõesDescrição
» codeintegertruenenhumCódigo de status, 200 bem-sucedido, 3 app_key inválido, 156 conta não autenticada.
» msgstringtruenenhummensagem de estado
» dataobjectfalsenenhumnone
»» list[string]falsenenhumlista
Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth

Lista de estados

Exemplos de código

# Você também pode usar wget
curl -X GET https://api.proxylite.com/end-point/ip/dynamic-states \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/ip/dynamic-states

Exemplos de resposta

Resposta 200

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

Respostas

StatusSignificadoDescriçãoEsquema
200OKSolicitação bem-sucedidaInline

Esquema da resposta

Status Code 200

NomeTipoObrigatórioRestriçõesDescrição
» codeintegertruenenhumCódigo de status, 200 bem-sucedido, 3 app_key inválido, 156 conta não autenticada.
» msgstringtruenenhummensagem de estado
» dataobjectfalsenenhumnone
»» list[object]falsenenhumlista
»»» name_zh_cnstringfalsenenhumNome do país ou região
»»» name_enstringfalsenenhumNome do país ou região
»»» continent_codestringfalsenenhumcódigo do continente
»»» country_codestringfalsenenhumCódigo do país ou região
»»» items[any]falsenenhumprovíncia ou estado
»»»» statestringfalsenenhumCódigo do nome da província ou estado
»»»» continent_codestringfalsenenhumcódigo do continente
»»»» country_codestringfalsenenhumCódigo do país ou região
Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth

Pesquisa de estado/província

Exemplos de código

# Você também pode usar wget
curl -X GET https://api.proxylite.com/end-point/ip/dynamic-states/search?country_code=string \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

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

Parâmetros

NomeEmTipoObrigatórioDescrição
country_codequerystringtrueCódigo do país ou região

Exemplos de resposta

Resposta 200

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

Respostas

StatusSignificadoDescriçãoEsquema
200OKSolicitação bem-sucedidaInline

Esquema da resposta

Status Code 200

NomeTipoObrigatórioRestriçõesDescrição
» codeintegertruenenhumCódigo de status, 200 bem-sucedido, 3 app_key inválido, 156 conta não autenticada.
» msgstringtruenenhummensagem de estado
» dataobjectfalsenenhumnone
»» list[string]falsenenhumlista
Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth

Obtenha uma lista de IPs estáticos atribuídos ao datacenter

Exemplos de código

# Você também pode usar wget
curl -X POST https://api.proxylite.com/end-point/ip/get-datacenter-assign-ip-list \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/ip/get-datacenter-assign-ip-list

Obsoleto, é recomendado usar /openapi/user-product/datacenter-isp-ip-list. Para ser compatível com clientes antigos, esta interface utiliza o método POST, mas os parâmetros de filtragem são todos lidos na consulta.

Parâmetros

NomeEmTipoObrigatórioDescrição
team_idqueryResourceSpaceIdfalseIdentificador de espaço de recursos; omita o espaço pessoal ou passe uma string vazia; A chave da equipe pode ser omitida e deve ser consistente com a chave quando passada
areaquerystringfalseCódigo do país
statusqueryintegerfalse0=todos, 1=válido, 2=expirado
trade_noquerystringfalseNúmero do pedido
created_atqueryarray[string]falsePara criar um intervalo de tempo, o horário de início e de término deve ser passado ao mesmo tempo.

Valores enumerados

ParameterValue
status0
status1
status2

Exemplos de resposta

Resposta 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "total": 0,
    "list": [
      {
        "id": 1,
        "ip": "string",
        "country_code": "string",
        "up_id": 1,
        "expired_at": "string",
        "created_at": "string",
        "country_name_zh_cn": "string",
        "country_name_en": "string",
        "country_continent_code": "string",
        "port": 1
      }
    ]
  },
  "request_id": "string"
}

Respostas

StatusSignificadoDescriçãoEsquema
200OKSolicitação bem-sucedidaInline

Esquema da resposta

Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth, apiKeyAuth

Extraia a lista de IPs estáticos adquiridos

Exemplos de código

# Você também pode usar wget
curl -X GET https://api.proxylite.com/end-point/ip/get-static-ip \
  -H 'Authorization: Bearer {access-token}'

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

Parâmetros

NomeEmTipoObrigatórioDescrição
country_codequerystringfalseCódigo do país ou região
product_typequerynumberfalseTipo de produto, 25: IP residencial estático, 14: IP de data center
trade_noquerystringfalseFiltrar IP por número de pedido
pagequerynumberfalseNúmero da página
sizequerynumberfalseQuantidade por página
statusquerynumberfalseStatus, 1: válido, 2: inválido, 3: prestes a expirar, 4: em manutenção

Valores enumerados

ParameterValue
product_type14
product_type25
status1 - 2 - 3 - 4

Respostas

StatusSignificadoDescriçãoEsquema
Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth, apiKeyAuth

Obtenha o número de IPs estáticos à venda na região

Exemplos de código

# Você também pode usar wget
curl -X GET https://api.proxylite.com/end-point/ip/static-ip-region \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/ip/static-ip-region

Parâmetros

NomeEmTipoObrigatórioDescrição
ispqueryintegerfalseFiltragem ISP, sem filtragem se não for transmitido (o padrão é 1, exceto site 1/4/5)
asnqueryintegerfalseSe deve retornar dados de pacotes ASN
exclusivequeryintegerfalseSe deve contar de acordo com o inventário exclusivo

Detailed descriptions

isp: Filtragem ISP, sem filtragem se não for transmitido (o padrão é 1, exceto site 1/4/5)

valordescrição
0IP estático do data center (IDC)
1IP estático inicial (ISP)

asn: Se deve retornar dados de pacotes ASN

valordescrição
0Não retornar dados de pacotes ASN (padrão)
1Retornar dados do pacote ASN

exclusive: Se deve contar de acordo com o inventário exclusivo

valordescrição
0Estatísticas baseadas no calibre atual do usuário/grupo de compartilhamento (padrão)
1Exclua todos os IPs atribuídos e conte apenas o inventário disponível

Valores enumerados

ParameterValue
isp0
isp1
asn0
asn1
exclusive0
exclusive1

Exemplos de resposta

Resposta 200

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

Respostas

StatusSignificadoDescriçãoEsquema
200OKSolicitação bem-sucedidaInline

Esquema da resposta

Status Code 200

NomeTipoObrigatórioRestriçõesDescrição
» codeintegertruenenhumCódigo de status, 200 sucessos
» msgstringtruenenhummensagem de estado
» dataobjectfalsenenhumnone
»» list[any]falsenenhumnone
»»» codestringtruenenhumCódigo do país ou região
»»» numberintegertruenenhumQuantidade
Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth

Obtenha países/regiões com suporte de host_pool

Exemplos de código

# Você também pode usar wget
curl -X GET https://api.proxylite.com/end-point/host-pool/regions \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/host-pool/regions

Consulte a lista de países/regiões suportados pelo site atual do serviço host_pool.

Esta interface é orientada para o cenário de extração aleatória de IP do data center com base em pontos de tráfego e conta apenas países/regiões com base no inventário de IP do data center disponível no site atual.

Exemplos de resposta

Resposta 200

{
  "code": 200,
  "msg": "请求成功",
  "data": {
    "list": [
      {
        "code": "US",
        "number": 55,
        "name_zh_cn": "美国",
        "name_en": "United States",
        "square_flag": "https://example.com/static/flags/us.png"
      }
    ]
  }
}

Respostas

StatusSignificadoDescriçãoEsquema
200OKSolicitação bem-sucedidaInline

Esquema da resposta

Status Code 200

NomeTipoObrigatórioRestriçõesDescrição
» codeintegertruenenhumCódigo de status, 200 sucessos
» msgstringtruenenhummensagem de estado
» dataobjectfalsenenhumnone
»» list[object]falsenenhumnone
»»» codestringtruenenhumCódigo do país ou região, ISO 3166-1 alfa-2
»»» numberintegertruenenhumNúmero de IPs de data center disponíveis no site atual
»»» name_zh_cnstringfalsenenhumNome chinês do país ou região
»»» name_enstringfalsenenhumNome inglês do país ou região
»»» square_flagstringfalsenenhumURL da imagem da bandeira quadrada
Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth

Lista de permissões de IP

Lista de permissões de IP (GET /end-point/proxy-ip/list)

Exemplos de código

# Você também pode usar wget
curl -X GET https://api.proxylite.com/end-point/proxy-ip/list \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/proxy-ip/list

Parâmetros

NomeEmTipoObrigatórioDescrição
team_idqueryResourceSpaceIdfalseIdentificador de espaço de recursos; espaço pessoal omite ou passa uma string vazia
product_typequeryintegerfalseNúmero do tipo de pacote

Exemplos de resposta

Resposta 200

{
  "code": 200,
  "msg": "string",
  "data": {
    "list": [
      {
        "ip": "1.1.1.1",
        "remark": "string",
        "product_type": 0,
        "created_at": "string"
      }
    ]
  }
}

Respostas

StatusSignificadoDescriçãoEsquema
200OKSolicitação bem-sucedidaInline

Esquema da resposta

Status Code 200

NomeTipoObrigatórioRestriçõesDescrição
» codeintegerfalsenenhumCódigo de status, 200 sucessos
» msgstringfalsenenhummensagem de estado
» dataobjectfalsenenhumnone
»» list[object]falsenenhumnone
»»» ipstringfalsenenhumIP da lista de permissões
»»» remarkstringfalsenenhumObservações
»»» product_typeintegerfalsenenhumTipo de pacote
»»» created_atstringfalsenenhumhora de criação
Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth, apiKeyAuth

Adicionar lista de permissões de IP (POST /end-point/proxy-ip/add)

Exemplos de código

# Você também pode usar wget
curl -X POST https://api.proxylite.com/end-point/proxy-ip/add \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/proxy-ip/add

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "app_key": "string",
  "ips": "1.1.1.1,2.2.2.2",
  "remark": "string",
  "product_type": 0,
  "user_product_id": 0
}

Parâmetros

NomeEmTipoObrigatórioDescrição
bodybodyobjectfalsenenhum
» team_idbodyanyfalseIdentificação do espaço de recursos públicos; omita team_id ou passe uma string vazia ao solicitar um espaço pessoal e uma string vazia ao responder a um espaço pessoal; tanto o número 0 quanto a string "0" são ilegais, e o espaço da equipe usa uma identificação pública da equipe de 6 a 12 dígitos
»» anonymousbodystringfalsenenhum
»» anonymousbodyTeamPublicIdfalseLogotipo público da equipe, o primeiro caractere é uma letra ASCII e os demais caracteres contêm apenas letras e números ASCII; a chave primária numérica do banco de dados não foi emitida
» app_keybodystringfalseChave de autorização
» ipsbodystringtrueColoque IPs na lista de permissões que precisam ser adicionados, separe vários deles com vírgulas ou novas linhas.
» remarkbodystringfalseObservações
» product_typebodyintegerfalseNúmero do tipo de pacote
» user_product_idbodyintegerfalseID do pacote do usuário, obrigatório quando o tipo de pacote é 11

Exemplos de resposta

Resposta 200

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

Respostas

StatusSignificadoDescriçãoEsquema
200OKSolicitação bem-sucedidaInline

Esquema da resposta

Status Code 200

NomeTipoObrigatórioRestriçõesDescrição
» codeintegerfalsenenhumCódigo de status, 200 sucessos
» msgstringfalsenenhummensagem de estado
» datanullfalsenenhumnone
Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth, apiKeyAuth

Excluir lista de permissões de IP (POST /end-point/proxy-ip/delete)

Exemplos de código

# Você também pode usar wget
curl -X POST https://api.proxylite.com/end-point/proxy-ip/delete \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/proxy-ip/delete

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "app_key": "string",
  "ips": "1.1.1.1,2.2.2.2",
  "verify_type": "string",
  "verify_code": "string"
}

Parâmetros

NomeEmTipoObrigatórioDescrição
bodybodyobjectfalsenenhum
» team_idbodyanyfalseIdentificação do espaço de recursos públicos; omita team_id ou passe uma string vazia ao solicitar um espaço pessoal e uma string vazia ao responder a um espaço pessoal; tanto o número 0 quanto a string "0" são ilegais, e o espaço da equipe usa uma identificação pública da equipe de 6 a 12 dígitos
»» anonymousbodystringfalsenenhum
»» anonymousbodyTeamPublicIdfalseLogotipo público da equipe, o primeiro caractere é uma letra ASCII e os demais caracteres contêm apenas letras e números ASCII; a chave primária numérica do banco de dados não foi emitida
» app_keybodystringfalseChave de autorização
» ipsbodystringtrueLista de permissões de IPs que precisam ser excluídos, vários separados por vírgulas
» verify_typebodystringfalseTipo de verificação: telefone, email, wechat, totp
» verify_codebodystringfalseCódigo de verificação

Exemplos de resposta

Resposta 200

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

Respostas

StatusSignificadoDescriçãoEsquema
200OKSolicitação bem-sucedidaInline

Esquema da resposta

Status Code 200

NomeTipoObrigatórioRestriçõesDescrição
» codeintegerfalsenenhumCódigo de status, 200 sucessos
» msgstringfalsenenhummensagem de estado
» datanullfalsenenhumnone
Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth, apiKeyAuth

Lista de permissões de IP (GET /end-point/white-ip/list)

Exemplos de código

# Você também pode usar wget
curl -X GET https://api.proxylite.com/end-point/white-ip/list \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/white-ip/list

Parâmetros

NomeEmTipoObrigatórioDescrição
team_idqueryResourceSpaceIdfalseIdentificador de espaço de recursos; espaço pessoal omite ou passa uma string vazia
product_typequeryintegerfalseNúmero do tipo de pacote

Exemplos de resposta

Resposta 200

{
  "code": 200,
  "msg": "string",
  "data": {
    "list": [
      {
        "ip": "1.1.1.1",
        "remark": "string",
        "product_type": 0,
        "created_at": "string"
      }
    ]
  }
}

Respostas

StatusSignificadoDescriçãoEsquema
200OKSolicitação bem-sucedidaInline

Esquema da resposta

Status Code 200

NomeTipoObrigatórioRestriçõesDescrição
» codeintegerfalsenenhumCódigo de status, 200 sucessos
» msgstringfalsenenhummensagem de estado
» dataobjectfalsenenhumnone
»» list[object]falsenenhumnone
»»» ipstringfalsenenhumIP da lista de permissões
»»» remarkstringfalsenenhumObservações
»»» product_typeintegerfalsenenhumTipo de pacote
»»» created_atstringfalsenenhumhora de criação
Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth, apiKeyAuth

Adicionar lista de permissões de IP (POST /end-point/white-ip/add)

Exemplos de código

# Você também pode usar wget
curl -X POST https://api.proxylite.com/end-point/white-ip/add \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/white-ip/add

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "app_key": "string",
  "ips": "1.1.1.1,2.2.2.2",
  "remark": "string",
  "product_type": 0,
  "user_product_id": 0
}

Parâmetros

NomeEmTipoObrigatórioDescrição
bodybodyobjectfalsenenhum
» team_idbodyanyfalseIdentificação do espaço de recursos públicos; omita team_id ou passe uma string vazia ao solicitar um espaço pessoal e uma string vazia ao responder a um espaço pessoal; tanto o número 0 quanto a string "0" são ilegais, e o espaço da equipe usa uma identificação pública da equipe de 6 a 12 dígitos
»» anonymousbodystringfalsenenhum
»» anonymousbodyTeamPublicIdfalseLogotipo público da equipe, o primeiro caractere é uma letra ASCII e os demais caracteres contêm apenas letras e números ASCII; a chave primária numérica do banco de dados não foi emitida
» app_keybodystringfalseChave de autorização
» ipsbodystringtrueColoque IPs na lista de permissões que precisam ser adicionados, separe vários deles com vírgulas ou novas linhas.
» remarkbodystringfalseObservações
» product_typebodyintegerfalseNúmero do tipo de pacote
» user_product_idbodyintegerfalseID do pacote do usuário, obrigatório quando o tipo de pacote é 11

Exemplos de resposta

Resposta 200

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

Respostas

StatusSignificadoDescriçãoEsquema
200OKSolicitação bem-sucedidaInline

Esquema da resposta

Status Code 200

NomeTipoObrigatórioRestriçõesDescrição
» codeintegerfalsenenhumCódigo de status, 200 sucessos
» msgstringfalsenenhummensagem de estado
» datanullfalsenenhumnone
Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth, apiKeyAuth

Excluir lista de permissões de IP (POST /end-point/white-ip/delete)

Exemplos de código

# Você também pode usar wget
curl -X POST https://api.proxylite.com/end-point/white-ip/delete \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/white-ip/delete

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "app_key": "string",
  "ips": "1.1.1.1,2.2.2.2",
  "verify_type": "string",
  "verify_code": "string"
}

Parâmetros

NomeEmTipoObrigatórioDescrição
bodybodyobjectfalsenenhum
» team_idbodyanyfalseIdentificação do espaço de recursos públicos; omita team_id ou passe uma string vazia ao solicitar um espaço pessoal e uma string vazia ao responder a um espaço pessoal; tanto o número 0 quanto a string "0" são ilegais, e o espaço da equipe usa uma identificação pública da equipe de 6 a 12 dígitos
»» anonymousbodystringfalsenenhum
»» anonymousbodyTeamPublicIdfalseLogotipo público da equipe, o primeiro caractere é uma letra ASCII e os demais caracteres contêm apenas letras e números ASCII; a chave primária numérica do banco de dados não foi emitida
» app_keybodystringfalseChave de autorização
» ipsbodystringtrueLista de permissões de IPs que precisam ser excluídos, vários separados por vírgulas
» verify_typebodystringfalseTipo de verificação: telefone, email, wechat, totp
» verify_codebodystringfalseCódigo de verificação

Exemplos de resposta

Resposta 200

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

Respostas

StatusSignificadoDescriçãoEsquema
200OKSolicitação bem-sucedidaInline

Esquema da resposta

Status Code 200

NomeTipoObrigatórioRestriçõesDescrição
» codeintegerfalsenenhumCódigo de status, 200 sucessos
» msgstringfalsenenhummensagem de estado
» datanullfalsenenhumnone
Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth, apiKeyAuth

Modificar comentários da lista de permissões de IP

Exemplos de código

# Você também pode usar wget
curl -X POST https://api.proxylite.com/end-point/white-ip/change-remark \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/white-ip/change-remark

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "ip": "192.168.0.1",
  "remark": "string"
}

Parâmetros

NomeEmTipoObrigatórioDescrição
bodybodyobjecttruenenhum
» team_idbodyanyfalseIdentificação do espaço de recursos públicos; omita team_id ou passe uma string vazia ao solicitar um espaço pessoal e uma string vazia ao responder a um espaço pessoal; tanto o número 0 quanto a string "0" são ilegais, e o espaço da equipe usa uma identificação pública da equipe de 6 a 12 dígitos
»» anonymousbodystringfalsenenhum
»» anonymousbodyTeamPublicIdfalseLogotipo público da equipe, o primeiro caractere é uma letra ASCII e os demais caracteres contêm apenas letras e números ASCII; a chave primária numérica do banco de dados não foi emitida
» ipbodystring(ipv4)truenenhum
» remarkbodystringtruenenhum

Exemplos de resposta

Resposta 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Respostas

StatusSignificadoDescriçãoEsquema
200OKOperação bem-sucedidaWebV1SuccessResponse
Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth, apiKeyAuth

Atualizar o cache de autenticação da lista de permissões de IP do espaço de recursos atual

Exemplos de código

# Você também pode usar wget
curl -X POST https://api.proxylite.com/end-point/white-ip/refresh \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/white-ip/refresh

Body parameter

{
  "team_id": "A1b2C3d4E5f6"
}

Parâmetros

NomeEmTipoObrigatórioDescrição
bodybodyobjectfalsenenhum
» team_idbodyanyfalseIdentificação do espaço de recursos públicos; omita team_id ou passe uma string vazia ao solicitar um espaço pessoal e uma string vazia ao responder a um espaço pessoal; tanto o número 0 quanto a string "0" são ilegais, e o espaço da equipe usa uma identificação pública da equipe de 6 a 12 dígitos
»» anonymousbodystringfalsenenhum
»» anonymousbodyTeamPublicIdfalseLogotipo público da equipe, o primeiro caractere é uma letra ASCII e os demais caracteres contêm apenas letras e números ASCII; a chave primária numérica do banco de dados não foi emitida

Exemplos de resposta

Resposta 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Respostas

StatusSignificadoDescriçãoEsquema
200OKOperação bem-sucedidaWebV1SuccessResponse
Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth, apiKeyAuth

Cota da lista de permissões de IP para tipos de produtos especificados

Exemplos de código

# Você também pode usar wget
curl -X GET https://api.proxylite.com/end-point/white-ip/quota?product_type=0 \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/white-ip/quota

Parâmetros

NomeEmTipoObrigatórioDescrição
team_idqueryResourceSpaceIdfalsenenhum
product_typequeryintegertruenenhum

Exemplos de resposta

Resposta 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Respostas

StatusSignificadoDescriçãoEsquema
200OKOperação bem-sucedidaWebV1SuccessResponse
Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth, apiKeyAuth

Cotas de lista de permissões de IP para todos os tipos de produtos

Exemplos de código

# Você também pode usar wget
curl -X GET https://api.proxylite.com/end-point/white-ip/quotas \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/white-ip/quotas

Parâmetros

NomeEmTipoObrigatórioDescrição
team_idqueryResourceSpaceIdfalsenenhum

Exemplos de resposta

Resposta 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Respostas

StatusSignificadoDescriçãoEsquema
200OKOperação bem-sucedidaWebV1SuccessResponse
Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth, apiKeyAuth

Consulta de registro de tráfego

O tráfego usado recentemente é resumido por dia

Exemplos de código

# Você também pode usar wget
curl -X POST https://api.proxylite.com/end-point/user-usage-flow/days \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/user-usage-flow/days

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "days": 7,
  "product_type": 0,
  "username": "string"
}

Parâmetros

NomeEmTipoObrigatórioDescrição
bodybodyobjectfalsenenhum
» team_idbodyanyfalseIdentificação do espaço de recursos públicos; omita team_id ou passe uma string vazia ao solicitar um espaço pessoal e uma string vazia ao responder a um espaço pessoal; tanto o número 0 quanto a string "0" são ilegais, e o espaço da equipe usa uma identificação pública da equipe de 6 a 12 dígitos
»» anonymousbodystringfalsenenhum
»» anonymousbodyTeamPublicIdfalseLogotipo público da equipe, o primeiro caractere é uma letra ASCII e os demais caracteres contêm apenas letras e números ASCII; a chave primária numérica do banco de dados não foi emitida
» daysbodyintegerfalsenenhum
» product_typebodyintegerfalsenenhum
» usernamebodystringfalsenenhum

Exemplos de resposta

Resposta 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "days": "2019-08-24",
        "flow": 0
      }
    ],
    "days": 1
  },
  "request_id": "string"
}

Respostas

StatusSignificadoDescriçãoEsquema
200OKSolicitação bem-sucedidaInline

Esquema da resposta

Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth, apiKeyAuth

Uso histórico de tráfego da conta do agente

Exemplos de código

# Você também pode usar wget
curl -X POST https://api.proxylite.com/end-point/user-usage-flow/username-total \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/user-usage-flow/username-total

Body parameter

{
  "team_id": "A1b2C3d4E5f6"
}

Parâmetros

NomeEmTipoObrigatórioDescrição
bodybodyobjectfalsenenhum
» team_idbodyanyfalseIdentificação do espaço de recursos públicos; omita team_id ou passe uma string vazia ao solicitar um espaço pessoal e uma string vazia ao responder a um espaço pessoal; tanto o número 0 quanto a string "0" são ilegais, e o espaço da equipe usa uma identificação pública da equipe de 6 a 12 dígitos
»» anonymousbodystringfalsenenhum
»» anonymousbodyTeamPublicIdfalseLogotipo público da equipe, o primeiro caractere é uma letra ASCII e os demais caracteres contêm apenas letras e números ASCII; a chave primária numérica do banco de dados não foi emitida

Exemplos de resposta

Resposta 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "username": "string",
        "flow": 0
      }
    ]
  },
  "request_id": "string"
}

Respostas

StatusSignificadoDescriçãoEsquema
200OKSolicitação bem-sucedidaInline

Esquema da resposta

Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth, apiKeyAuth

Exporte o uso mensal do tráfego da conta da agência

Exemplos de código

# Você também pode usar wget
curl -X POST https://api.proxylite.com/end-point/user-usage-flow/export-csv \
  -H 'Content-Type: application/json' \
  -H 'Accept: text/csv' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/user-usage-flow/export-csv

Body parameter

{
  "team_id": "A1b2C3d4E5f6"
}

Parâmetros

NomeEmTipoObrigatórioDescrição
bodybodyobjectfalsenenhum
» team_idbodyanyfalseIdentificação do espaço de recursos públicos; omita team_id ou passe uma string vazia ao solicitar um espaço pessoal e uma string vazia ao responder a um espaço pessoal; tanto o número 0 quanto a string "0" são ilegais, e o espaço da equipe usa uma identificação pública da equipe de 6 a 12 dígitos
»» anonymousbodystringfalsenenhum
»» anonymousbodyTeamPublicIdfalseLogotipo público da equipe, o primeiro caractere é uma letra ASCII e os demais caracteres contêm apenas letras e números ASCII; a chave primária numérica do banco de dados não foi emitida

Exemplos de resposta

Resposta 200

Respostas

StatusSignificadoDescriçãoEsquema
200OKArquivo CSV codificado em GBKstring
Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth, apiKeyAuth

Quantidade total e quantidade restante de tráfego de pacotes

Exemplos de código

# Você também pode usar wget
curl -X GET https://api.proxylite.com/end-point/user-usage-flow/flow-total \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

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

Parâmetros

NomeEmTipoObrigatórioDescrição
team_idqueryResourceSpaceIdfalsenenhum
unitquerystringfalsenenhum

Valores enumerados

ParameterValue
unitKB
unitMB
unitGB
unitTB
unitPB

Exemplos de resposta

Resposta 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "limit": 0,
    "total": 0,
    "remain": 0,
    "unit": "KB",
    "timestamp": 0
  },
  "request_id": "string"
}

Respostas

StatusSignificadoDescriçãoEsquema
200OKSolicitação bem-sucedidaInline

Esquema da resposta

Valores enumerados

PropriedadeValor
unitKB
unitMB
unitGB
unitTB
unitPB
Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth, apiKeyAuth

gráfico de taxa diária

Exemplos de código

# Você também pode usar wget
curl -X GET https://api.proxylite.com/end-point/user-usage-flow/rate-graph \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/user-usage-flow/rate-graph

Parâmetros

NomeEmTipoObrigatórioDescrição
team_idqueryResourceSpaceIdfalsenenhum
startquerystring(date)falsenenhum
endquerystring(date)falsenenhum
usernamequerystringfalsenenhum
user_product_idqueryintegerfalsenenhum

Exemplos de resposta

Resposta 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "date": "2019-08-24",
        "rate": 0,
        "corrent": 0
      }
    ]
  },
  "request_id": "string"
}

Respostas

StatusSignificadoDescriçãoEsquema
200OKSolicitação bem-sucedidaInline

Esquema da resposta

Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth, apiKeyAuth

Estatísticas diárias de tráfego de cache

Exemplos de código

# Você também pode usar wget
curl -X GET https://api.proxylite.com/end-point/user-usage-flow/cache-total \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

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

Parâmetros

NomeEmTipoObrigatórioDescrição
team_idqueryResourceSpaceIdfalsenenhum
start_timequerystringfalsenenhum
end_timequerystringfalsenenhum
product_typequeryintegerfalsenenhum
usernamequerystringfalsenenhum

Exemplos de resposta

Resposta 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "day": "2019-08-24",
        "cache_flow": 0,
        "cache_reduce_flow": 0
      }
    ]
  },
  "request_id": "string"
}

Respostas

StatusSignificadoDescriçãoEsquema
200OKSolicitação bem-sucedidaInline

Esquema da resposta

Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth, apiKeyAuth

O uso do tráfego é resumido por dia

Exemplos de código

# Você também pode usar wget
curl -X GET https://api.proxylite.com/end-point/user-usage-flow/total?app_key=pa%24%24word \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

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

Parâmetros

NomeEmTipoObrigatórioDescrição
team_idqueryResourceSpaceIdfalseIdentificador de espaço de recursos; espaço pessoal omite ou passa uma string vazia
app_keyquerystring(password)trueChave de autenticação
start_timequerystring(Y-m-d H:i:s)falseHora de início, com precisão de segundos. Observe que o registro é atrasado em 5 minutos. O padrão é dentro de 7 dias.
end_timequerystring(Y-m-d H:i:s)falsePrazo, com precisão de segundos. Observe que o registro é atrasado em 5 minutos. Hora atual padrão.
usernamequerystringfalseNome da subconta, consulte todas as contas por padrão, a subconta pode ser especificada. Observe que se você adicionar uma subconta com o mesmo nome, esta consulta retornará todos os registros de uso da conta do agente com o mesmo nome.
product_typequerynumberfalseTipo de pacote

Exemplos de resposta

Resposta 200

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

Respostas

StatusSignificadoDescriçãoEsquema
200OKSolicitação bem-sucedidaInline

Esquema da resposta

Status Code 200

NomeTipoObrigatórioRestriçõesDescrição
» codeintegertruenenhumCódigo de status, 200 bem-sucedido, 3 app_key inválido, 156 conta não autenticada.
» msgstringtruenenhummensagem de estado
» dataobjectfalsenenhumnone
»» list[object]falsenenhumnone
»»» daystringfalsenenhumData
»»» flowintegerfalsenenhumTráfego de consumo, unidade KB
Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth, apiKeyAuth

Registro do agente

Estatísticas de acesso ao proxy IP do cliente

Exemplos de código

# Você também pode usar wget
curl -X GET https://api.proxylite.com/end-point/http-t-dom/list-v2 \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/http-t-dom/list-v2

Parâmetros

NomeEmTipoObrigatórioDescrição
team_idqueryResourceSpaceIdfalsenenhum
start_timequerystring(date)falsenenhum
end_timequerystring(date)falsenenhum
exportquerystringfalsenenhum

Valores enumerados

ParameterValue
exportcsv

Exemplos de resposta

Resposta 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "visit_count": 0,
        "client_ip": "string",
        "time": "2019-08-24",
        "country_code": "string",
        "country": "string"
      }
    ],
    "cache": true,
    "ttl": 0
  },
  "request_id": "string"
}

Respostas

StatusSignificadoDescriçãoEsquema
200OKResultados estatísticos JSON; O arquivo CSV é retornado quando export=csvstring
Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth, apiKeyAuth

Proporção de visitas de IP do cliente

Exemplos de código

# Você também pode usar wget
curl -X GET https://api.proxylite.com/end-point/http-t-dom/client-ip-proportion \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/http-t-dom/client-ip-proportion

Parâmetros

NomeEmTipoObrigatórioDescrição
team_idqueryResourceSpaceIdfalsenenhum
start_timequerystring(date)falsenenhum
end_timequerystring(date)falsenenhum
exportquerystringfalsenenhum

Valores enumerados

ParameterValue
exportcsv

Exemplos de resposta

Resposta 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "username": "string",
        "client_ip": "string",
        "visit_count": 0,
        "visit_percentage": "string",
        "country": "string",
        "country_code": "string"
      }
    ],
    "cache": true,
    "ttl": 0
  },
  "request_id": "string"
}

Respostas

StatusSignificadoDescriçãoEsquema
200OKResultado da proporção JSON; O arquivo CSV é retornado quando export=csvstring
Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth, apiKeyAuth

Consulta de pacote

Lista de pacotes adquiridos

Exemplos de código

# Você também pode usar wget
curl -X GET https://api.proxylite.com/end-point/user-product/list?app_key=pa%24%24word \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/user-product/list

Parâmetros

NomeEmTipoObrigatórioDescrição
team_idqueryResourceSpaceIdfalseIdentificador de espaço de recursos; espaço pessoal omite ou passa uma string vazia
app_keyquerystring(password)trueChave de autenticação
trade_noquerystringfalseNúmero do pedido, insira o número completo do pedido. A pesquisa difusa não é suportada.
pagequerynumberfalsePaginação, padrão: 1
sizequerynumberfalseNúmero de páginas exibidas, padrão: 20
product_typequerynumberfalseTipo de pacote

Exemplos de resposta

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
  }
}

Respostas

StatusSignificadoDescriçãoEsquema
200OKSolicitação bem-sucedidaInline

Esquema da resposta

Status Code 200

NomeTipoObrigatórioRestriçõesDescrição
» codeintegertruenenhumCódigo de status, 200 bem-sucedido, 3 app_key inválido, 156 conta não autenticada.
» msgstringtruenenhummensagem de estado
» dataobjectfalsenenhumnone
»» list[object]falsenenhumnone
»»» idintegerfalsenenhumNúmero do pacote
»»» created_atstringfalsenenhumTempo efetivo do pacote
»»» expired_atstringfalsenenhumO prazo de validade do pacote. Após a expiração, o tráfego não poderá ser usado.
»»» product_typeproductTypesfalsenenhumTipo de pacote, 9 pacotes de tráfego residencial dinâmico, 11 IP residencial dinâmico, 14 IP de data center estático, 25 IP residencial estático
»»» trade_nostringfalsenenhumNúmero da transação do pedido
»»» orderobjectfalsenenhumnone
»»»» created_atstringfalsenenhumHora de criação do pedido
»»»» pay_atstringfalsenenhumPrazo de pagamento do pedido
»»»» titlestringfalsenenhumDescrição do pedido
»» pageintegertruenenhumPágina atual
»» page_sizeintegerfalsenenhumtamanho da paginação
»» total_countintegerfalsenenhumNúmero total de registros
»» total_pageintegerfalsenenhumNúmero total de páginas

Valores enumerados

PropriedadeValor
product_type9
product_type11
product_type14
product_type25
Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth, apiKeyAuth

Resumo dos dados do pacote do usuário

Exemplos de código

# Você também pode usar wget
curl -X GET https://api.proxylite.com/end-point/user-product/summary?app_key=pa%24%24word \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/user-product/summary

Obtenha informações estatísticas resumidas dos pacotes do usuário, incluindo valor total, valor efetivo, valor futuro, valor expirado, etc.

Parâmetros

NomeEmTipoObrigatórioDescrição
team_idqueryResourceSpaceIdfalseIdentificador de espaço de recursos; espaço pessoal omite ou passa uma string vazia
app_keyquerystring(password)trueChave de autenticação
product_typequeryintegerfalseTipo de produto, suporta apenas 9 (pacote de tráfego dinâmico), 12 (pacote de tráfego IDC de longo prazo)

Valores enumerados

ParameterValue
product_type9
product_type12

Exemplos de resposta

Resposta 200

{
  "code": 200,
  "msg": "成功",
  "data": {
    "total": 1048576,
    "total_count": 5,
    "effective": 524288,
    "effective_count": 3,
    "effective_total": 786432,
    "effective_used": 262144,
    "temporary": 102400,
    "temporary_count": 1,
    "expired": 51200,
    "expired_count": 1,
    "used": 473088
  }
}

Respostas

StatusSignificadoDescriçãoEsquema
200OKSolicitação bem-sucedidaInline

Esquema da resposta

Status Code 200

NomeTipoObrigatórioRestriçõesDescrição
» codeintegerfalsenenhumCódigo de status, 200 bem-sucedido, 3 app_key inválido, 156 conta não autenticada.
» msgstringfalsenenhummensagem de estado
» dataobjectfalsenenhumnone
»» totalintegerfalsenenhumTráfego/volume total de IP (unidade: KB)
»» total_countintegerfalsenenhumNúmero total de pacotes
»» effectiveintegerfalsenenhumValor restante efetivo (unidade: KB)
»» effective_countintegerfalsenenhumNúmero de pacotes válidos
»» effective_totalintegerfalsenenhumValor total efetivo (unidade: KB)
»» effective_usedintegerfalsenenhumQuantidade efetiva utilizada (unidade: KB)
»» temporaryintegerfalsenenhumValor total devido (vencimento em até 7 dias, unidade: KB)
»» temporary_countintegerfalsenenhumNúmero de pacotes vencidos (validade em 7 dias)
»» expiredintegerfalsenenhumQuantidade restante expirada (unidade: KB)
»» expired_countintegerfalsenenhumNúmero de pacotes expirados
»» usedintegerfalsenenhumQuantidade total usada (unidade: KB)
Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth, apiKeyAuth

Lista de IP estático

Exemplos de código

# Você também pode usar wget
curl -X POST https://api.proxylite.com/end-point/user-product/datacenter-isp-ip-list \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/user-product/datacenter-isp-ip-list

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "status": 0,
  "page": 1,
  "size": 20,
  "user_product_id": 1,
  "country_code": "string",
  "product_type": 0,
  "ip": "192.168.0.1",
  "auto_renewal": 0,
  "support_renewal": 0,
  "remaining_days": 0,
  "limit_days": 0,
  "sort": "exp_asc",
  "remark": "string"
}

Parâmetros

NomeEmTipoObrigatórioDescrição
bodybodyobjectfalsenenhum
» team_idbodyanyfalseIdentificação do espaço de recursos públicos; omita team_id ou passe uma string vazia ao solicitar um espaço pessoal e uma string vazia ao responder a um espaço pessoal; tanto o número 0 quanto a string "0" são ilegais, e o espaço da equipe usa uma identificação pública da equipe de 6 a 12 dígitos
»» anonymousbodystringfalsenenhum
»» anonymousbodyTeamPublicIdfalseLogotipo público da equipe, o primeiro caractere é uma letra ASCII e os demais caracteres contêm apenas letras e números ASCII; a chave primária numérica do banco de dados não foi emitida
» statusbodyintegerfalsenenhum
» pagebodyintegerfalsenenhum
» sizebodyintegerfalsenenhum
» user_product_idbodyintegerfalsenenhum
» country_codebodystringfalsenenhum
» product_typebodyintegerfalsenenhum
» ipbodystring(ipv4)falsenenhum
» auto_renewalbodyintegerfalsenenhum
» support_renewalbodyintegerfalsenenhum
» remaining_daysbodyintegerfalsenenhum
» limit_daysbodyintegerfalsenenhum
» sortbodystringfalsenenhum
» remarkbodystringfalsenenhum

Valores enumerados

ParameterValue
» auto_renewal0
» auto_renewal1
» support_renewal0
» support_renewal1
» sortexp_asc
» sortexp_desc

Exemplos de resposta

Resposta 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Respostas

StatusSignificadoDescriçãoEsquema
200OKOperação bem-sucedidaWebV1SuccessResponse
Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth, apiKeyAuth

Excluir pacotes expirados

Exemplos de código

# Você também pode usar wget
curl -X POST https://api.proxylite.com/end-point/user-product/delete \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/user-product/delete

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "id": 1
}

Parâmetros

NomeEmTipoObrigatórioDescrição
bodybodyobjecttruenenhum
» team_idbodyanyfalseIdentificação do espaço de recursos públicos; omita team_id ou passe uma string vazia ao solicitar um espaço pessoal e uma string vazia ao responder a um espaço pessoal; tanto o número 0 quanto a string "0" são ilegais, e o espaço da equipe usa uma identificação pública da equipe de 6 a 12 dígitos
»» anonymousbodystringfalsenenhum
»» anonymousbodyTeamPublicIdfalseLogotipo público da equipe, o primeiro caractere é uma letra ASCII e os demais caracteres contêm apenas letras e números ASCII; a chave primária numérica do banco de dados não foi emitida
» idbodyintegertruenenhum

Exemplos de resposta

Resposta 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Respostas

StatusSignificadoDescriçãoEsquema
200OKOperação bem-sucedidaWebV1SuccessResponse
Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth, apiKeyAuth

Exclua pacotes expirados em lotes

Exemplos de código

# Você também pode usar wget
curl -X POST https://api.proxylite.com/end-point/user-product/batch-delete \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/user-product/batch-delete

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "ids": [
    1
  ]
}

Parâmetros

NomeEmTipoObrigatórioDescrição
bodybodyobjecttruenenhum
» team_idbodyanyfalseIdentificação do espaço de recursos públicos; omita team_id ou passe uma string vazia ao solicitar um espaço pessoal e uma string vazia ao responder a um espaço pessoal; tanto o número 0 quanto a string "0" são ilegais, e o espaço da equipe usa uma identificação pública da equipe de 6 a 12 dígitos
»» anonymousbodystringfalsenenhum
»» anonymousbodyTeamPublicIdfalseLogotipo público da equipe, o primeiro caractere é uma letra ASCII e os demais caracteres contêm apenas letras e números ASCII; a chave primária numérica do banco de dados não foi emitida
» idsbody[integer]truenenhum

Exemplos de resposta

Resposta 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Respostas

StatusSignificadoDescriçãoEsquema
200OKOperação bem-sucedidaWebV1SuccessResponse
Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth, apiKeyAuth

Modificar comentários do pacote

Exemplos de código

# Você também pode usar wget
curl -X POST https://api.proxylite.com/end-point/user-product/change-remark \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/user-product/change-remark

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "id": 1,
  "remark": "string"
}

Parâmetros

NomeEmTipoObrigatórioDescrição
bodybodyobjecttruenenhum
» team_idbodyanyfalseIdentificação do espaço de recursos públicos; omita team_id ou passe uma string vazia ao solicitar um espaço pessoal e uma string vazia ao responder a um espaço pessoal; tanto o número 0 quanto a string "0" são ilegais, e o espaço da equipe usa uma identificação pública da equipe de 6 a 12 dígitos
»» anonymousbodystringfalsenenhum
»» anonymousbodyTeamPublicIdfalseLogotipo público da equipe, o primeiro caractere é uma letra ASCII e os demais caracteres contêm apenas letras e números ASCII; a chave primária numérica do banco de dados não foi emitida
» idbodyintegertruenenhum
» remarkbodystringtruenenhum

Exemplos de resposta

Resposta 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Respostas

StatusSignificadoDescriçãoEsquema
200OKOperação bem-sucedidaWebV1SuccessResponse
Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth, apiKeyAuth

Definir switches IP UDP estáticos em lotes

Exemplos de código

# Você também pode usar wget
curl -X POST https://api.proxylite.com/end-point/user-product/set-ip-udp \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/user-product/set-ip-udp

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "ids": [
    1
  ],
  "udp": 0
}

Parâmetros

NomeEmTipoObrigatórioDescrição
bodybodyobjecttruenenhum
» team_idbodyanyfalseIdentificação do espaço de recursos públicos; omita team_id ou passe uma string vazia ao solicitar um espaço pessoal e uma string vazia ao responder a um espaço pessoal; tanto o número 0 quanto a string "0" são ilegais, e o espaço da equipe usa uma identificação pública da equipe de 6 a 12 dígitos
»» anonymousbodystringfalsenenhum
»» anonymousbodyTeamPublicIdfalseLogotipo público da equipe, o primeiro caractere é uma letra ASCII e os demais caracteres contêm apenas letras e números ASCII; a chave primária numérica do banco de dados não foi emitida
» idsbody[integer]truenenhum
» udpbodyintegertruenenhum

Valores enumerados

ParameterValue
» udp0
» udp1

Exemplos de resposta

Resposta 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Respostas

StatusSignificadoDescriçãoEsquema
200OKOperação bem-sucedidaWebV1SuccessResponse
Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth, apiKeyAuth

Gerenciamento de pacotes

Alterar o IP estático do ISP do data center

Exemplos de código

# Você também pode usar wget
curl -X POST https://api.proxylite.com/end-point/user-product/change-datacenter-isp-ip \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/user-product/change-datacenter-isp-ip

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "id": 1,
  "country_code": "string",
  "ip": "string"
}

Parâmetros

NomeEmTipoObrigatórioDescrição
bodybodyobjecttruenenhum
» team_idbodyanyfalseIdentificação do espaço de recursos públicos; omita team_id ou passe uma string vazia ao solicitar um espaço pessoal e uma string vazia ao responder a um espaço pessoal; tanto o número 0 quanto a string "0" são ilegais, e o espaço da equipe usa uma identificação pública da equipe de 6 a 12 dígitos
»» anonymousbodystringfalsenenhum
»» anonymousbodyTeamPublicIdfalseLogotipo público da equipe, o primeiro caractere é uma letra ASCII e os demais caracteres contêm apenas letras e números ASCII; a chave primária numérica do banco de dados não foi emitida
» idbodyintegertrueID do plano do usuário
» country_codebodystringfalseCódigo do país/região de destino; se não for aprovado, o país/região do IP atual será usado primeiro.
» ipbodystringfalseFiltragem de prefixo IP de destino

Exemplos de resposta

Resposta 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "ip_id": 1,
    "ip": "string",
    "country_code": "string"
  },
  "request_id": "string"
}

Respostas

StatusSignificadoDescriçãoEsquema
200OKSolicitação bem-sucedidaInline

Esquema da resposta

Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth

Obtenha registros de substituição de IP estático

Exemplos de código

# Você também pode usar wget
curl -X GET https://api.proxylite.com/end-point/user-product/ip-change-log \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/user-product/ip-change-log

Parâmetros

NomeEmTipoObrigatórioDescrição
team_idqueryResourceSpaceIdfalseIdentificador de espaço de recursos; espaço pessoal omite ou passa uma string vazia
pagequeryintegerfalsenenhum
page_sizequeryintegerfalsenenhum

Exemplos de resposta

Resposta 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "old": "string",
        "new": "string",
        "created_at": "string",
        "created_timestamp": 0
      }
    ],
    "page": 1,
    "page_size": 1,
    "total_count": 0,
    "page_count": 0
  },
  "request_id": "string"
}

Respostas

StatusSignificadoDescriçãoEsquema
200OKSolicitação bem-sucedidaInline

Esquema da resposta

Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth, apiKeyAuth

Defina a opção de renovação automática para um único pacote

Exemplos de código

# Você também pode usar wget
curl -X POST https://api.proxylite.com/end-point/user-product/set-auto-renewal \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/user-product/set-auto-renewal

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "user_product_id": 1,
  "status": 0
}

Parâmetros

NomeEmTipoObrigatórioDescrição
bodybodyobjecttruenenhum
» team_idbodyanyfalseIdentificação do espaço de recursos públicos; omita team_id ou passe uma string vazia ao solicitar um espaço pessoal e uma string vazia ao responder a um espaço pessoal; tanto o número 0 quanto a string "0" são ilegais, e o espaço da equipe usa uma identificação pública da equipe de 6 a 12 dígitos
»» anonymousbodystringfalsenenhum
»» anonymousbodyTeamPublicIdfalseLogotipo público da equipe, o primeiro caractere é uma letra ASCII e os demais caracteres contêm apenas letras e números ASCII; a chave primária numérica do banco de dados não foi emitida
» user_product_idbodyintegertruenenhum
» statusbodyintegerfalse0=desativar, 1=ativar

Valores enumerados

ParameterValue
» status0
» status1

Exemplos de resposta

Resposta 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "id": 1
  },
  "request_id": "string"
}

Respostas

StatusSignificadoDescriçãoEsquema
200OKSolicitação bem-sucedidaInline

Esquema da resposta

Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth

Definir opção de renovação automática para pacotes em lotes

Exemplos de código

# Você também pode usar wget
curl -X POST https://api.proxylite.com/end-point/user-product/batch-set-auto-renewal \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/user-product/batch-set-auto-renewal

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "user_product_ids": [
    1
  ],
  "status": 0
}

Parâmetros

NomeEmTipoObrigatórioDescrição
bodybodyobjecttruenenhum
» team_idbodyanyfalseIdentificação do espaço de recursos públicos; omita team_id ou passe uma string vazia ao solicitar um espaço pessoal e uma string vazia ao responder a um espaço pessoal; tanto o número 0 quanto a string "0" são ilegais, e o espaço da equipe usa uma identificação pública da equipe de 6 a 12 dígitos
»» anonymousbodystringfalsenenhum
»» anonymousbodyTeamPublicIdfalseLogotipo público da equipe, o primeiro caractere é uma letra ASCII e os demais caracteres contêm apenas letras e números ASCII; a chave primária numérica do banco de dados não foi emitida
» user_product_idsbody[integer]truenenhum
» statusbodyintegerfalse0=desativar, 1=ativar

Valores enumerados

ParameterValue
» status0
» status1

Exemplos de resposta

Resposta 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "results": [
      {
        "user_product_id": 1,
        "success": true,
        "id": 1
      }
    ]
  },
  "request_id": "string"
}

Respostas

StatusSignificadoDescriçãoEsquema
200OKA solicitação foi bem-sucedida; cada pacote retorna os resultados do processamento de forma independente.Inline

Esquema da resposta

Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth

Defina parâmetros padrão de renovação automática para tipos de produtos

Exemplos de código

# Você também pode usar wget
curl -X POST https://api.proxylite.com/end-point/user-product/set-auto-renewal-default-config \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/user-product/set-auto-renewal-default-config

Passe pelo menos um dos dias_antes_expire, tráfego_threshold, renovação_ciclo_dias; um valor 0 significa redefinir a configuração correspondente.

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "product_type": 9,
  "days_before_expire": 30,
  "traffic_threshold": 100,
  "renewal_cycle_days": 0
}

Parâmetros

NomeEmTipoObrigatórioDescrição
bodybodyobjecttruenenhum
» team_idbodyanyfalseIdentificação do espaço de recursos públicos; omita team_id ou passe uma string vazia ao solicitar um espaço pessoal e uma string vazia ao responder a um espaço pessoal; tanto o número 0 quanto a string "0" são ilegais, e o espaço da equipe usa uma identificação pública da equipe de 6 a 12 dígitos
»» anonymousbodystringfalsenenhum
»» anonymousbodyTeamPublicIdfalseLogotipo público da equipe, o primeiro caractere é uma letra ASCII e os demais caracteres contêm apenas letras e números ASCII; a chave primária numérica do banco de dados não foi emitida
» product_typebodyintegertruenenhum
» days_before_expirebodyintegerfalsenenhum
» traffic_thresholdbodyintegerfalseUnidades GB, suportadas apenas em 12/09/24
» renewal_cycle_daysbodyintegerfalseCompatível apenas em 14/11/16/25 e deve ser o ciclo atual do produto à venda
» anonymousbodyobjectfalsenenhum
» anonymousbodyobjectfalsenenhum
» anonymousbodyobjectfalsenenhum

Valores enumerados

ParameterValue
» product_type9
» product_type11
» product_type12
» product_type14
» product_type16
» product_type24
» product_type25

Exemplos de resposta

Resposta 200

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

Respostas

StatusSignificadoDescriçãoEsquema
200OKA solicitação foi bem-sucedida, os dados são nulosInline

Esquema da resposta

Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth

Obtenha os parâmetros padrão de renovação automática do tipo de produto

Exemplos de código

# Você também pode usar wget
curl -X POST https://api.proxylite.com/end-point/user-product/get-auto-renewal-default-config \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/user-product/get-auto-renewal-default-config

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "product_type": 9
}

Parâmetros

NomeEmTipoObrigatórioDescrição
bodybodyobjectfalsenenhum
» team_idbodyanyfalseIdentificação do espaço de recursos públicos; omita team_id ou passe uma string vazia ao solicitar um espaço pessoal e uma string vazia ao responder a um espaço pessoal; tanto o número 0 quanto a string "0" são ilegais, e o espaço da equipe usa uma identificação pública da equipe de 6 a 12 dígitos
»» anonymousbodystringfalsenenhum
»» anonymousbodyTeamPublicIdfalseLogotipo público da equipe, o primeiro caractere é uma letra ASCII e os demais caracteres contêm apenas letras e números ASCII; a chave primária numérica do banco de dados não foi emitida
» product_typebodyintegerfalseSe não for aprovado, todos os tipos suportados serão retornados.

Valores enumerados

ParameterValue
» product_type9
» product_type11
» product_type12
» product_type14
» product_type16
» product_type24
» product_type25

Exemplos de resposta

Resposta 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "configs": [
      {
        "product_type": 9,
        "days_before_expire": 0,
        "source": "user",
        "renewal_cycle": {
          "days": 1,
          "unit": "day",
          "source": "user"
        },
        "traffic_threshold": 0,
        "traffic_source": "user"
      }
    ]
  },
  "request_id": "string"
}

Respostas

StatusSignificadoDescriçãoEsquema
200OKSolicitação bem-sucedidaInline

Esquema da resposta

Valores enumerados

PropriedadeValor
product_type9
product_type11
product_type12
product_type14
product_type16
product_type24
product_type25
sourceuser
sourcesystem
sourceuser
sourcesystem
traffic_sourceuser
traffic_sourcesystem
Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth, apiKeyAuth

Obtenha a configuração de renovação automática e a visualização da renovação de um único pacote

Exemplos de código

# Você também pode usar wget
curl -X POST https://api.proxylite.com/end-point/user-product/get-auto-renewal \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/user-product/get-auto-renewal

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "user_product_id": 1
}

Parâmetros

NomeEmTipoObrigatórioDescrição
bodybodyobjecttruenenhum
» team_idbodyanyfalseIdentificação do espaço de recursos públicos; omita team_id ou passe uma string vazia ao solicitar um espaço pessoal e uma string vazia ao responder a um espaço pessoal; tanto o número 0 quanto a string "0" são ilegais, e o espaço da equipe usa uma identificação pública da equipe de 6 a 12 dígitos
»» anonymousbodystringfalsenenhum
»» anonymousbodyTeamPublicIdfalseLogotipo público da equipe, o primeiro caractere é uma letra ASCII e os demais caracteres contêm apenas letras e números ASCII; a chave primária numérica do banco de dados não foi emitida
» user_product_idbodyintegertruenenhum

Exemplos de resposta

Resposta 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "expired_at": "string",
    "time_days": 0,
    "time_unit": "day",
    "next_expired_at": "string",
    "agreed_price": 0,
    "currency": "string",
    "config": {
      "id": 1,
      "user_id": 1,
      "team_id": "A1b2C3d4E5f6",
      "team_user_id": 0,
      "product_type": 0,
      "left_traffic": 0,
      "left_days": 0,
      "user_product_id": 1,
      "product_id": 0,
      "status": 0,
      "currency": "string",
      "agreed_price": 0,
      "agreed_bandwidth_price": 0,
      "agreed_concurrency_price": 0,
      "bandwidth_id": 0,
      "concurrency_id": 0,
      "duration": 0,
      "renew_product_id": 0,
      "days_before_expire": 0,
      "traffic_threshold": 0,
      "parent_product_type": 0,
      "created_at": "string",
      "updated_at": "string"
    },
    "traffic_threshold": 0
  },
  "request_id": "string"
}

Respostas

StatusSignificadoDescriçãoEsquema
200OKSolicitação bem-sucedidaInline

Esquema da resposta

Valores enumerados

PropriedadeValor
time_unitday
time_unithour
status0
status1
Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth, apiKeyAuth

Obtenha registros de execução de renovação automática

Exemplos de código

# Você também pode usar wget
curl -X POST https://api.proxylite.com/end-point/user-product/auto-renewal-logs \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/user-product/auto-renewal-logs

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "user_product_id": 1,
  "page": 1,
  "size": 20
}

Parâmetros

NomeEmTipoObrigatórioDescrição
bodybodyobjectfalsenenhum
» team_idbodyanyfalseIdentificação do espaço de recursos públicos; omita team_id ou passe uma string vazia ao solicitar um espaço pessoal e uma string vazia ao responder a um espaço pessoal; tanto o número 0 quanto a string "0" são ilegais, e o espaço da equipe usa uma identificação pública da equipe de 6 a 12 dígitos
»» anonymousbodystringfalsenenhum
»» anonymousbodyTeamPublicIdfalseLogotipo público da equipe, o primeiro caractere é uma letra ASCII e os demais caracteres contêm apenas letras e números ASCII; a chave primária numérica do banco de dados não foi emitida
» user_product_idbodyintegerfalseSe não for aprovado, todos os registros no espaço atual serão consultados.
» pagebodyintegerfalsenenhum
» sizebodyintegerfalsenenhum

Exemplos de resposta

Resposta 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "id": 1,
        "user_id": 1,
        "team_id": "A1b2C3d4E5f6",
        "team_user_id": 0,
        "config_id": 0,
        "user_product_id": 1,
        "product_type": 0,
        "renew_product_id": 0,
        "order_id": 0,
        "fee": 0,
        "currency": "string",
        "before_expired_at": "string",
        "after_expired_at": "string",
        "before_remain": 0,
        "after_remain": 0,
        "trigger_type": 0,
        "status": 1,
        "revoke_at": "string",
        "revoke_remark": "string",
        "created_at": "string",
        "updated_at": "string"
      }
    ],
    "page": 1,
    "page_size": 1,
    "total_page": 0,
    "total_count": 0
  },
  "request_id": "string"
}

Respostas

StatusSignificadoDescriçãoEsquema
200OKSolicitação bem-sucedidaInline

Esquema da resposta

Valores enumerados

PropriedadeValor
trigger_type0
trigger_type1
status1
status2
status3
Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth, apiKeyAuth

Gestão de pagamentos

Puxe o pagamento do pedido

Exemplos de código

# Você também pode usar wget
curl -X POST https://api.proxylite.com/end-point/pay?trade_no=string \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/pay

Parâmetros

NomeEmTipoObrigatórioDescrição
team_idqueryResourceSpaceIdfalsenenhum
trade_noquerystringtruenenhum
pm_idqueryintegerfalsenenhum

Exemplos de resposta

Resposta 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Respostas

StatusSignificadoDescriçãoEsquema
200OKOperação bem-sucedidaWebV1SuccessResponse
Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth

Iniciar o pagamento de pedidos não pagos emitidos em segundo plano

Exemplos de código

# Você também pode usar wget
curl -X POST https://api.proxylite.com/end-point/pay/index-choose \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/pay/index-choose

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "trade_no": "string",
  "pay_method": 0,
  "pm_id": 0,
  "trade_type": "string"
}

Parâmetros

NomeEmTipoObrigatórioDescrição
bodybodyobjecttruenenhum
» team_idbodyanyfalseIdentificação do espaço de recursos públicos; omita team_id ou passe uma string vazia ao solicitar um espaço pessoal e uma string vazia ao responder a um espaço pessoal; tanto o número 0 quanto a string "0" são ilegais, e o espaço da equipe usa uma identificação pública da equipe de 6 a 12 dígitos
»» anonymousbodystringfalsenenhum
»» anonymousbodyTeamPublicIdfalseLogotipo público da equipe, o primeiro caractere é uma letra ASCII e os demais caracteres contêm apenas letras e números ASCII; a chave primária numérica do banco de dados não foi emitida
» trade_nobodystringtruenenhum
» pay_methodbodyintegerfalsenenhum
» pm_idbodyintegerfalsenenhum
» trade_typebodystringfalsenenhum

Exemplos de resposta

Resposta 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Respostas

StatusSignificadoDescriçãoEsquema
200OKOperação bem-sucedidaWebV1SuccessResponse
Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth

Pré-visualização da taxa de soma de pagamento

Exemplos de código

# Você também pode usar wget
curl -X POST https://api.proxylite.com/end-point/pay/pay-check?trade_no=string \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/pay/pay-check

Parâmetros

NomeEmTipoObrigatórioDescrição
team_idqueryResourceSpaceIdfalsenenhum
trade_noquerystringtruenenhum
pm_idqueryintegerfalsenenhum

Exemplos de resposta

Resposta 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "trade_no": "string",
    "pm_id": 0,
    "pay_method": 0,
    "trade_type": "string",
    "country_code": "string",
    "currency": "string",
    "goods_fee": 0,
    "discount_fee": 0,
    "handling_fee": 0,
    "pay_fee": 0,
    "total_fee": 0,
    "pay_method_info": {
      "id": 0,
      "type": 0,
      "title": "string",
      "group": "string",
      "handling_rate": 0,
      "handling_fee": 0,
      "handling_fee_currency": "usd",
      "handling_fee_converted": 0
    },
    "origin": {
      "pm_id": 0,
      "pay_method": 0,
      "goods_fee": 0,
      "discount_fee": 0,
      "handling_fee": 0,
      "pay_fee": 0,
      "total_fee": 0
    }
  },
  "request_id": "string"
}

Respostas

StatusSignificadoDescriçãoEsquema
200OKSolicitação bem-sucedidaInline

Esquema da resposta

Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth

Renderize diretamente a página de pagamento da web

Exemplos de código

# Você também pode usar wget
curl -X GET https://api.proxylite.com/end-point/pay/web-direct-pay?trade_no=string \
  -H 'Accept: text/html' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/pay/web-direct-pay

Parâmetros

NomeEmTipoObrigatórioDescrição
team_idqueryResourceSpaceIdfalsenenhum
trade_noquerystringtruenenhum
pm_idqueryintegerfalsenenhum

Exemplos de resposta

Resposta 200

"string"

Respostas

StatusSignificadoDescriçãoEsquema
200OKPágina de pagamento HTMLstring
Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth

Obtenha uma lista de métodos de pagamento (GET /end-point/payment/list)

Exemplos de código

# Você também pode usar wget
curl -X GET https://api.proxylite.com/end-point/payment/list \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/payment/list

Parâmetros

NomeEmTipoObrigatórioDescrição
trade_noquerystringfalseNúmero do pedido - pode ser repassado quando alguns pedidos exigirem uma forma de pagamento específica
currencyquerystringfalseunidade monetária

Exemplos de resposta

Resposta 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "id": 0,
        "title": "string",
        "logo": "string",
        "group": "string",
        "handling_rate": 0,
        "handling_fee": 0,
        "disabled": false,
        "min": 0,
        "max": 0
      }
    ]
  },
  "request_id": "string"
}

Respostas

StatusSignificadoDescriçãoEsquema
200OKobter sucessoInline

Esquema da resposta

Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth, apiKeyAuth

Obtenha uma lista de métodos de pagamento (GET /end-point/payment/groups)

Exemplos de código

# Você também pode usar wget
curl -X GET https://api.proxylite.com/end-point/payment/groups \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/payment/groups

Parâmetros

NomeEmTipoObrigatórioDescrição
trade_noquerystringfalseNúmero do pedido - pode ser repassado quando alguns pedidos exigirem uma forma de pagamento específica

Exemplos de resposta

Resposta 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "name": "string",
        "logos": [
          "string"
        ],
        "items": [
          {
            "id": 0,
            "title": "string",
            "logo": "string",
            "group": "string",
            "disabled": false,
            "min": 0,
            "max": 0
          }
        ]
      }
    ]
  },
  "request_id": "string"
}

Respostas

StatusSignificadoDescriçãoEsquema
200OKobter sucessoInline

Esquema da resposta

Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth, apiKeyAuth

Comercialização

Proporção de bônus de recarga

Exemplos de código

# Você também pode usar wget
curl -X GET https://api.proxylite.com/end-point/activity/balance-recharge-gift-ratio \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

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

Proporção de bônus de recarga

Exemplos de resposta

Resposta 200

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

Respostas

StatusSignificadoDescriçãoEsquema
200OKOKInline

Esquema da resposta

Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth, apiKeyAuth

Produtos

Lista de produtos

Exemplos de código

# Você também pode usar wget
curl -X GET https://api.proxylite.com/end-point/product \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/product

Obtenha a lista de pacotes disponíveis para compra no site atual e suporte à filtragem por tipo, período de validade e outras condições.

Parâmetros

NomeEmTipoObrigatórioDescrição
typequeryintegerfalseTipo de pacote, consulte a descrição da enumeração Product.type. Se não for aprovado, todos os tipos serão retornados.
parent_product_typequeryintegerfalseTipo de pacote pai, válido apenas quando tipo=19 (renovação de IP), usado para filtrar linhas de produtos: 14=data center 25=residencial
time_daysqueryanyfalseFiltragem por período de validade, suporta valor único ou matriz, como 30/[30,90,365]
show_typequeryanyfalseFiltragem de tipo de exibição, suporta valor único ou matriz

Valores enumerados

ParameterValue
parent_product_type14
parent_product_type25

Exemplos de resposta

Resposta 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": [
    {
      "id": 0,
      "title": "string",
      "type": 0,
      "show_type": 0,
      "status": 0,
      "price": 0.1,
      "usd_price": 0.1,
      "price_hkd": 0.1,
      "original_price": 0.1,
      "original_usd_price": 0.1,
      "original_price_hkd": 0.1,
      "local_price": 0.1,
      "local_original_price": 0.1,
      "preferred_currency": "string",
      "support_currencies": "string",
      "flow_value": 0.1,
      "flow_give": 0.1,
      "balance_give": 0.1,
      "balance_value": 0.1,
      "time_validity": 0.1,
      "time_price": 0.1,
      "time_days": 0,
      "tip1": "string",
      "tip2": "string",
      "introduce": [
        "string"
      ],
      "region_list_id": 0,
      "renew_product_list": "string",
      "parent_product_type": 0,
      "total_count": 0,
      "remain_count": 0,
      "extension_of_time_days": [
        0
      ],
      "time_days_price_rate": 0.1,
      "desc": {
        "subtitle": "string",
        "flow_value": 0.1,
        "flow_give": 0.1,
        "balance_give": 0.1,
        "time_validity": 0.1,
        "time_price": 0.1,
        "tip1": "string",
        "tip2": "string",
        "introduce": [
          "string"
        ]
      },
      "sku": {
        "bandwidth_list": [
          {
            "id": 0,
            "value": 0,
            "price": 0.1,
            "price_usd": 0.1,
            "price_hkd": 0.1
          }
        ],
        "duration_list": [
          {
            "id": 0,
            "value": 0,
            "price": 0.1,
            "price_usd": 0.1,
            "price_hkd": 0.1
          }
        ],
        "concurrency_list": [
          {
            "id": 0,
            "value": 0,
            "price": 0.1,
            "price_usd": 0.1,
            "price_hkd": 0.1
          }
        ]
      }
    }
  ],
  "request_id": "string"
}

Respostas

StatusSignificadoDescriçãoEsquema
200OKOKInline

Esquema da resposta

Para realizar esta operação, você deve se autenticar usando um dos seguintes métodos: bearerAuth

Esquemas

OpenApiAccountProfile

{
  "id": 0,
  "username": "string",
  "nickname": "string",
  "email": "string",
  "balance": "string",
  "gift_balance": "string",
  "currency": "string",
  "language": "string",
  "timezone": "string"
}

Propriedades

NomeTipoObrigatórioRestriçõesDescrição
idintegertruenenhumID do usuário
usernamestringtruenenhumNome de usuário
nicknamestringtruenenhumApelido
emailstringtruenenhumVincular e-mail
balancestringtruenenhumSaldo de recarga, string decimal
gift_balancestringtruenenhumSaldo de bônus atual, sequência decimal
currencystringtruenenhumMoeda do site
languagestringtruenenhumIdioma do usuário, o idioma do site será usado se não estiver configurado
timezonestringtruenenhumFuso horário do usuário, use o fuso horário do site se não estiver configurado

OpenApiBalanceRecord

{
  "id": 0,
  "re_type": 0,
  "transaction_type": 0,
  "balance_type": 0,
  "fee": "string"
}

Propriedades

NomeTipoObrigatórioRestriçõesDescrição
idinteger,stringfalsenenhumOs valores do banco de dados podem ser serializados como strings
re_typeinteger,stringfalsenenhum0 despesas, 1 receita
transaction_typeinteger,stringfalsenenhumtipo de transação
balance_typeinteger,stringfalsenenhumTipo de saldo
feestring,numberfalsenenhumAlterar valor, moeda do site

OpenApiLogExportTask

{
  "id": 0,
  "user_id": 0,
  "start_time": "string",
  "end_time": "string",
  "status": "pending",
  "file_size": 0,
  "record_count": 0,
  "created_at": "string",
  "completed_at": "string",
  "file_url": "string",
  "download_url": "string",
  "error_message": "string"
}

Propriedades

NomeTipoObrigatórioRestriçõesDescrição
idinteger,stringfalsenenhumOs valores do banco de dados podem ser serializados como strings
user_idinteger,stringfalsenenhumDetalhes da interface retorna
start_timestringfalsenenhumY-m-d H:i:s; data não RFC 3339
end_timestringfalsenenhumY-m-d H:i:s; data não RFC 3339
statusstringfalsenenhumnone
file_sizeinteger,string,nullfalsenenhumnone
record_countinteger,string,nullfalsenenhumnone
created_atstringfalsenenhumY-m-d H:i:s; data não RFC 3339
completed_atstringfalsenenhumY-m-d H:i:s; data não RFC 3339
file_urlstringfalsenenhumApós a conclusão, a interface de detalhes retorna
download_urlstringfalsenenhumRetorno após a conclusão, endereço de download de assinatura válido por 24 horas
error_messagestringfalsenenhumEm caso de falha, a interface de detalhes pode retornar

Valores enumerados

PropriedadeValor
statuspending
statusprocessing
statuscompleted
statusfailed
statuscanceled
statusno_data

OpenApiCoupon

{
  "id": 0,
  "coupon_id": 0,
  "type": 0,
  "status": 0,
  "source": 0,
  "title": "string",
  "title_en": "string",
  "description": "string",
  "description_en": "string",
  "start_amount": "string",
  "start_amount_usd": "string",
  "start_amount_hkd": "string",
  "deduction_amount": "string",
  "deduction_amount_usd": "string",
  "deduction_amount_hkd": "string",
  "discount_rate": "string",
  "discount_ceiling_amount": "string",
  "discount_ceiling_amount_usd": "string",
  "discount_ceiling_amount_hkd": "string",
  "created_at": "string",
  "effect_at": "string",
  "expired_at": "string",
  "used_at": "string",
  "product_types": "string",
  "created_timestamp": 0,
  "effect_timestamp": 0,
  "expired_timestamp": 0,
  "used_timestamp": 0,
  "is_expired": true
}

Propriedades

NomeTipoObrigatórioRestriçõesDescrição
idinteger,stringfalsenenhumOs valores do banco de dados podem ser serializados como strings
coupon_idinteger,stringfalsenenhumOs valores do banco de dados podem ser serializados como strings
typeinteger,stringfalsenenhumOs valores do banco de dados podem ser serializados como strings
statusinteger,stringfalsenenhumOs valores do banco de dados podem ser serializados como strings
sourceinteger,stringfalsenenhumOs valores do banco de dados podem ser serializados como strings
titlestringfalsenenhumnone
title_enstringfalsenenhumnone
descriptionstringfalsenenhumnone
description_enstringfalsenenhumnone
start_amountstring,number,nullfalsenenhumnone
start_amount_usdstring,number,nullfalsenenhumnone
start_amount_hkdstring,number,nullfalsenenhumnone
deduction_amountstring,number,nullfalsenenhumnone
deduction_amount_usdstring,number,nullfalsenenhumnone
deduction_amount_hkdstring,number,nullfalsenenhumnone
discount_ratestring,number,nullfalsenenhumnone
discount_ceiling_amountstring,number,nullfalsenenhumnone
discount_ceiling_amount_usdstring,number,nullfalsenenhumnone
discount_ceiling_amount_hkdstring,number,nullfalsenenhumnone
created_atstring,nullfalsenenhumY-m-d H:i:s
effect_atstring,nullfalsenenhumY-m-d H:i:s
expired_atstring,nullfalsenenhumY-m-d H:i:s
used_atstring,nullfalsenenhumY-m-d H:i:s
product_typesstring,nullfalsenenhumTipos de pacotes aplicáveis
created_timestampinteger,nullfalsenenhumnone
effect_timestampinteger,nullfalsenenhumnone
expired_timestampinteger,nullfalsenenhumnone
used_timestampinteger,nullfalsenenhumnone
is_expiredbooleanfalsenenhumListar retornos da interface

OpenApiNotification

{
  "id": 0,
  "title": "string",
  "content": "string",
  "type": 0,
  "read_status": 0,
  "created_at": "string",
  "created_timestamp": 0
}

Propriedades

NomeTipoObrigatórioRestriçõesDescrição
idinteger,stringfalsenenhumOs valores do banco de dados podem ser serializados como strings
titlestringfalsenenhumnone
contentstringfalsenenhumConteúdo renderizado no idioma solicitado
typeinteger,stringfalsenenhumOs valores do banco de dados podem ser serializados como strings
read_statusintegerfalsenenhumnone
created_atstringfalsenenhumY-m-d H:i:s; data não RFC 3339
created_timestampintegerfalsenenhumnone

Valores enumerados

PropriedadeValor
read_status0
read_status1

productTypes

9

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

Propriedades

NomeTipoObrigatórioRestriçõesDescrição
anonymousintegerfalsenenhumTipo de pacote, 9 pacotes de tráfego residencial dinâmico, 11 IP residencial dinâmico, 14 IP de data center estático, 25 IP residencial estático

Valores enumerados

PropriedadeValor
anonymous9
anonymous11
anonymous14
anonymous25

apiKey

"pa$$word"

Chave API; passado usando apiKeyAuth ou o parâmetro de solicitação declarado pela operação

Propriedades

NomeTipoObrigatórioRestriçõesDescrição
anonymousstring(password)falsenenhumChave API; passado usando apiKeyAuth ou o parâmetro de solicitação declarado pela operação

responseCode

200

Código de status, 200 bem-sucedido, 3 app_key inválido

Propriedades

NomeTipoObrigatórioRestriçõesDescrição
anonymousintegerfalsenenhumCódigo de status, 200 bem-sucedido, 3 app_key inválido

responseMsg

"success"

response message

Propriedades

NomeTipoObrigatórioRestriçõesDescrição
anonymousstringfalsenenhumresponse message

SuccessResponse

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Propriedades

None

ErrorResponse

{
  "code": 2,
  "msg": "parameter error",
  "data": {},
  "request_id": "string"
}

Propriedades

None

WebV1SuccessResponse

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Propriedades

NomeTipoObrigatórioRestriçõesDescrição
codeintegertruenenhumnone
msgstringtruenenhumnone
dataobject,array,string,number,boolean,nulltruenenhumDados de negócios, o tipo específico é definido pela interface
request_idstringtruenenhumSolicitar ID de rastreamento do link

WebV1ErrorResponse

{
  "code": 2,
  "msg": "parameter error",
  "data": {},
  "request_id": "string"
}

Propriedades

NomeTipoObrigatórioRestriçõesDescrição
codeintegertruenenhumCódigo de erro comercial

not

NomeTipoObrigatórioRestriçõesDescrição
» anonymousanyfalsenenhumnone

continued

NomeTipoObrigatórioRestriçõesDescrição
msgstringtruenenhumDescrição do erro
dataobject,array,nulltruenenhumErro de dados adicionais, nulo se não houver dados adicionais
request_idstringtruenenhumSolicitar ID de rastreamento do link

TeamPublicId

"A1b2C3d4E5f6"

Logotipo público da equipe, o primeiro caractere é uma letra ASCII e os demais caracteres contêm apenas letras e números ASCII; a chave primária numérica do banco de dados não foi emitida

Propriedades

NomeTipoObrigatórioRestriçõesDescrição
anonymousstringfalsenenhumLogotipo público da equipe, o primeiro caractere é uma letra ASCII e os demais caracteres contêm apenas letras e números ASCII; a chave primária numérica do banco de dados não foi emitida

ResourceSpaceId

"A1b2C3d4E5f6"

Identificação do espaço de recursos públicos; omita team_id ou passe uma string vazia ao solicitar um espaço pessoal e uma string vazia ao responder a um espaço pessoal; tanto o número 0 quanto a string "0" são ilegais, e o espaço da equipe usa uma identificação pública da equipe de 6 a 12 dígitos

Propriedades

oneOf

NomeTipoObrigatórioRestriçõesDescrição
anonymousstringfalsenenhumnone

xor

NomeTipoObrigatórioRestriçõesDescrição
anonymousTeamPublicIdfalsenenhumLogotipo público da equipe, o primeiro caractere é uma letra ASCII e os demais caracteres contêm apenas letras e números ASCII; a chave primária numérica do banco de dados não foi emitida

Team

{
  "id": "A1b2C3d4E5f6",
  "name": "string",
  "super_admin_user_id": 1,
  "status": 0,
  "current_role": 1,
  "dissolving_at": "string",
  "dissolved_at": "string",
  "created_at": "string",
  "updated_at": "string"
}

Propriedades

NomeTipoObrigatórioRestriçõesDescrição
idTeamPublicIdtruenenhumLogotipo público da equipe, o primeiro caractere é uma letra ASCII e os demais caracteres contêm apenas letras e números ASCII; a chave primária numérica do banco de dados não foi emitida
namestringtruenenhumNome da equipe
super_admin_user_idintegertruenenhumID de usuário do superadministrador
statusintegertruenenhumStatus da equipe: 0=desativado, 1=válido, 2=dissolvido, 3=dissolvido
current_roleinteger,nulltruenenhumA função do usuário atual na equipe; nulo se não puder ser determinado
dissolving_atstring,nulltruenenhumIniciar o tempo de dissolução
dissolved_atstring,nulltruenenhumTempo de conclusão da dissolução
created_atstringtruenenhumhora de criação
updated_atstringtruenenhumHora de atualização

Valores enumerados

PropriedadeValor
status0
status1
status2
status3
current_role1
current_role2
current_role3
current_role4
current_rolenull

TeamAsset

{
  "id": 1,
  "user_id": 1,
  "team_id": "A1b2C3d4E5f6",
  "team_user_id": 0,
  "product_id": 1,
  "product_type": 0,
  "parent_product_type": 0,
  "status": 0,
  "total_amount": 0,
  "remain": 0,
  "bandwidth": 0,
  "concurrency": 0,
  "expired_at": "string",
  "created_at": "string",
  "ip": "string",
  "country_code": "string",
  "country_name": "string",
  "asn": "string",
  "port": 0
}

Propriedades

NomeTipoObrigatórioRestriçõesDescrição
idintegertruenenhumID do plano do usuário
user_idintegertruenenhumID de usuário do proprietário do recurso
team_idResourceSpaceIdtruenenhumIdentificação do espaço de recursos públicos; omita team_id ou passe uma string vazia ao solicitar um espaço pessoal e uma string vazia ao responder a um espaço pessoal; tanto o número 0 quanto a string "0" são ilegais, e o espaço da equipe usa uma identificação pública da equipe de 6 a 12 dígitos
team_user_idintegertruenenhumCriação real de IDs de usuários membros
product_idintegertruenenhumID do produto
product_typeintegertruenenhumtipo de produto
parent_product_typeintegertruenenhumTipo de produto pai
statusintegertruenenhumStatus do pacote
total_amountinteger(int64)truenenhumvalor total
remaininteger(int64)truenenhumMontante restante
bandwidthintegerfalsenenhumLargura de banda (Mbps); retornado apenas por product_type=19 ou 11
concurrencyintegerfalsenenhumNúmero de simultaneidades; apenas product_type=11 é retornado
expired_atstring,nulltruenenhumPrazo de validade
created_atstringtruenenhumhora de criação
ipstringfalsenenhumEndereço IP estático; apenas product_type=19 retorna
country_codestringfalsenenhumCódigo IP estático do país; apenas product_type=19 retorna
country_namestringfalsenenhumNome do país IP estático; retornado apenas por product_type=19
asnstringfalsenenhumASN de IP estático; apenas product_type=19 é retornado
portintegerfalsenenhumPorta proxy IP estática; retornado apenas por product_type=19

TeamProductInfo

{
  "team_id": "A1b2C3d4E5f6",
  "product_types": [
    0
  ],
  "product_residence_remain_count": 0,
  "product_residence_total_count": 0,
  "pdrue2_timestamp": 0,
  "remain": 0,
  "total_amount": 0,
  "scraping_remain": 0,
  "scraping_total_amount": 0,
  "scraping_timestamp": "string",
  "scraping_timestamp2": 0,
  "common_scraping_remain": 0,
  "common_scraping_total_amount": 0,
  "common_scraping_timestamp": "string",
  "common_scraping_timestamp2": 0,
  "pdidcr_count": 0,
  "pdidcr_total": 0,
  "pdidcr_traffic_remain": 0,
  "pdidcr_traffic_total": 0,
  "p_sitai_ip_count": 0,
  "p_sitai_ip": 0,
  "p_sitai_ip_total": 0,
  "p_sitai_remain": 0,
  "p_sitai_total": 0,
  "pdidc_count": 0,
  "pdidc_total": 0,
  "pdidc_ip_count": 0,
  "pdidc_ip_all_count": 0,
  "pdispr_count": 0,
  "pdispr_total": 0,
  "pdispr_traffic_remain": 0,
  "pdispr_traffic_total": 0,
  "product_datacenter_isp_traffic_ip_count": 0,
  "product_datacenter_isp_traffc_ip": 0,
  "product_datacenter_isp_traffc_ip_total": 0,
  "product_datacenter_isp_traffic_ip": 0,
  "product_datacenter_isp_traffic_ip_total": 0,
  "product_datacenter_isp_traffc_remain": 0,
  "product_datacenter_isp_traffc_total": 0,
  "product_datacenter_isp_traffic_remain": 0,
  "product_datacenter_isp_traffic_total": 0,
  "product_datacenter_isp_ip": 0,
  "product_datacenter_isp_ip_total": 0,
  "product_datacenter_isp_ip_count": 0,
  "product_datacenter_isp_ip_all_count": 0,
  "product_datacenter_isp_ip_traffic_remain": 0,
  "product_datacenter_isp_ip_traffic_total": 0,
  "product_agent_residence_remain_count": 0,
  "product_agent_residence_total_count": 0,
  "product_serp_remain": 0,
  "product_serp_total": 0,
  "product_serp_timestamp": "string",
  "product_serp_timestamp2": 0,
  "product_video_remain": 0,
  "product_video_total": 0,
  "product_video_timestamp": "string",
  "product_video_timestamp2": 0
}

Os campos estatísticos do pacote são consistentes com /web_v1/user/info; registros de cancelamento, reembolso ou exclusão reversível não são incluídos no resumo; exceto team_id e product_types, apenas os campos correspondentes aos tipos de produtos suportados pelo site atual são retornados

Propriedades

NomeTipoObrigatórioRestriçõesDescrição
team_idTeamPublicIdtruenenhumLogotipo público da equipe, o primeiro caractere é uma letra ASCII e os demais caracteres contêm apenas letras e números ASCII; a chave primária numérica do banco de dados não foi emitida
product_types[integer]truenenhumO espaço de recursos da equipe não foi cancelado ou excluído de forma reversível e o tipo de pacote compatível com o site atual
product_residence_remain_countinteger(int64)falsenenhumFluxo residual tipo 9
product_residence_total_countinteger(int64)falsenenhumTipo 9 Tráfego Total
pdrue2_timestampinteger(int64)falsenenhumDigite 11 último carimbo de data e hora de expiração; 0 quando não há pacote de equipe
remaininteger,stringfalsenenhumTipo 17 Quantidade Restante
total_amountinteger,stringfalsenenhumTipo 17 Quantidade total
scraping_remaininteger(int64)falsenenhumDigite 18 vezes restantes
scraping_total_amountinteger(int64)falsenenhumDigite 18 vezes no total
scraping_timestampstringfalsenenhumDigite 18 último prazo de expiração; "-" quando não há pacote
scraping_timestamp2integer(int64)falsenenhumCarimbo de data e hora de expiração mais recente tipo 18
common_scraping_remaininteger(int64)falsenenhumDigite 29 tempos restantes
common_scraping_total_amountinteger(int64)falsenenhumTipo 29 Total de Tempos
common_scraping_timestampstringfalsenenhumDigite 29 último prazo de expiração; "-" quando não há pacote
common_scraping_timestamp2integer(int64)falsenenhumCarimbo de data e hora de expiração mais recente tipo 29
pdidcr_countintegerfalsenenhumQuantidade de pacote válido tipo 12
pdidcr_totalintegerfalsenenhumNúmero total de pacotes do tipo 12
pdidcr_traffic_remaininteger(int64)falsenenhumFluxo Residual Tipo 12
pdidcr_traffic_totalinteger(int64)falsenenhumTipo 12 Tráfego Total
p_sitai_ip_countintegerfalsenenhumDigite 13 Número IP válido
p_sitai_ipintegerfalsenenhumQuantidade de pacote válido tipo 13
p_sitai_ip_totalintegerfalsenenhumNúmero total de pacotes do tipo 13
p_sitai_remaininteger(int64)falsenenhumFluxo residual tipo 13/24
p_sitai_totalinteger(int64)falsenenhumTipo 13/24 Fluxo Total
pdidc_countintegerfalsenenhumQuantidade de pacote válido tipo 14
pdidc_totalintegerfalsenenhumNúmero total de pacotes tipo 14
pdidc_ip_countintegerfalsenenhumDigite 14 Número IP válido
pdidc_ip_all_countintegerfalsenenhumTipo 14 IP Total
pdispr_countintegerfalsenenhumQuantidade de pacote válido tipo 15
pdispr_totalintegerfalsenenhumNúmero total de pacotes tipo 15
pdispr_traffic_remaininteger(int64)falsenenhumFluxo residual tipo 15
pdispr_traffic_totalinteger(int64)falsenenhumTipo 15 Tráfego Total
product_datacenter_isp_traffic_ip_countintegerfalsenenhumDigite 16 Número IP válido
product_datacenter_isp_traffc_ipintegerfalsenenhumTipo 16 Quantidade de Pacote Válido; Ortografia historicamente compatível
product_datacenter_isp_traffc_ip_totalintegerfalsenenhumTotal Tipo 16 Pacotes; Ortografias historicamente compatíveis
product_datacenter_isp_traffic_ipintegerfalsenenhumQuantidade de pacote válido tipo 16
product_datacenter_isp_traffic_ip_totalintegerfalsenenhumNúmero total de pacotes tipo 16
product_datacenter_isp_traffc_remaininteger(int64)falsenenhumTráfego residual tipo 16/24; ortografia historicamente compatível
product_datacenter_isp_traffc_totalinteger(int64)falsenenhumVazão total tipo 16/24; ortografia historicamente compatível
product_datacenter_isp_traffic_remaininteger(int64)falsenenhumFluxo residual tipo 16/24
product_datacenter_isp_traffic_totalinteger(int64)falsenenhumTipo 16/24 Fluxo Total
product_datacenter_isp_ipintegerfalsenenhumDigite 21 ou 25 quantidade de pacote válida
product_datacenter_isp_ip_totalintegerfalsenenhumDigite 21 ou 25 pacotes no total
product_datacenter_isp_ip_countintegerfalsenenhumDigite 21 ou 25 Número IP válido
product_datacenter_isp_ip_all_countintegerfalsenenhumTotal Tipo 21 ou 25 IP
product_datacenter_isp_ip_traffic_remaininteger(int64)falsenenhumO tipo 21 corresponde ao fluxo restante do tipo 24
product_datacenter_isp_ip_traffic_totalinteger(int64)falsenenhumO tipo 21 corresponde ao fluxo total do tipo 24
product_agent_residence_remain_countinteger(int64)falsenenhumFluxo Residual Tipo 22
product_agent_residence_total_countinteger(int64)falsenenhumTipo 22 Tráfego Total
product_serp_remaininteger(int64)falsenenhumDigite 27 vezes restantes
product_serp_totalinteger(int64)falsenenhumTipo 27 Total de Tempos
product_serp_timestampstringfalsenenhumDigite 27 último prazo de expiração; "-" quando não há pacote
product_serp_timestamp2integer(int64)falsenenhumCarimbo de data e hora de expiração mais recente do tipo 27
product_video_remaininteger(int64)falsenenhumFluxo Residual Tipo 28
product_video_totalinteger(int64)falsenenhumTipo 28 Fluxo Total
product_video_timestampstringfalsenenhumDigite 28 último prazo de expiração; "-" quando não há pacote
product_video_timestamp2integer(int64)falsenenhumDigite 28 carimbo de data e hora de expiração mais recente

TeamWallet

{
  "team_id": "A1b2C3d4E5f6",
  "balance": 0.1,
  "total_recharge_fee": 0.1,
  "updated_at": "string"
}

Carteira de equipe, isolada do saldo pessoal do superadministrador; o valor usa a moeda padrão do site atual, com até 4 casas decimais.

Propriedades

NomeTipoObrigatórioRestriçõesDescrição
team_idTeamPublicIdtruenenhumLogotipo público da equipe, o primeiro caractere é uma letra ASCII e os demais caracteres contêm apenas letras e números ASCII; a chave primária numérica do banco de dados não foi emitida
balancenumber(double)truenenhumSaldo atual da equipe disponível
total_recharge_feenumber(double)truenenhumO principal atual não gasto da recarga da equipe, excluindo o valor da transferência de saldo pessoal
updated_atstringtruenenhumHora da última alteração da carteira

TeamWalletRecord

{
  "id": 1,
  "team_id": "A1b2C3d4E5f6",
  "operator_user_id": 0,
  "creator": {
    "user_id": 0,
    "display_name": "string",
    "nickname": "string",
    "username": "string",
    "email": "string",
    "phone": "string"
  },
  "direction": 0,
  "transaction_type": 1,
  "amount": 0.1,
  "after_balance": 0.1,
  "link_id": 0,
  "request_id": "string",
  "remark": "string",
  "created_at": "string"
}

Propriedades

NomeTipoObrigatórioRestriçõesDescrição
idintegertruenenhumnone
team_idTeamPublicIdtruenenhumLogotipo público da equipe, o primeiro caractere é uma letra ASCII e os demais caracteres contêm apenas letras e números ASCII; a chave primária numérica do banco de dados não foi emitida
operator_user_idintegertruenenhumOperadora, o reembolso do sistema é 0
creatorTeamCreatorfalsenenhumnone
directionintegertruenenhum0=despesa, 1=receita
transaction_typeintegertruenenhum1=Recarga em conta, 2=Transferência do saldo pessoal, 3=Consumo do saldo, 4=Reembolso ou reembolso de recarga, 5=Transferir de volta para o saldo pessoal
amountnumber(double)truenenhumA quantidade dessa mudança, a direção é representada pela direção
after_balancenumber(double)truenenhumSaldo da carteira da equipe após alteração
link_idintegertruenenhumID do pedido associado; quando o saldo pessoal é transferido, é o ID do usuário operacional
request_idstringtruenenhumnone
remarkstringtruenenhumnone
created_atstringtruenenhumnone

Valores enumerados

PropriedadeValor
direction0
direction1
transaction_type1
transaction_type2
transaction_type3
transaction_type4
transaction_type5

TeamCreator

{
  "user_id": 0,
  "display_name": "string",
  "nickname": "string",
  "username": "string",
  "email": "string",
  "phone": "string"
}

Propriedades

NomeTipoObrigatórioRestriçõesDescrição
user_idintegertruenenhumID do usuário operador; operação do sistema é 0
display_namestringtruenenhumExibir nome, anotar apelido, nome de usuário, e-mail e número de celular em ordem
nicknamestringtruenenhumnone
usernamestringtruenenhumnone
emailstringtruenenhumA perspectiva do não administrador é o valor da dessensibilização
phonestringtruenenhumA perspectiva do não administrador é o valor da dessensibilização

TeamResponse

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "id": "A1b2C3d4E5f6",
    "name": "string",
    "super_admin_user_id": 1,
    "status": 0,
    "current_role": 1,
    "dissolving_at": "string",
    "dissolved_at": "string",
    "created_at": "string",
    "updated_at": "string"
  },
  "request_id": "string"
}

Propriedades

allOf

NomeTipoObrigatórioRestriçõesDescrição
anonymousWebV1SuccessResponsefalsenenhumnone

and

NomeTipoObrigatórioRestriçõesDescrição
anonymousobjectfalsenenhumnone
» dataTeamfalsenenhumnone

TeamListResponse

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "id": "A1b2C3d4E5f6",
        "name": "string",
        "super_admin_user_id": 1,
        "status": 0,
        "current_role": 1,
        "dissolving_at": "string",
        "dissolved_at": "string",
        "created_at": "string",
        "updated_at": "string"
      }
    ],
    "total": 0,
    "page": 1,
    "page_size": 1
  },
  "request_id": "string"
}

Propriedades

allOf

NomeTipoObrigatórioRestriçõesDescrição
anonymousWebV1SuccessResponsefalsenenhumnone

and

NomeTipoObrigatórioRestriçõesDescrição
anonymousobjectfalsenenhumnone
» dataobjectfalsenenhumnone
»» list[Team]truenenhumnone
»» totalintegertruenenhumnone
»» pageintegertruenenhumnone
»» page_sizeintegertruenenhumnone

TeamMemberListResponse

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "team_member_id": 1,
        "team_id": "A1b2C3d4E5f6",
        "user_id": 1,
        "role": 1,
        "status": 0,
        "joined_at": "string",
        "nickname": "string",
        "username": "string"
      }
    ],
    "total": 0,
    "page": 1,
    "page_size": 1
  },
  "request_id": "string"
}

Propriedades

allOf

NomeTipoObrigatórioRestriçõesDescrição
anonymousWebV1SuccessResponsefalsenenhumnone

and

NomeTipoObrigatórioRestriçõesDescrição
anonymousobjectfalsenenhumnone
» dataobjectfalsenenhumnone
»» list[TeamMember]truenenhumnone
»» totalintegertruenenhumnone
»» pageintegertruenenhumnone
»» page_sizeintegertruenenhumnone

TeamPersonListResponse

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "record_type": "member",
        "record_id": 1,
        "team_id": "A1b2C3d4E5f6",
        "user_id": 0,
        "inviter_user_id": 0,
        "invite_type": 0,
        "invite_country_code": 999,
        "invite_target": "string",
        "delivery_type": 0,
        "role": 1,
        "status": 0,
        "display_name": "string",
        "nickname": "string",
        "username": "string",
        "email": "string",
        "phone": "string",
        "joined_at": "string",
        "expired_at": "string",
        "created_at": "string"
      }
    ],
    "total": 0,
    "page": 1,
    "page_size": 1
  },
  "request_id": "string"
}

Propriedades

allOf

NomeTipoObrigatórioRestriçõesDescrição
anonymousWebV1SuccessResponsefalsenenhumnone

and

NomeTipoObrigatórioRestriçõesDescrição
anonymousobjectfalsenenhumnone
» dataobjectfalsenenhumnone
»» list[TeamPerson]truenenhumnone
»» totalintegertruenenhumnone
»» pageintegertruenenhumnone
»» page_sizeintegertruenenhumnone

TeamAssetResponse

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "id": 1,
    "user_id": 1,
    "team_id": "A1b2C3d4E5f6",
    "team_user_id": 0,
    "product_id": 1,
    "product_type": 0,
    "parent_product_type": 0,
    "status": 0,
    "total_amount": 0,
    "remain": 0,
    "bandwidth": 0,
    "concurrency": 0,
    "expired_at": "string",
    "created_at": "string",
    "ip": "string",
    "country_code": "string",
    "country_name": "string",
    "asn": "string",
    "port": 0
  },
  "request_id": "string"
}

Propriedades

allOf

NomeTipoObrigatórioRestriçõesDescrição
anonymousWebV1SuccessResponsefalsenenhumnone

and

NomeTipoObrigatórioRestriçõesDescrição
anonymousobjectfalsenenhumnone
» dataTeamAssetfalsenenhumnone

TeamProductInfoResponse

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "team_id": "A1b2C3d4E5f6",
    "product_types": [
      0
    ],
    "product_residence_remain_count": 0,
    "product_residence_total_count": 0,
    "pdrue2_timestamp": 0,
    "remain": 0,
    "total_amount": 0,
    "scraping_remain": 0,
    "scraping_total_amount": 0,
    "scraping_timestamp": "string",
    "scraping_timestamp2": 0,
    "common_scraping_remain": 0,
    "common_scraping_total_amount": 0,
    "common_scraping_timestamp": "string",
    "common_scraping_timestamp2": 0,
    "pdidcr_count": 0,
    "pdidcr_total": 0,
    "pdidcr_traffic_remain": 0,
    "pdidcr_traffic_total": 0,
    "p_sitai_ip_count": 0,
    "p_sitai_ip": 0,
    "p_sitai_ip_total": 0,
    "p_sitai_remain": 0,
    "p_sitai_total": 0,
    "pdidc_count": 0,
    "pdidc_total": 0,
    "pdidc_ip_count": 0,
    "pdidc_ip_all_count": 0,
    "pdispr_count": 0,
    "pdispr_total": 0,
    "pdispr_traffic_remain": 0,
    "pdispr_traffic_total": 0,
    "product_datacenter_isp_traffic_ip_count": 0,
    "product_datacenter_isp_traffc_ip": 0,
    "product_datacenter_isp_traffc_ip_total": 0,
    "product_datacenter_isp_traffic_ip": 0,
    "product_datacenter_isp_traffic_ip_total": 0,
    "product_datacenter_isp_traffc_remain": 0,
    "product_datacenter_isp_traffc_total": 0,
    "product_datacenter_isp_traffic_remain": 0,
    "product_datacenter_isp_traffic_total": 0,
    "product_datacenter_isp_ip": 0,
    "product_datacenter_isp_ip_total": 0,
    "product_datacenter_isp_ip_count": 0,
    "product_datacenter_isp_ip_all_count": 0,
    "product_datacenter_isp_ip_traffic_remain": 0,
    "product_datacenter_isp_ip_traffic_total": 0,
    "product_agent_residence_remain_count": 0,
    "product_agent_residence_total_count": 0,
    "product_serp_remain": 0,
    "product_serp_total": 0,
    "product_serp_timestamp": "string",
    "product_serp_timestamp2": 0,
    "product_video_remain": 0,
    "product_video_total": 0,
    "product_video_timestamp": "string",
    "product_video_timestamp2": 0
  },
  "request_id": "string"
}

Propriedades

allOf

NomeTipoObrigatórioRestriçõesDescrição
anonymousWebV1SuccessResponsefalsenenhumnone

and

NomeTipoObrigatórioRestriçõesDescrição
anonymousobjectfalsenenhumnone
» dataTeamProductInfofalsenenhumOs campos estatísticos do pacote são consistentes com /web_v1/user/info; registros de cancelamento, reembolso ou exclusão reversível não são incluídos no resumo; exceto team_id e product_types, apenas os campos correspondentes aos tipos de produtos suportados pelo site atual são retornados

TeamWalletResponse

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "team_id": "A1b2C3d4E5f6",
    "balance": 0.1,
    "total_recharge_fee": 0.1,
    "updated_at": "string"
  },
  "request_id": "string"
}

Propriedades

allOf

NomeTipoObrigatórioRestriçõesDescrição
anonymousWebV1SuccessResponsefalsenenhumnone

and

NomeTipoObrigatórioRestriçõesDescrição
anonymousobjectfalsenenhumnone
» dataTeamWalletfalsenenhumCarteira de equipe, isolada do saldo pessoal do superadministrador; o valor usa a moeda padrão do site atual, com até 4 casas decimais.

TeamWalletRecordListResponse

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "id": 1,
        "team_id": "A1b2C3d4E5f6",
        "operator_user_id": 0,
        "creator": {
          "user_id": 0,
          "display_name": "string",
          "nickname": "string",
          "username": "string",
          "email": "string",
          "phone": "string"
        },
        "direction": 0,
        "transaction_type": 1,
        "amount": 0.1,
        "after_balance": 0.1,
        "link_id": 0,
        "request_id": "string",
        "remark": "string",
        "created_at": "string"
      }
    ],
    "total": 0,
    "page": 1,
    "page_size": 1
  },
  "request_id": "string"
}

Propriedades

allOf

NomeTipoObrigatórioRestriçõesDescrição
anonymousWebV1SuccessResponsefalsenenhumnone

and

NomeTipoObrigatórioRestriçõesDescrição
anonymousobjectfalsenenhumnone
» dataobjectfalsenenhumnone
»» list[TeamWalletRecord]truenenhumnone
»» totalintegertruenenhumnone
»» pageintegertruenenhumnone
»» page_sizeintegertruenenhumnone

TeamAssetListResponse

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "id": 1,
        "user_id": 1,
        "team_id": "A1b2C3d4E5f6",
        "team_user_id": 0,
        "product_id": 1,
        "product_type": 0,
        "parent_product_type": 0,
        "status": 0,
        "total_amount": 0,
        "remain": 0,
        "bandwidth": 0,
        "concurrency": 0,
        "expired_at": "string",
        "created_at": "string",
        "ip": "string",
        "country_code": "string",
        "country_name": "string",
        "asn": "string",
        "port": 0
      }
    ],
    "total": 0,
    "page": 1,
    "page_size": 1
  },
  "request_id": "string"
}

Propriedades

allOf

NomeTipoObrigatórioRestriçõesDescrição
anonymousWebV1SuccessResponsefalsenenhumnone

and

NomeTipoObrigatórioRestriçõesDescrição
anonymousobjectfalsenenhumnone
» dataobjectfalsenenhumnone
»» list[TeamAsset]truenenhumnone
»» totalintegertruenenhumnone
»» pageintegertruenenhumnone
»» page_sizeintegertruenenhumnone

UserApiKeyMetadata

{
  "id": 1,
  "api_key": "string",
  "team_user_id": 0,
  "remark": "string",
  "status": 0,
  "created_at": "string",
  "updated_at": "string"
}

Propriedades

NomeTipoObrigatórioRestriçõesDescrição
idintegertruenenhumAPI Key ID
api_keystringtruenenhumA resposta da criação é a Chave completa; a lista da equipe é o valor mascarado
team_user_idintegertruenenhumA chave da equipe, na verdade, contém o ID do membro e a chave pessoal é 0
remarkstringtruenenhumObservações
statusintegertruenenhum0=desativar, 1=ativar
created_atstringtruenenhumhora de criação
updated_atstring,nullfalsenenhumHora de atualização

Valores enumerados

PropriedadeValor
status0
status1

InvoiceInfo

{
  "invoice_code": "string",
  "name": "string",
  "org_name": "string",
  "first_name": "string",
  "last_name": "string",
  "phone": "string",
  "email": "[email protected]",
  "role_type": 1,
  "invoice_type": 0,
  "vat_id": "string",
  "tax_no": "string",
  "address_country": "string",
  "address_city": "string",
  "address_line1": "string",
  "address_line2": "string",
  "address_postal_code": "string",
  "bank_name": "string",
  "bank_account": "string",
  "is_def": true
}

Propriedades

NomeTipoObrigatórioRestriçõesDescrição
invoice_codestringfalsenenhumnone
namestringfalsenenhumnone
org_namestringfalsenenhumnone
first_namestringfalsenenhumnone
last_namestringfalsenenhumnone
phonestringfalsenenhumnone
emailstring(email)falsenenhumnone
role_typeintegerfalsenenhumnone
invoice_typeintegerfalsenenhumnone
vat_idstringfalsenenhumnone
tax_nostringfalsenenhumnone
address_countrystringfalsenenhumnone
address_citystringfalsenenhumnone
address_line1stringfalsenenhumnone
address_line2stringfalsenenhumnone
address_postal_codestringfalsenenhumnone
bank_namestringfalsenenhumnone
bank_accountstringfalsenenhumnone
is_defbooleanfalsenenhumnone

Valores enumerados

PropriedadeValor
role_type1
role_type2
invoice_type0
invoice_type1
invoice_type2

MonthlyRenewalRequest

{
  "team_id": "A1b2C3d4E5f6",
  "user_product_ids": [
    1
  ],
  "user_coupon_id": 1,
  "coupon_sn": "string"
}

Propriedades

NomeTipoObrigatórioRestriçõesDescrição
team_idResourceSpaceIdfalsenenhumIdentificação do espaço de recursos públicos; omita team_id ou passe uma string vazia ao solicitar um espaço pessoal e uma string vazia ao responder a um espaço pessoal; tanto o número 0 quanto a string "0" são ilegais, e o espaço da equipe usa uma identificação pública da equipe de 6 a 12 dígitos
user_product_idsanytruenenhumMatriz de ID do plano do usuário, também compatível com strings separadas por vírgula em inglês

oneOf

NomeTipoObrigatórioRestriçõesDescrição
» anonymous[integer]falsenenhumnone

xor

NomeTipoObrigatórioRestriçõesDescrição
» anonymousstringfalsenenhumnone

continued

NomeTipoObrigatórioRestriçõesDescrição
user_coupon_idintegerfalsenenhumnone
coupon_snstringfalsenenhumnone

TeamInvitation

{
  "id": 1,
  "team_id": "A1b2C3d4E5f6",
  "inviter_user_id": 1,
  "invitee_user_id": 0,
  "invite_type": 1,
  "invite_country_code": 999,
  "invite_target": "string",
  "delivery_type": 1,
  "role": 2,
  "status": 0,
  "accepted_by_user_id": 0,
  "expired_at": "2026-07-17 10:00:00",
  "accepted_at": null,
  "rejected_at": null,
  "cancelled_at": null,
  "created_at": "2026-07-10 10:00:00"
}

Propriedades

NomeTipoObrigatórioRestriçõesDescrição
idintegertruenenhumID do convite
team_idTeamPublicIdtruenenhumLogotipo público da equipe, o primeiro caractere é uma letra ASCII e os demais caracteres contêm apenas letras e números ASCII; a chave primária numérica do banco de dados não foi emitida
inviter_user_idintegertruenenhumID do usuário convidador
invitee_user_idintegertruenenhumID do usuário convidado, 0 se nenhum usuário registrado tiver sido correspondido ainda
invite_typeintegertruenenhumTipo de convite: 1=usuário registrado, 2=e-mail, 3=número de celular
invite_country_codeintegertruenenhumCódigo do país ou área do número de telefone celular, 0 para convites para números de telefone que não sejam de celular
invite_targetstringtruenenhumAlvo de convite padronizado; o usuário registrado é o usuário:{user_id}
delivery_typeintegertruenenhumCanal de entrega original: 1=usuário cadastrado, 2=e-mail, 3=número de celular; o canal original será mantido quando o e-mail ou número de celular corresponder a um usuário registrado
roleintegertruenenhumFunção alvo: 2=administrador, 3=membro comum
statusintegertruenenhumStatus do convite: 0=pendente, 1=aceito, 2=rejeitado, 3=cancelado, 4=expirado
accepted_by_user_idintegertruenenhumID do usuário aceitante, 0 se não for aceito
expired_atstringtruenenhumTempo de expiração, formato AAAA-MM-DD HH:mm:ss
accepted_atstring,nulltruenenhumTempo de aceitação
rejected_atstring,nulltruenenhumtempo de rejeição
cancelled_atstring,nulltruenenhumTempo de cancelamento
created_atstringtruenenhumHora de criação, formato AAAA-MM-DD HH:mm:ss

Valores enumerados

PropriedadeValor
invite_type1
invite_type2
invite_type3
delivery_type1
delivery_type2
delivery_type3
role2
role3
status0
status1
status2
status3
status4

TeamMember

{
  "team_member_id": 1,
  "team_id": "A1b2C3d4E5f6",
  "user_id": 1,
  "role": 1,
  "status": 0,
  "joined_at": "string",
  "nickname": "string",
  "username": "string"
}

Propriedades

NomeTipoObrigatórioRestriçõesDescrição
team_member_idintegertruenenhumID de membro
team_idTeamPublicIdtruenenhumLogotipo público da equipe, o primeiro caractere é uma letra ASCII e os demais caracteres contêm apenas letras e números ASCII; a chave primária numérica do banco de dados não foi emitida
user_idintegertruenenhumID de usuário membro
roleintegertruenenhumFunção: 1=superadministrador, 2=administrador, 3=membro comum, 4=membro financeiro
statusintegertruenenhumStatus do membro: 0=desativado, 1=válido, 2=saído, 3=removido
joined_atstring,nulltruenenhumHora de adesão, formato AAAA-MM-DD HH:mm:ss
nicknamestringtruenenhumApelido do membro
usernamestringtruenenhumNome de usuário do membro

Valores enumerados

PropriedadeValor
role1
role2
role3
role4
status0
status1
status2
status3

TeamPerson

{
  "record_type": "member",
  "record_id": 1,
  "team_id": "A1b2C3d4E5f6",
  "user_id": 0,
  "inviter_user_id": 0,
  "invite_type": 0,
  "invite_country_code": 999,
  "invite_target": "string",
  "delivery_type": 0,
  "role": 1,
  "status": 0,
  "display_name": "string",
  "nickname": "string",
  "username": "string",
  "email": "string",
  "phone": "string",
  "joined_at": "string",
  "expired_at": "string",
  "created_at": "string"
}

Propriedades

NomeTipoObrigatórioRestriçõesDescrição
record_typestringtruenenhumTipo de registro; membro é um membro válido, o convite é um convite pendente
record_idintegertruenenhumID de associação ou ID de convite
team_idTeamPublicIdtruenenhumLogotipo público da equipe, o primeiro caractere é uma letra ASCII e os demais caracteres contêm apenas letras e números ASCII; a chave primária numérica do banco de dados não foi emitida
user_idintegertruenenhumID do usuário, usuários convidados não registrados são 0
inviter_user_idintegertruenenhumID do usuário convidador, registro de membro é 0
invite_typeintegertruenenhumTipo de convite, registro de membro é 0
invite_country_codeintegertruenenhumPaís ou código de área do número de celular, registro de membro é 0
invite_targetstringtruenenhumDestino do convite, registro de membro é uma string vazia
delivery_typeintegertruenenhumCanal de entrega original, registro de membro é 0
roleintegertruenenhumFunção: 1=superadministrador, 2=administrador, 3=membro comum, 4=membro financeiro
statusintegertruenenhummembro é fixado em 1, convite é fixado em 0
display_namestringtruenenhumExibir o nome de maneira uniforme, ordenando o apelido, nome de usuário, e-mail e número de celular; usar valores insensíveis para informações de contato da perspectiva de membros comuns
nicknamestringtruenenhumApelido do membro ou usuário convidado registrado
usernamestringtruenenhumMembro ou nome de usuário convidado registrado
emailstringtruenenhumE-mail; superadministradores e administradores retornam valores completos, membros comuns retornam valores de dessensibilização com asteriscos
phonestringtruenenhumNúmero de telemóvel; superadministradores e administradores retornam o valor completo, e membros comuns retornam o valor insensível com um asterisco.
joined_atstring,nulltruenenhumHora de adesão do membro, o registro do convite é nulo
expired_atstring,nulltruenenhumPrazo de expiração do convite, o registro do membro é nulo
created_atstringtruenenhumHora de criação do registro, formato AAAA-MM-DD HH:mm:ss

Valores enumerados

PropriedadeValor
record_typemember
record_typeinvitation
invite_type0
invite_type1
invite_type2
invite_type3
delivery_type0
delivery_type1
delivery_type2
delivery_type3
role1
role2
role3
role4
status0
status1

TeamInvitationResponse

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "id": 1,
    "team_id": "A1b2C3d4E5f6",
    "inviter_user_id": 1,
    "invitee_user_id": 0,
    "invite_type": 1,
    "invite_country_code": 999,
    "invite_target": "string",
    "delivery_type": 1,
    "role": 2,
    "status": 0,
    "accepted_by_user_id": 0,
    "expired_at": "2026-07-17 10:00:00",
    "accepted_at": null,
    "rejected_at": null,
    "cancelled_at": null,
    "created_at": "2026-07-10 10:00:00"
  },
  "request_id": "string"
}

Propriedades

allOf

NomeTipoObrigatórioRestriçõesDescrição
anonymousWebV1SuccessResponsefalsenenhumnone

and

NomeTipoObrigatórioRestriçõesDescrição
anonymousobjectfalsenenhumnone
» dataTeamInvitationfalsenenhumnone

TeamMemberResponse

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "team_member_id": 1,
    "team_id": "A1b2C3d4E5f6",
    "user_id": 1,
    "role": 1,
    "status": 0,
    "joined_at": "string",
    "nickname": "string",
    "username": "string"
  },
  "request_id": "string"
}

Propriedades

allOf

NomeTipoObrigatórioRestriçõesDescrição
anonymousWebV1SuccessResponsefalsenenhumnone

and

NomeTipoObrigatórioRestriçõesDescrição
anonymousobjectfalsenenhumnone
» dataTeamMemberfalsenenhumnone

TeamInvitationCreateResponse

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "invitation": {
      "id": 1,
      "team_id": "A1b2C3d4E5f6",
      "inviter_user_id": 1,
      "invitee_user_id": 0,
      "invite_type": 1,
      "invite_country_code": 999,
      "invite_target": "string",
      "delivery_type": 1,
      "role": 2,
      "status": 0,
      "accepted_by_user_id": 0,
      "expired_at": "2026-07-17 10:00:00",
      "accepted_at": null,
      "rejected_at": null,
      "cancelled_at": null,
      "created_at": "2026-07-10 10:00:00"
    },
    "invitation_token": "string",
    "invitation_url": "http://example.com",
    "notification_channels": {
      "email": "queued",
      "sms": "queued",
      "site_inner_message": "created"
    }
  },
  "request_id": "string"
}

Propriedades

allOf

NomeTipoObrigatórioRestriçõesDescrição
anonymousWebV1SuccessResponsefalsenenhumnone

and

NomeTipoObrigatórioRestriçõesDescrição
anonymousobjectfalsenenhumnone
» dataobjectfalsenenhumnone
»» invitationTeamInvitationtruenenhumnone
»» invitation_tokenstringtruenenhumToken de convite em texto simples, reservado apenas para clientes existentes compatíveis; novos clientes usam Invitation_url diretamente
»» invitation_urlstring(uri)truenenhumLink de processamento de front-end contendo token de convite
»» notification_channelsTeamInvitationNotificationChannelstruenenhumnone

TeamInvitationNotificationChannels

{
  "email": "queued",
  "sms": "queued",
  "site_inner_message": "created"
}

Propriedades

NomeTipoObrigatórioRestriçõesDescrição
emailstringfalsenenhumResultados do canal de e-mail
smsstringfalsenenhumResultados do canal SMS
site_inner_messagestringfalsenenhumResultados do canal de mensagens do site

Valores enumerados

PropriedadeValor
emailqueued
emailfailed
emailskipped
smsqueued
smsfailed
smsskipped
site_inner_messagecreated
site_inner_messageexists
site_inner_messagefailed

TeamInvitationPreviewResponse

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "team_name": "string",
    "role": 2,
    "status": 0,
    "expired_at": "string"
  },
  "request_id": "string"
}

Propriedades

allOf

NomeTipoObrigatórioRestriçõesDescrição
anonymousWebV1SuccessResponsefalsenenhumnone

and

NomeTipoObrigatórioRestriçõesDescrição
anonymousobjectfalsenenhumnone
» dataobjectfalsenenhumnone
»» team_namestringtruenenhumNome da equipe
»» roleintegertruenenhumfunção alvo
»» statusintegertruenenhumstatus do convite
»» expired_atstringtruenenhumTempo de expiração, formato AAAA-MM-DD HH:mm:ss

Valores enumerados

PropriedadeValor
role2
role3
status0
status1
status2
status3
status4

TeamInvitationResendResponse

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "invitation": {
      "id": 1,
      "team_id": "A1b2C3d4E5f6",
      "inviter_user_id": 1,
      "invitee_user_id": 0,
      "invite_type": 1,
      "invite_country_code": 999,
      "invite_target": "string",
      "delivery_type": 1,
      "role": 2,
      "status": 0,
      "accepted_by_user_id": 0,
      "expired_at": "2026-07-17 10:00:00",
      "accepted_at": null,
      "rejected_at": null,
      "cancelled_at": null,
      "created_at": "2026-07-10 10:00:00"
    },
    "invitation_url": "http://example.com",
    "notification_channels": {
      "email": "queued",
      "sms": "queued",
      "site_inner_message": "created"
    }
  },
  "request_id": "string"
}

Propriedades

allOf

NomeTipoObrigatórioRestriçõesDescrição
anonymousWebV1SuccessResponsefalsenenhumnone

and

NomeTipoObrigatórioRestriçõesDescrição
anonymousobjectfalsenenhumnone
» dataobjectfalsenenhumnone
»» invitationTeamInvitationtruenenhumnone
»» invitation_urlstring(uri)truenenhumNovo link de processamento de convites; link antigo não funciona mais
»» notification_channelsTeamInvitationNotificationChannelstruenenhumnone

TeamInvitationListResponse

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "id": 1,
        "team_id": "A1b2C3d4E5f6",
        "inviter_user_id": 1,
        "invitee_user_id": 0,
        "invite_type": 1,
        "invite_country_code": 999,
        "invite_target": "string",
        "delivery_type": 1,
        "role": 2,
        "status": 0,
        "accepted_by_user_id": 0,
        "expired_at": "2026-07-17 10:00:00",
        "accepted_at": null,
        "rejected_at": null,
        "cancelled_at": null,
        "created_at": "2026-07-10 10:00:00"
      }
    ],
    "total": 0,
    "page": 1,
    "page_size": 1
  },
  "request_id": "string"
}

Propriedades

allOf

NomeTipoObrigatórioRestriçõesDescrição
anonymousWebV1SuccessResponsefalsenenhumnone

and

NomeTipoObrigatórioRestriçõesDescrição
anonymousobjectfalsenenhumnone
» dataobjectfalsenenhumnone
»» list[TeamInvitation]truenenhumnone
»» totalintegertruenenhumnúmero total de convites
»» pageintegertruenenhumNúmero da página atual
»» page_sizeintegertruenenhumnúmero real por página

User

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

Propriedades

NomeTipoObrigatórioRestriçõesDescrição
idintegerfalsenenhumnone
emailstring(email)falsenenhumnone
phonestringfalsenenhumnone
balancenumber(float)falsenenhumnone
statusintegerfalsenenhumnone
is_real_namebooleanfalsenenhumnone
created_atstring(date-time)falsenenhumnone

Order

{
  "id": 0,
  "trade_no": "string",
  "out_trade_no": "string",
  "product_id": 0,
  "product_type": 0,
  "amount": 0,
  "unit_price": 0.1,
  "total_fee": 0.1,
  "goods_fee": 0.1,
  "pay_fee": 0.1,
  "discount_fee": 0.1,
  "handling_fee": 0.1,
  "refund_fee": 0.1,
  "pm_id": 0,
  "pm_title": "string",
  "pm_logo": "string",
  "status": 0,
  "title": "string",
  "detail": "string",
  "region_desc": "string",
  "pay_at": "2019-08-24T14:15:22Z",
  "pay_timestamp": 0,
  "created_at": "2019-08-24T14:15:22Z",
  "pay_fee_status": 0,
  "invoice": {
    "name": "string",
    "org_name": "string",
    "first_name": "string",
    "last_name": "string",
    "phone": "string",
    "email": "[email protected]",
    "role_type": 0,
    "vat_id": "string",
    "address_country": "string",
    "address_city": "string",
    "address_line1": "string",
    "address_line2": "string",
    "address_postal_code": "string"
  }
}

Propriedades

NomeTipoObrigatórioRestriçõesDescrição
idintegerfalsenenhumID do pedido
trade_nostringfalsenenhumNúmero de pedido interno
out_trade_nostringfalsenenhumNúmero de pedido externo
product_idintegerfalsenenhumID do pacote
product_typeintegerfalsenenhumTipo de pacote, consulte a enumeração do tipo de produto
amountintegerfalsenenhumQuantidade de compra
unit_pricenumber(float)falsenenhumpreço unitário
total_feenumber(float)falsenenhumPreço total do pedido (excluindo descontos e taxas de manuseio)
goods_feenumber(float)falsenenhumPreço do produto (incluindo descontos, excluindo taxas de manuseio)
pay_feenumber(float)falsenenhumValor real pago (incluindo descontos e taxas de manuseio)
discount_feenumber(float)falsenenhumValor do desconto
handling_feenumber(float)falsenenhumtaxa de manuseio
refund_feenumber(float)falsenenhumValor do reembolso
pm_idintegerfalsenenhumID da forma de pagamento (de /openapi/payment/list)
pm_titlestringfalsenenhumNome da forma de pagamento
pm_logostringfalsenenhumURL do logotipo da forma de pagamento
statusintegerfalsenenhumStatus do pedido
titlestringfalsenenhumTítulo do pacote
detailstringfalsenenhumDescrição do pacote
region_descstringfalsenenhumDescrição da especificação da região
pay_atstring(date-time)falsenenhumprazo de pagamento
pay_timestampintegerfalsenenhumData e hora do pagamento
created_atstring(date-time)falsenenhumhora de criação
pay_fee_statusintegerfalsenenhumStatus de pagamento longo e curto: 0 normal 1 pagamento longo (pagamento a maior) 2 pagamento curto
invoiceobjectfalsenenhumInformações da fatura (valiosas apenas para ordens de pagamento on-line)
» namestringfalsenenhumnome completo
» org_namestringfalsenenhumNome da empresa
» first_namestringfalsenenhumnone
» last_namestringfalsenenhumnone
» phonestringfalsenenhumnone
» emailstring(email)falsenenhumnone
» role_typeintegerfalsenenhum1 pessoa 2 empresas
» vat_idstringfalsenenhumNúmero de identificação fiscal
» address_countrystringfalsenenhumnone
» address_citystringfalsenenhumnone
» address_line1stringfalsenenhumnone
» address_line2stringfalsenenhumnone
» address_postal_codestringfalsenenhumnone

OrderCheckResult

{
  "product_id": 0,
  "amount": 0,
  "discount_fee": 0.1,
  "total_fee": 0.1,
  "pay_fee": 0.1,
  "product_type": 0,
  "title": "string",
  "detail": "string",
  "ip_result": [
    {
      "ip": "string",
      "price": 0.1,
      "country_code": "string",
      "current_time": "2019-08-24T14:15:22Z",
      "renewal_time": "2019-08-24T14:15:22Z",
      "country": {
        "name_zh_cn": "string",
        "flag": "string",
        "square_flag": "string"
      }
    }
  ]
}

Solicitar resultados de pré-verificação

Propriedades

NomeTipoObrigatórioRestriçõesDescrição
product_idintegerfalsenenhumID do pacote
amountintegerfalsenenhumQuantidade
discount_feenumber(float)falsenenhumValor do desconto
total_feenumber(float)falsenenhumTotal do pedido
pay_feenumber(float)falsenenhumValor real pago
product_typeintegerfalsenenhumTipo de pacote
titlestringfalsenenhumTítulo do pacote
detailstringfalsenenhumDescrição do pacote
ip_result[object]falsenenhumResultados de renovação em lote de IP (retornados somente durante a renovação de IP)
» ipstringfalsenenhumnone
» pricenumber(float)falsenenhumnone
» country_codestringfalsenenhumnone
» current_timestring(date-time)falsenenhumnone
» renewal_timestring(date-time)falsenenhumnone
» countryobjectfalsenenhumnone
»» name_zh_cnstringfalsenenhumnone
»» flagstringfalsenenhumURL do sinalizador do círculo
»» square_flagstringfalsenenhumURL da bandeira quadrada

Product

{
  "id": 0,
  "title": "string",
  "type": 0,
  "show_type": 0,
  "status": 0,
  "price": 0.1,
  "usd_price": 0.1,
  "price_hkd": 0.1,
  "original_price": 0.1,
  "original_usd_price": 0.1,
  "original_price_hkd": 0.1,
  "local_price": 0.1,
  "local_original_price": 0.1,
  "preferred_currency": "string",
  "support_currencies": "string",
  "flow_value": 0.1,
  "flow_give": 0.1,
  "balance_give": 0.1,
  "balance_value": 0.1,
  "time_validity": 0.1,
  "time_price": 0.1,
  "time_days": 0,
  "tip1": "string",
  "tip2": "string",
  "introduce": [
    "string"
  ],
  "region_list_id": 0,
  "renew_product_list": "string",
  "parent_product_type": 0,
  "total_count": 0,
  "remain_count": 0,
  "extension_of_time_days": [
    0
  ],
  "time_days_price_rate": 0.1,
  "desc": {
    "subtitle": "string",
    "flow_value": 0.1,
    "flow_give": 0.1,
    "balance_give": 0.1,
    "time_validity": 0.1,
    "time_price": 0.1,
    "tip1": "string",
    "tip2": "string",
    "introduce": [
      "string"
    ]
  },
  "sku": {
    "bandwidth_list": [
      {
        "id": 0,
        "value": 0,
        "price": 0.1,
        "price_usd": 0.1,
        "price_hkd": 0.1
      }
    ],
    "duration_list": [
      {
        "id": 0,
        "value": 0,
        "price": 0.1,
        "price_usd": 0.1,
        "price_hkd": 0.1
      }
    ],
    "concurrency_list": [
      {
        "id": 0,
        "value": 0,
        "price": 0.1,
        "price_usd": 0.1,
        "price_hkd": 0.1
      }
    ]
  }
}

Propriedades

NomeTipoObrigatórioRestriçõesDescrição
idintegerfalsenenhumID do pacote
titlestringfalsenenhumTítulo principal do pacote
typeintegerfalsenenhumTipo de pacote
show_typeintegerfalsenenhumTipo de exibição: 1 Normal 2 Grande recomendação 3 Não disponível para compra (precisa de personalização) 4 Avaliação
statusintegerfalsenenhumStatus: 1 nas prateleiras 0 fora das prateleiras
pricenumber(float)falsenenhumPreço em RMB
usd_pricenumber(float)falsenenhumpreço do dólar
price_hkdnumber(float)falsenenhumPreço do dólar de Hong Kong
original_pricenumber(float)falsenenhumPreço original (CNY)
original_usd_pricenumber(float)falsenenhumPreço original (USD)
original_price_hkdnumber(float)falsenenhumPreço original (HKD)
local_pricenumber(float)falsenenhumPreço localizado (depende deferred_currency)
local_original_pricenumber(float)falsenenhumPreço original localizado (depende deferred_currency)
preferred_currencystringfalsenenhumRecomenda-se exibir a moeda, como usd/cny/hkd
support_currenciesstringfalsenenhumLista de moedas suportadas, separadas por vírgulas, como usd,cny
flow_valuenumber(float)falsenenhumTráfego padrão do plano de dados (GB)
flow_givenumber(float)falsenenhumTráfego livre (GB)
balance_givenumber(float)falsenenhumBônus de recarga de saldo
balance_valuenumber(float)falsenenhumValor de recarga
time_validitynumber(float)falsenenhumO período de validade padrão dos planos padrão
time_pricenumber(float)falsenenhumPreço do pacote padrão por IP
time_daysintegerfalsenenhumNúmero de dias de validade, como 30/90/180/365
tip1stringfalsenenhumDescrição do rótulo 1
tip2stringfalsenenhumDescrição do rótulo 2
introduce[string]falsenenhumLista de introdução de texto
region_list_idintegerfalsenenhumID da região
renew_product_liststringfalsenenhumLista de IDs de pacotes renováveis (separados por vírgula)
parent_product_typeintegerfalsenenhumTipo de pacote pai (válido quando type=19): 14 ou 25
total_countintegerfalsenenhumEstoque total, 0 significa sem limite
remain_countintegerfalsenenhumestoque restante
extension_of_time_days[integer]falsenenhumLista de múltiplos de duração. Se estiver vazio ou contiver apenas 1, significa que não é compatível.
time_days_price_ratenumber(float)falsenenhumCoeficiente de preço de duração, preço × (1 + (múltiplo-1) × taxa)
descobjectfalsenenhumInformações de descrição do pacote
» subtitlestringfalsenenhumlegenda
» flow_valuenumber(float)falsenenhumnone
» flow_givenumber(float)falsenenhumnone
» balance_givenumber(float)falsenenhumnone
» time_validitynumber(float)falsenenhumnone
» time_pricenumber(float)falsenenhumnone
» tip1stringfalsenenhumnone
» tip2stringfalsenenhumnone
» introduce[string]falsenenhumnone
skuobjectfalsenenhumParâmetros de especificação (retornados quando type=11)
» bandwidth_list[object]falsenenhumLista de especificações de largura de banda
»» idintegerfalsenenhumnone
»» valueintegerfalsenenhumValor de largura de banda (Mbps)
»» pricenumber(float)falsenenhumnone
»» price_usdnumber(float)falsenenhumnone
»» price_hkdnumber(float)falsenenhumnone
» duration_list[object]falsenenhumLista de especificações de duração
»» idintegerfalsenenhumnone
»» valueintegerfalsenenhumDuração (dias)
»» pricenumber(float)falsenenhumnone
»» price_usdnumber(float)falsenenhumnone
»» price_hkdnumber(float)falsenenhumnone
» concurrency_list[object]falsenenhumLista de especificações de simultaneidade
»» idintegerfalsenenhumnone
»» valueintegerfalsenenhumNúmero de simultaneidades
»» pricenumber(float)falsenenhumnone
»» price_usdnumber(float)falsenenhumnone
»» price_hkdnumber(float)falsenenhumnone

WhiteIp

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

Propriedades

NomeTipoObrigatórioRestriçõesDescrição
idintegerfalsenenhumnone
ipstringfalsenenhumnone
remarkstringfalsenenhumnone
created_atstring(date-time)falsenenhumnone

WhitelistAccount

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

Propriedades

NomeTipoObrigatórioRestriçõesDescrição
idintegerfalsenenhumnone
usernamestringfalsenenhumnone
limitintegerfalsenenhumnone
usedintegerfalsenenhumnone
statusintegerfalsenenhumnone

Coupon

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

Propriedades

NomeTipoObrigatórioRestriçõesDescrição
idintegerfalsenenhumnone
namestringfalsenenhumnone
codestringfalsenenhumnone
discountnumber(float)falsenenhumnone
expire_timestring(date-time)falsenenhumnone

Article

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

Propriedades

NomeTipoObrigatórioRestriçõesDescrição
idintegerfalsenenhumnone
titlestringfalsenenhumnone
contentstringfalsenenhumnone
created_atstring(date-time)falsenenhumnone

Pagination

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

Propriedades

NomeTipoObrigatórioRestriçõesDescrição
totalintegerfalsenenhumnone
page_nointegerfalsenenhumnone
page_sizeintegerfalsenenhumnone
total_pagesintegerfalsenenhumnone

AutoRenewalConfig

{
  "id": 1,
  "user_id": 1,
  "team_id": "A1b2C3d4E5f6",
  "team_user_id": 0,
  "product_type": 0,
  "left_traffic": 0,
  "left_days": 0,
  "user_product_id": 1,
  "product_id": 0,
  "status": 0,
  "currency": "string",
  "agreed_price": 0,
  "agreed_bandwidth_price": 0,
  "agreed_concurrency_price": 0,
  "bandwidth_id": 0,
  "concurrency_id": 0,
  "duration": 0,
  "renew_product_id": 0,
  "days_before_expire": 0,
  "traffic_threshold": 0,
  "parent_product_type": 0,
  "created_at": "string",
  "updated_at": "string"
}

Instantâneo de configuração de renovação automática de um único pacote

Propriedades

NomeTipoObrigatórioRestriçõesDescrição
idintegerfalsenenhumnone
user_idintegerfalsenenhumnone
team_idResourceSpaceIdfalsenenhumIdentificação do espaço de recursos públicos; omita team_id ou passe uma string vazia ao solicitar um espaço pessoal e uma string vazia ao responder a um espaço pessoal; tanto o número 0 quanto a string "0" são ilegais, e o espaço da equipe usa uma identificação pública da equipe de 6 a 12 dígitos
team_user_idintegerfalsenenhumnone
product_typeintegerfalsenenhumnone
left_trafficintegerfalsenenhumCampo obsoleto
left_daysintegerfalsenenhumCampo obsoleto
user_product_idintegerfalsenenhumnone
product_idintegerfalsenenhumCampo obsoleto
statusintegerfalsenenhum0=desativar, 1=ativar
currencystringfalsenenhumnone
agreed_pricenumberfalsenenhumPreço total acordado
agreed_bandwidth_pricenumberfalsenenhumPreço unitário de largura de banda acordado para o Pacote 11
agreed_concurrency_pricenumberfalsenenhumPreço unitário simultâneo acordado para o Pacote 11
bandwidth_idintegerfalsenenhumnone
concurrency_idintegerfalsenenhumnone
durationintegerfalsenenhumTempo de renovação, dia da unidade
renew_product_idintegerfalsenenhumnone
days_before_expireintegerfalsenenhumnone
traffic_thresholdintegerfalsenenhumLimite de tráfego, unidade de valor do banco de dados KB
parent_product_typeintegerfalsenenhumnone
created_atstringfalsenenhumnone
updated_atstringfalsenenhumnone

Valores enumerados

PropriedadeValor
status0
status1

AutoRenewalLog

{
  "id": 1,
  "user_id": 1,
  "team_id": "A1b2C3d4E5f6",
  "team_user_id": 0,
  "config_id": 0,
  "user_product_id": 1,
  "product_type": 0,
  "renew_product_id": 0,
  "order_id": 0,
  "fee": 0,
  "currency": "string",
  "before_expired_at": "string",
  "after_expired_at": "string",
  "before_remain": 0,
  "after_remain": 0,
  "trigger_type": 0,
  "status": 1,
  "revoke_at": "string",
  "revoke_remark": "string",
  "created_at": "string",
  "updated_at": "string"
}

Propriedades

NomeTipoObrigatórioRestriçõesDescrição
idintegertruenenhumnone
user_idintegertruenenhumnone
team_idResourceSpaceIdtruenenhumIdentificação do espaço de recursos públicos; omita team_id ou passe uma string vazia ao solicitar um espaço pessoal e uma string vazia ao responder a um espaço pessoal; tanto o número 0 quanto a string "0" são ilegais, e o espaço da equipe usa uma identificação pública da equipe de 6 a 12 dígitos
team_user_idintegertruenenhumnone
config_idintegertruenenhumnone
user_product_idintegertruenenhumnone
product_typeintegertruenenhumnone
renew_product_idintegertruenenhumnone
order_idintegertruenenhumnone
feenumbertruenenhumnone
currencystringtruenenhumnone
before_expired_atstring,nullfalsenenhumnone
after_expired_atstring,nullfalsenenhumnone
before_remaininteger(int64)truenenhumnone
after_remaininteger(int64)truenenhumnone
trigger_typeintegertruenenhum0=Antes da expiração, 1=Tráfego insuficiente
statusintegertruenenhum1=sucesso, 2=revogado, 3=falhou
revoke_atstring,nullfalsenenhumnone
revoke_remarkstringtruenenhumnone
created_atstringtruenenhumnone
updated_atstringtruenenhumnone

Valores enumerados

PropriedadeValor
trigger_type0
trigger_type1
status1
status2
status3

MonthlyRenewalBatch

{
  "type": "current",
  "start_at": "string",
  "end_at": "string",
  "target_expired_at": "string",
  "timezone": "string"
}

Propriedades

NomeTipoObrigatórioRestriçõesDescrição
typestringtruenenhumnone
start_atstringtruenenhumnone
end_atstringtruenenhumnone
target_expired_atstringtruenenhumnone
timezonestringtruenenhumnone

Valores enumerados

PropriedadeValor
typecurrent
typenext

MonthlyRenewalItem

{
  "id": 0,
  "user_product_id": 1,
  "product_id": 1,
  "product_type": 0,
  "parent_product_type": 0,
  "title": "string",
  "expired_at": "string",
  "target_expired_at": "string",
  "renew_days": 1,
  "unit_month_price": 0,
  "pay_fee": 0,
  "currency": "string",
  "bandwidth": 0,
  "bandwidth_mbsp": 0,
  "concurrency": 0,
  "ip": "string",
  "country_code": "string",
  "paid_at": "string",
  "refunded_at": "string",
  "created_at": "string",
  "updated_at": "string"
}

Propriedades

NomeTipoObrigatórioRestriçõesDescrição
idintegerfalsenenhumID histórico de detalhes de faturamento
user_product_idintegertruenenhumnone
product_idintegertruenenhumnone
product_typeintegertruenenhumnone
parent_product_typeintegertruenenhumnone
titlestringtruenenhumnone
expired_atstringtruenenhumnone
target_expired_atstringtruenenhumnone
renew_daysintegertruenenhumnone
unit_month_pricenumberfalsenenhumnone
pay_feenumbertruenenhumnone
currencystringtruenenhumnone
bandwidthintegerfalsenenhumnone
bandwidth_mbspnumberfalsenenhumValor de conversão de largura de banda
concurrencyintegerfalsenenhumnone
ipstringfalsenenhumRetornos de pacote IP estático
country_codestringfalsenenhumRetornos de pacote IP estático
paid_atstring,nullfalsenenhumnone
refunded_atstring,nullfalsenenhumnone
created_atstringfalsenenhumnone
updated_atstringfalsenenhumnone

InvoiceRecord

{
  "id": 1,
  "invoice_no": "string",
  "invoice_amount": 0,
  "invoice_download_url": "string",
  "status": 0,
  "remark": "string",
  "order_ids": [
    0
  ],
  "created_at": 0,
  "invoice_info": {
    "invoice_code": "string",
    "name": "string",
    "org_name": "string",
    "role_type": 1,
    "invoice_type": 0
  }
}

Propriedades

NomeTipoObrigatórioRestriçõesDescrição
idintegertruenenhumnone
invoice_nostringtruenenhumnone
invoice_amountnumbertruenenhumnone
invoice_download_urlstringtruenenhumnone
statusintegertruenenhumnone
remarkstringtruenenhumnone
order_ids[integer]truenenhumnone
created_atintegertruenenhumCarimbo de data/hora Unix
invoice_infoanytruenenhumnone

oneOf

NomeTipoObrigatórioRestriçõesDescrição
» anonymousobjectfalsenenhumnone
»» invoice_codestringtruenenhumnone
»» namestringtruenenhumnone
»» org_namestringtruenenhumnone
»» role_typeintegertruenenhumnone
»» invoice_typeintegertruenenhumnone

xor

NomeTipoObrigatórioRestriçõesDescrição
» anonymousnullfalsenenhumnone

Valores enumerados

PropriedadeValor
role_type1
role_type2
invoice_type0
invoice_type1
invoice_type2

PayCheckData

{
  "trade_no": "string",
  "pm_id": 0,
  "pay_method": 0,
  "trade_type": "string",
  "country_code": "string",
  "currency": "string",
  "goods_fee": 0,
  "discount_fee": 0,
  "handling_fee": 0,
  "pay_fee": 0,
  "total_fee": 0,
  "pay_method_info": {
    "id": 0,
    "type": 0,
    "title": "string",
    "group": "string",
    "handling_rate": 0,
    "handling_fee": 0,
    "handling_fee_currency": "usd",
    "handling_fee_converted": 0
  },
  "origin": {
    "pm_id": 0,
    "pay_method": 0,
    "goods_fee": 0,
    "discount_fee": 0,
    "handling_fee": 0,
    "pay_fee": 0,
    "total_fee": 0
  }
}

Propriedades

NomeTipoObrigatórioRestriçõesDescrição
trade_nostringtruenenhumnone
pm_idintegertruenenhumnone
pay_methodintegertruenenhumnone
trade_typestringtruenenhumnone
country_codestringtruenenhumnone
currencystringtruenenhumnone
goods_feenumbertruenenhumnone
discount_feenumbertruenenhumnone
handling_feenumbertruenenhumnone
pay_feenumbertruenenhumnone
total_feenumbertruenenhumnone
pay_method_infoanytruenenhumnone

oneOf

NomeTipoObrigatórioRestriçõesDescrição
» anonymousobjectfalsenenhumnone
»» idintegertruenenhumnone
»» typeintegertruenenhumnone
»» titlestringtruenenhumnone
»» groupstringtruenenhumnone
»» handling_ratenumbertruenenhumnone
»» handling_feenumbertruenenhumnone
»» handling_fee_currencystringtruenenhumnone
»» handling_fee_convertednumbertruenenhumnone

xor

NomeTipoObrigatórioRestriçõesDescrição
» anonymousnullfalsenenhumnone

continued

NomeTipoObrigatórioRestriçõesDescrição
originobjecttruenenhumnone
» pm_idintegertruenenhumnone
» pay_methodintegertruenenhumnone
» goods_feenumbertruenenhumnone
» discount_feenumbertruenenhumnone
» handling_feenumbertruenenhumnone
» pay_feenumbertruenenhumnone
» total_feenumbertruenenhumnone