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:
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
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| team_id | query | ResourceSpaceId | false | Identificador 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
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | Solicitação bem-sucedida | Inline |
Esquema da resposta
Status Code 200
| Nome | Tipo | Obrigatório | Restrições | Descrição |
|---|---|---|---|---|
| » code | responseCode | false | nenhum | Código de status, 200 bem-sucedido, 3 app_key inválido |
| » msg | string | false | nenhum | mensagem de estado |
| » data | object | false | nenhum | none |
| »» list | [object] | false | nenhum | none |
| »»» id | integer | false | nenhum | Número da conta |
| »»» username | string | false | nenhum | Nome da conta do agente |
| »»» password | string | false | nenhum | Senha da conta do agente |
| »»» created_at | string | false | nenhum | Adicionar tempo |
| »»» remark | string | false | nenhum | Observações |
| »»» product_type | productTypes | false | nenhum | 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 |
| »»» usage_flow | integer | false | nenhum | Tráfego usado, unidade: KB |
| »»» limit_flow | integer | false | nenhum | Limite de tráfego personalizado: a unidade máxima de GB é 102.400, 0 não é limite |
| »»» status | integer | false | nenhum | Status ativado: 1 ativado, 0 desativado |
Valores enumerados
| Propriedade | Valor |
|---|---|
| product_type | 9 |
| product_type | 11 |
| product_type | 14 |
| product_type | 25 |
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
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| body | body | object | false | nenhum |
| » team_id | body | any | false | 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 |
| »» anonymous | body | string | false | nenhum |
| »» anonymous | body | TeamPublicId | false | 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 |
| » account | body | string | false | Passe 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
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | Solicitação bem-sucedida | Inline |
Esquema da resposta
Valores enumerados
| Propriedade | Valor |
|---|---|
| isAgent | 0 |
| isAgent | 1 |
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
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| team_id | query | ResourceSpaceId | false | Identificador 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
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | Solicitação bem-sucedida | Inline |
Esquema da resposta
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
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| body | body | object | false | nenhum |
| » team_id | body | any | false | 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 |
| »» anonymous | body | string | false | nenhum |
| »» anonymous | body | TeamPublicId | false | 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 |
| » app_key | body | string | false | Chave de autorização |
| » accounts | body | string | true | Senha 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 (,). |
| » remark | body | string | false | Descrição da conta do agente |
| » product_type | body | productTypes | false | 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 |
Valores enumerados
| Parameter | Value |
|---|---|
| » product_type | 9 |
| » product_type | 11 |
| » product_type | 14 |
| » product_type | 25 |
Exemplos de resposta
Resposta 200
{
"code": 200,
"msg": "string",
"data": null
}
Respostas
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | Solicitação bem-sucedida | Inline |
Esquema da resposta
Status Code 200
| Nome | Tipo | Obrigatório | Restrições | Descrição |
|---|---|---|---|---|
| » code | integer | false | nenhum | Código de status, 200 bem-sucedido, 3 app_key inválido, 156 conta não autenticada. |
| » msg | string | false | nenhum | mensagem de estado |
| » data | null | false | nenhum | none |
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
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| body | body | object | false | nenhum |
| » team_id | body | any | false | 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 |
| »» anonymous | body | string | false | nenhum |
| »» anonymous | body | TeamPublicId | false | 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 |
| » app_key | body | string | false | Chave de autorização |
| » accounts | body | string | true | Conta 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
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | Solicitação bem-sucedida | Inline |
Esquema da resposta
Status Code 200
| Nome | Tipo | Obrigatório | Restrições | Descrição |
|---|---|---|---|---|
| » code | integer | false | nenhum | Código de status, 200 bem-sucedido, 3 app_key inválido, 156 conta não autenticada. |
| » msg | string | false | nenhum | mensagem de estado |
| » data | null | false | nenhum | none |
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
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| body | body | object | false | nenhum |
| » team_id | body | any | false | 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 |
| »» anonymous | body | string | false | nenhum |
| »» anonymous | body | TeamPublicId | false | 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 |
| » app_key | body | string | false | Chave de autorização |
| » accounts | body | string | true | Conta 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
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | Solicitação bem-sucedida | Inline |
Esquema da resposta
Status Code 200
| Nome | Tipo | Obrigatório | Restrições | Descrição |
|---|---|---|---|---|
| » code | integer | false | nenhum | Código de status, 200 bem-sucedido, 3 app_key inválido, 156 conta não autenticada. |
| » msg | string | false | nenhum | mensagem de estado |
| » data | null | false | nenhum | none |
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
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| body | body | object | false | nenhum |
| » team_id | body | any | false | 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 |
| »» anonymous | body | string | false | nenhum |
| »» anonymous | body | TeamPublicId | false | 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 |
| » app_key | body | string | false | Chave de autorização |
| » accounts | body | string | true | Conta 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
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | Solicitação bem-sucedida | Inline |
Esquema da resposta
Status Code 200
| Nome | Tipo | Obrigatório | Restrições | Descrição |
|---|---|---|---|---|
| » code | integer | false | nenhum | Código de status, 200 bem-sucedido, 3 app_key inválido, 156 conta não autenticada. |
| » msg | string | false | nenhum | mensagem de estado |
| » data | null | false | nenhum | none |
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
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| body | body | object | false | nenhum |
| » team_id | body | any | false | 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 |
| »» anonymous | body | string | false | nenhum |
| »» anonymous | body | TeamPublicId | false | 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 |
| » app_key | body | string | false | Chave de autorização |
| » account | body | string | true | Conta de agente, apenas números e letras são suportados. |
| » password | body | string | true | A nova senha da conta do agente suporta apenas números e letras. |
Exemplos de resposta
Resposta 200
{
"code": 200,
"msg": "string",
"data": null
}
Respostas
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | Solicitação bem-sucedida | Inline |
Esquema da resposta
Status Code 200
| Nome | Tipo | Obrigatório | Restrições | Descrição |
|---|---|---|---|---|
| » code | integer | false | nenhum | Código de status, 200 bem-sucedido, 3 app_key inválido, 156 conta não autenticada. |
| » msg | string | false | nenhum | mensagem de estado |
| » data | null | false | nenhum | none |
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
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| body | body | object | false | nenhum |
| » team_id | body | any | false | 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 |
| »» anonymous | body | string | false | nenhum |
| »» anonymous | body | TeamPublicId | false | 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 |
| » app_key | body | string | false | Chave de autorização |
| » account | body | string | true | Conta de agente, apenas números e letras são suportados. |
| » remark | body | string | true | Novas 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
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | Solicitação bem-sucedida | Inline |
Esquema da resposta
Status Code 200
| Nome | Tipo | Obrigatório | Restrições | Descrição |
|---|---|---|---|---|
| » code | integer | false | nenhum | Código de status, 200 bem-sucedido, 3 app_key inválido, 156 conta não autenticada. |
| » msg | string | false | nenhum | mensagem de estado |
| » data | null | false | nenhum | none |
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
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| body | body | object | false | nenhum |
| » team_id | body | any | false | 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 |
| »» anonymous | body | string | false | nenhum |
| »» anonymous | body | TeamPublicId | false | 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 |
| » app_key | body | string | false | Chave de autorização |
| » account | body | string | true | Conta de agente, apenas números e letras são suportados. |
| » limit | body | integer | false | Limite de tráfego, unidade: GB, 0 significa sem limite superior |
Exemplos de resposta
Resposta 200
{
"code": 200,
"msg": "string",
"data": null
}
Respostas
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | Solicitação bem-sucedida | Inline |
Esquema da resposta
Status Code 200
| Nome | Tipo | Obrigatório | Restrições | Descrição |
|---|---|---|---|---|
| » code | integer | false | nenhum | Código de status, 200 bem-sucedido, 3 app_key inválido, 156 conta não autenticada. |
| » msg | string | false | nenhum | mensagem de estado |
| » data | null | false | nenhum | none |
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
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| body | body | object | true | nenhum |
| » team_id | body | any | false | 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 |
| »» anonymous | body | string | false | nenhum |
| »» anonymous | body | TeamPublicId | false | 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 |
| » product_type | body | integer | true | nenhum |
Exemplos de resposta
Resposta 200
{
"code": 0,
"msg": "string",
"request_id": "string",
"data": {
"username": "string",
"password": "string"
}
}
Respostas
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | Uma nova conta e senha serão devolvidas quando o negócio for bem-sucedido. | Inline |
Esquema da resposta
Status Code 200
| Nome | Tipo | Obrigatório | Restrições | Descrição |
|---|---|---|---|---|
| » code | integer | false | nenhum | none |
| » msg | string | false | nenhum | none |
| » request_id | string | false | nenhum | none |
| » data | any | false | nenhum | none |
oneOf
| Nome | Tipo | Obrigatório | Restrições | Descrição |
|---|---|---|---|---|
| »» anonymous | object | false | nenhum | none |
| »»» username | string | true | nenhum | none |
| »»» password | string | true | nenhum | none |
xor
| Nome | Tipo | Obrigatório | Restrições | Descrição |
|---|---|---|---|---|
| »» anonymous | null | false | nenhum | none |
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
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| body | body | object | true | nenhum |
| » team_id | body | any | false | 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 |
| »» anonymous | body | string | false | nenhum |
| »» anonymous | body | TeamPublicId | false | 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 |
| » account | body | string | true | nenhum |
| » daily_limit | body | integer | false | Unidade GB |
Exemplos de resposta
Resposta 200
{
"code": 200,
"msg": "SUCCESS",
"data": {},
"request_id": "string"
}
Respostas
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | Operação bem-sucedida | WebV1SuccessResponse |
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
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| body | body | object | true | nenhum |
| » team_id | body | any | false | 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 |
| »» anonymous | body | string | false | nenhum |
| »» anonymous | body | TeamPublicId | false | 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 |
| » account | body | string | true | nenhum |
| » password | body | string | false | nenhum |
| » remark | body | string | false | nenhum |
| » limit | body | integer | false | Limite total de tráfego em GB |
| » daily_limit | body | integer | false | Limite de tráfego diário em GB |
| » status | body | integer | false | nenhum |
| » udp | body | integer | false | nenhum |
Valores enumerados
| Parameter | Value |
|---|---|
| » status | 0 |
| » status | 1 |
| » udp | 0 |
| » udp | 1 |
Exemplos de resposta
Resposta 200
{
"code": 200,
"msg": "SUCCESS",
"data": {},
"request_id": "string"
}
Respostas
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | Operação bem-sucedida | WebV1SuccessResponse |
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
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| body | body | object | false | nenhum |
| » team_id | body | any | false | 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 |
| »» anonymous | body | string | false | nenhum |
| »» anonymous | body | TeamPublicId | false | 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 |
Exemplos de resposta
Resposta 200
{
"code": 200,
"msg": "SUCCESS",
"data": {},
"request_id": "string"
}
Respostas
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | Operação bem-sucedida | WebV1SuccessResponse |
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
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| team_id | query | ResourceSpaceId | false | nenhum |
| product_type | query | integer | true | nenhum |
Exemplos de resposta
Resposta 200
{
"code": 0,
"msg": "string",
"request_id": "string",
"data": {
"usage": 0,
"limit": 0,
"expand": 0
}
}
Respostas
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | Solicitação bem-sucedida | Inline |
Esquema da resposta
Status Code 200
| Nome | Tipo | Obrigatório | Restrições | Descrição |
|---|---|---|---|---|
| » code | integer | false | nenhum | none |
| » msg | string | false | nenhum | none |
| » request_id | string | false | nenhum | none |
| » data | object | false | nenhum | none |
| »» usage | integer | true | nenhum | none |
| »» limit | integer | true | nenhum | none |
| »» expand | integer | true | nenhum | none |
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
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| team_id | query | ResourceSpaceId | false | nenhum |
Exemplos de resposta
Resposta 200
{
"code": 0,
"msg": "string",
"request_id": "string",
"data": {
"list": [
{
"product_type": 0,
"limit": 0,
"usage": 0
}
]
}
}
Respostas
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | Solicitação bem-sucedida | Inline |
Esquema da resposta
Status Code 200
| Nome | Tipo | Obrigatório | Restrições | Descrição |
|---|---|---|---|---|
| » code | integer | false | nenhum | none |
| » msg | string | false | nenhum | none |
| » request_id | string | false | nenhum | none |
| » data | object | false | nenhum | none |
| »» list | [object] | false | nenhum | none |
| »»» product_type | integer | false | nenhum | none |
| »»» limit | integer | false | nenhum | none |
| »»» usage | integer | false | nenhum | none |
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
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| team_id | query | ResourceSpaceId | false | Identificador 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
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | Solicitação bem-sucedida | Inline |
Esquema da resposta
Status Code 200
| Nome | Tipo | Obrigatório | Restrições | Descrição |
|---|---|---|---|---|
| » code | responseCode | false | nenhum | Código de status, 200 bem-sucedido, 3 app_key inválido |
| » msg | string | false | nenhum | mensagem de estado |
| » data | object | false | nenhum | none |
| »» list | [object] | false | nenhum | none |
| »»» id | integer | false | nenhum | Número da conta |
| »»» username | string | false | nenhum | Nome da conta do agente |
| »»» password | string | false | nenhum | Senha da conta do agente |
| »»» created_at | string | false | nenhum | Adicionar tempo |
| »»» remark | string | false | nenhum | Observações |
| »»» product_type | productTypes | false | nenhum | 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 |
| »»» usage_flow | integer | false | nenhum | Tráfego usado, unidade: KB |
| »»» limit_flow | integer | false | nenhum | Limite de tráfego personalizado: a unidade máxima de GB é 102.400, 0 não é limite |
| »»» status | integer | false | nenhum | Status ativado: 1 ativado, 0 desativado |
Valores enumerados
| Propriedade | Valor |
|---|---|
| product_type | 9 |
| product_type | 11 |
| product_type | 14 |
| product_type | 25 |
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
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| body | body | object | false | nenhum |
| » team_id | body | any | false | 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 |
| »» anonymous | body | string | false | nenhum |
| »» anonymous | body | TeamPublicId | false | 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 |
| » app_key | body | string | false | Chave de autorização |
| » accounts | body | string | true | Senha 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 (,). |
| » remark | body | string | false | Descrição da conta do agente |
| » product_type | body | productTypes | false | 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 |
Valores enumerados
| Parameter | Value |
|---|---|
| » product_type | 9 |
| » product_type | 11 |
| » product_type | 14 |
| » product_type | 25 |
Exemplos de resposta
Resposta 200
{
"code": 200,
"msg": "string",
"data": null
}
Respostas
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | Solicitação bem-sucedida | Inline |
Esquema da resposta
Status Code 200
| Nome | Tipo | Obrigatório | Restrições | Descrição |
|---|---|---|---|---|
| » code | integer | false | nenhum | Código de status, 200 bem-sucedido, 3 app_key inválido, 156 conta não autenticada. |
| » msg | string | false | nenhum | mensagem de estado |
| » data | null | false | nenhum | none |
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
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| body | body | object | false | nenhum |
| » team_id | body | any | false | 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 |
| »» anonymous | body | string | false | nenhum |
| »» anonymous | body | TeamPublicId | false | 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 |
| » app_key | body | string | false | Chave de autorização |
| » accounts | body | string | true | Conta 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
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | Solicitação bem-sucedida | Inline |
Esquema da resposta
Status Code 200
| Nome | Tipo | Obrigatório | Restrições | Descrição |
|---|---|---|---|---|
| » code | integer | false | nenhum | Código de status, 200 bem-sucedido, 3 app_key inválido, 156 conta não autenticada. |
| » msg | string | false | nenhum | mensagem de estado |
| » data | null | false | nenhum | none |
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
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| body | body | object | false | nenhum |
| » team_id | body | any | false | 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 |
| »» anonymous | body | string | false | nenhum |
| »» anonymous | body | TeamPublicId | false | 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 |
| » app_key | body | string | false | Chave de autorização |
| » accounts | body | string | true | Conta 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
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | Solicitação bem-sucedida | Inline |
Esquema da resposta
Status Code 200
| Nome | Tipo | Obrigatório | Restrições | Descrição |
|---|---|---|---|---|
| » code | integer | false | nenhum | Código de status, 200 bem-sucedido, 3 app_key inválido, 156 conta não autenticada. |
| » msg | string | false | nenhum | mensagem de estado |
| » data | null | false | nenhum | none |
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
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| body | body | object | false | nenhum |
| » team_id | body | any | false | 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 |
| »» anonymous | body | string | false | nenhum |
| »» anonymous | body | TeamPublicId | false | 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 |
| » app_key | body | string | false | Chave de autorização |
| » accounts | body | string | true | Conta 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
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | Solicitação bem-sucedida | Inline |
Esquema da resposta
Status Code 200
| Nome | Tipo | Obrigatório | Restrições | Descrição |
|---|---|---|---|---|
| » code | integer | false | nenhum | Código de status, 200 bem-sucedido, 3 app_key inválido, 156 conta não autenticada. |
| » msg | string | false | nenhum | mensagem de estado |
| » data | null | false | nenhum | none |
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
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| body | body | object | false | nenhum |
| » team_id | body | any | false | 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 |
| »» anonymous | body | string | false | nenhum |
| »» anonymous | body | TeamPublicId | false | 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 |
| » app_key | body | string | false | Chave de autorização |
| » account | body | string | true | Nome da conta do agente |
| » password | body | string | false | Nova senha, de 6 a 16 dígitos ou letras; se não for aprovado, não será modificado. |
| » remark | body | string | false | Nova nota |
| » limit | body | integer | false | Limite de tráfego, unidade GB, 0 significa sem limite |
| » daily_limit | body | integer | false | Limite de tráfego diário em GB, 0 significa sem limite |
| » status | body | integer | false | Status ativado |
| » udp | body | integer | false | Switch de suporte UDP, efetivo apenas para tipos de pacote 14, 16, 21 e 25 |
Valores enumerados
| Parameter | Value |
|---|---|
| » status | 0 |
| » status | 1 |
| » udp | 0 |
| » udp | 1 |
Exemplos de resposta
Resposta 200
{
"code": 200,
"msg": "string",
"data": null
}
Respostas
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | Solicitação bem-sucedida | Inline |
Esquema da resposta
Status Code 200
| Nome | Tipo | Obrigatório | Restrições | Descrição |
|---|---|---|---|---|
| » code | integer | false | nenhum | Código de status, 200 sucessos |
| » msg | string | false | nenhum | mensagem de estado |
| » data | null | false | nenhum | none |
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
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| ac | query | integer,string | true | ID da conta do agente ou nome de usuário; conta de parâmetro compatível |
| ae | query | string | false | nenhum |
| st | query | string | false | nenhum |
| ct | query | string | false | nenhum |
| lf | query | integer | false | nenhum |
| n | query | integer | false | nenhum |
| f | query | integer | false | Afeta apenas o formato da cadeia de conexão de txt/csv |
| type | query | string | false | nenhum |
| lb | query | string | false | nenhum |
| ep | query | string | false | nenhum |
| team_id | query | ResourceSpaceId | false | nenhum |
Valores enumerados
| Parameter | Value |
|---|---|
| f | 1 |
| f | 2 |
| f | 3 |
| f | 4 |
| f | 5 |
| type | json |
| type | xml |
| type | txt |
| type | csv |
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
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | HTTP bem-sucedido; verifique o código comercial, 200 significa sucesso. | WebV1SuccessResponse |
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
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| team_id | query | ResourceSpaceId | false | Identificador do espaço de recursos do pedido; espaço pessoal omite ou passa uma string vazia |
| page_no | query | integer | false | nenhum |
| page_size | query | integer | false | nenhum |
| trade_no | query | string | false | número do pedido |
| start_time | query | string(date-time) | false | Hora de início (inclusive), como 01/01/2024 00:00:00 |
| end_time | query | string(date-time) | false | Horário de término (não incluído) |
| status | query | integer | false | Status do pedido |
| product_type | query | integer | false | tipo de produto |
| invoice | query | integer | false | Status da fatura: 0 sem limite 1 faturada -1 não faturada (pode ser reemitida) |
| pay_fee_status | query | integer | false | Triagem de pagamentos longos e curtos: 1 Pagamento a maior 2 Pagamento a curto prazo |
Detailed descriptions
status: Status do pedido
| Estado | Descrição |
|---|---|
| 0 | Pagamento pendente |
| 1 | Pago |
| 2 | Cancelado por horas extras e falta de pagamento |
| 3 | Reembolsado |
product_type: tipo de produto
| Tipo de produto | Descrição |
|---|---|
| 3 | Recarga de saldo |
| 9 | Pacote de tráfego dinâmico |
| 11 | Pacote de tempo global dinâmico V2 |
| 12 | Pacote de tráfego IDC de longo prazo |
| 13 | Pacote de tráfego IP estático residencial |
| 14 | Pacote IP estático do data center |
| 15 | Pacote de tráfego ISP de longo prazo |
| 16 | Pacote de tráfego estático |
| 17 | Pacote de quantidade de IP dinâmico |
| 18 | raspador de teia |
| 19 | Renovação de IP estático |
| 20 | Cota de substituição de IP estático |
| 21 | Pacote de tráfego estático v2 |
| 24 | Pacote complementar de tráfego estático |
| 25 | Pacote IP Estático Residencial |
| 26 | Ordem 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 |
| 27 | Serpente |
| 28 | Vídeo |
Valores enumerados
| Parameter | Value |
|---|---|
| status | 0 |
| status | 1 |
| status | 2 |
| status | 3 |
| product_type | 3 |
| product_type | 9 |
| product_type | 11 |
| product_type | 12 |
| product_type | 14 |
| product_type | 16 |
| product_type | 17 |
| product_type | 18 |
| product_type | 19 |
| product_type | 21 |
| product_type | 24 |
| product_type | 25 |
| product_type | 26 |
| product_type | 27 |
| product_type | 28 |
| invoice | -1 |
| invoice | 0 |
| invoice | 1 |
| pay_fee_status | 1 |
| pay_fee_status | 2 |
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
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | sucesso | Inline |
Esquema da resposta
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
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| body | body | object | true | nenhum |
| » team_id | body | any | false | 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 |
| »» anonymous | body | string | false | nenhum |
| »» anonymous | body | TeamPublicId | false | 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 |
| » pid | body | integer | true | ID do pacote, do campo id retornado pela interface /openapi/product |
| » upids | body | string | false | Lista 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 |
| » amount | body | number | false | Número de novos pacotes adquiridos |
| » pm_id | body | integer | true | ID da forma de pagamento, do campo id retornado pela interface /openapi/payment/list ou /openapi/payment/groups |
| » region_list | body | string | false | Ao adquirir um IP estático, especifique a região + quantidade + número ASN. O formato é: região, quantidade, ASN |
| » coupon_sn | body | string | false | Número do cupom |
| » use_invitation_registration_discount | body | boolean | false | Se deve usar o desconto de registro de convite |
| » renew_duration | body | integer | false | Renovação de IP estático de tempo opcional |
| » product_sku_bandwidth_id | body | integer | false | Pacote 11: ID do pacote de largura de banda |
| » product_sku_concurrency_id | body | integer | false | Pacote 11: ID do pacote simultâneo |
| » product_sku_duration_id | body | integer | false | Tipo de pacote=11Obrigatório: ID de especificação de duração |
| » etd | body | integer | false | Múltiplo de duração, obtido do pacote extension_of_time_days, 2 representa o número de dias × 2, o preço aumentará |
| » recharge_amount | body | integer | false | Pacote 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
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | Criado com sucesso | Inline |
Esquema da resposta
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
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| body | body | object | true | nenhum |
| » team_id | body | any | false | 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 |
| »» anonymous | body | string | false | nenhum |
| »» anonymous | body | TeamPublicId | false | 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 |
| » trade_no | body | string | true | nenhum |
Exemplos de resposta
Resposta 200
{
"code": 200,
"msg": "SUCCESS",
"data": {},
"request_id": "string"
}
Respostas
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | Operação bem-sucedida | WebV1SuccessResponse |
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
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| team_id | query | ResourceSpaceId | false | nenhum |
| trade_no | query | string | true | nenhum |
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
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | HTTP bem-sucedido; continue julgando o código do corpo da resposta | Inline |
Esquema da resposta
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
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| team_id | query | ResourceSpaceId | false | nenhum |
| order_id | query | string | true | ID 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
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | Sucesso HTTP; quando o pedido for pago ou cancelado, os dados do pedido poderão ser carregados com um código de erro comercial | Inline |
Esquema da resposta
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
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| body | body | object | true | nenhum |
| » team_id | body | any | false | 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 |
| »» anonymous | body | string | false | nenhum |
| »» anonymous | body | TeamPublicId | false | 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 |
| » trade_no_list | body | [string] | true | nenhum |
Exemplos de resposta
Resposta 200
{
"code": 200,
"msg": "SUCCESS",
"data": {},
"request_id": "string"
}
Respostas
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | Operação bem-sucedida | WebV1SuccessResponse |
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
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| body | body | object | true | nenhum |
| » team_id | body | any | false | 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 |
| »» anonymous | body | string | false | nenhum |
| »» anonymous | body | TeamPublicId | false | 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 |
| » pid | body | integer | true | ID do pacote |
| » upids | body | string | false | Renovação de IP: lista de IDs de pacotes de usuários, separados por vírgulas |
| » amount | body | integer | false | Quantidade de compra |
| » pm_id | body | integer | true | ID da forma de pagamento |
| » region_list | body | string | false | Região de compra de IP estático + quantidade, formato: ID da região, quantidade |
| » coupon_sn | body | string | false | Número do cupom |
| » renew_duration | body | string | false | Período de renovação do IP: 1m=1 mês, 2m=2 meses, em=final do próximo mês |
| » product_sku_bandwidth_id | body | integer | false | Tipo de pacote=11Obrigatório: ID de especificação de largura de banda |
| » product_sku_concurrency_id | body | integer | false | Tipo de pacote=11Obrigatório: ID de especificação de simultaneidade |
| » product_sku_duration_id | body | integer | false | Tipo de pacote=11Obrigatório: ID de especificação de duração |
| » etd | body | integer | false | Duração múltipla, obtida do pacote extension_of_time_days |
| » recharge_amount | body | number | false | Tipo de pacote=3Obrigatório: valor de recarga |
Valores enumerados
| Parameter | Value |
|---|---|
| » renew_duration | 1m |
| » renew_duration | 2m |
| » renew_duration | em |
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
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | Simulação bem-sucedida | Inline |
Esquema da resposta
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
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| team_id | query | ResourceSpaceId | false | Identificador de espaço de recursos; espaço pessoal omite ou passa uma string vazia |
| page | query | integer | false | nenhum |
| pageSize | query | integer | false | nenhum |
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
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | HTTP bem-sucedido; continue julgando o código do corpo da resposta | Inline |
Esquema da resposta
Status Code 200
| Nome | Tipo | Obrigatório | Restrições | Descrição |
|---|---|---|---|---|
| » code | integer | true | nenhum | none |
| » msg | string | true | nenhum | none |
| » request_id | string | true | nenhum | none |
| » data | object | true | nenhum | none |
| »» list | [UserApiKeyMetadata] | true | nenhum | none |
| »»» id | integer | true | nenhum | API Key ID |
| »»» api_key | string | true | nenhum | A resposta da criação é a Chave completa; a lista da equipe é o valor mascarado |
| »»» team_user_id | integer | true | nenhum | A chave da equipe, na verdade, contém o ID do membro e a chave pessoal é 0 |
| »»» remark | string | true | nenhum | Observações |
| »»» status | integer | true | nenhum | 0=desativar, 1=ativar |
| »»» created_at | string | true | nenhum | hora de criação |
| »»» updated_at | string,null | false | nenhum | Hora de atualização |
| »» total | integer | true | nenhum | none |
| »» page | integer | true | nenhum | none |
| »» pageSize | integer | true | nenhum | none |
Valores enumerados
| Propriedade | Valor |
|---|---|
| status | 0 |
| status | 1 |
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
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| body | body | object | true | nenhum |
| » team_id | body | any | false | 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 |
| »» anonymous | body | string | false | nenhum |
| »» anonymous | body | TeamPublicId | false | 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 |
| » remark | body | string | false | nenhum |
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
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | Retorne a chave API completa quando o negócio for bem-sucedido, só que desta vez | Inline |
Esquema da resposta
Valores enumerados
| Propriedade | Valor |
|---|---|
| status | 0 |
| status | 1 |
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
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| body | body | object | true | nenhum |
| » team_id | body | any | false | 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 |
| »» anonymous | body | string | false | nenhum |
| »» anonymous | body | TeamPublicId | false | 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 |
| » id | body | integer | true | API Key ID |
Exemplos de resposta
Resposta 200
{
"code": 200,
"msg": "SUCCESS",
"data": {},
"request_id": "string"
}
Respostas
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | Operação bem-sucedida | WebV1SuccessResponse |
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
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| body | body | object | true | nenhum |
| » team_id | body | any | false | 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 |
| »» anonymous | body | string | false | nenhum |
| »» anonymous | body | TeamPublicId | false | 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 |
| » id | body | integer | true | API Key ID |
Exemplos de resposta
Resposta 200
{
"code": 200,
"msg": "SUCCESS",
"data": {},
"request_id": "string"
}
Respostas
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | Operação bem-sucedida | WebV1SuccessResponse |
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
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| body | body | object | true | nenhum |
| » team_id | body | any | false | 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 |
| »» anonymous | body | string | false | nenhum |
| »» anonymous | body | TeamPublicId | false | 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 |
| » id | body | integer | true | API Key ID |
Exemplos de resposta
Resposta 200
{
"code": 200,
"msg": "SUCCESS",
"data": {},
"request_id": "string"
}
Respostas
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | Operação bem-sucedida | WebV1SuccessResponse |
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
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| body | body | object | true | nenhum |
| » team_id | body | any | false | 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 |
| »» anonymous | body | string | false | nenhum |
| »» anonymous | body | TeamPublicId | false | 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 |
| » id | body | integer | true | nenhum |
| » remark | body | string | true | nenhum |
Exemplos de resposta
Resposta 200
{
"code": 200,
"msg": "SUCCESS",
"data": {},
"request_id": "string"
}
Respostas
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | Operação bem-sucedida | WebV1SuccessResponse |
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
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| team_id | query | ResourceSpaceId | false | nenhum |
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
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | Solicitação bem-sucedida | Inline |
Esquema da resposta
Valores enumerados
| Propriedade | Valor |
|---|---|
| type | current |
| type | next |
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
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| body | body | MonthlyRenewalRequest | true | nenhum |
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
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | Solicitação bem-sucedida | Inline |
Esquema da resposta
Valores enumerados
| Propriedade | Valor |
|---|---|
| type | current |
| type | next |
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
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| body | body | MonthlyRenewalRequest | true | nenhum |
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
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | Solicitação bem-sucedida | Inline |
Esquema da resposta
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
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| team_id | query | ResourceSpaceId | false | nenhum |
| trade_no | query | string | false | nenhum |
| start_date | query | string(date) | false | nenhum |
| end_date | query | string(date) | false | nenhum |
| page | query | integer | false | nenhum |
| size | query | integer | false | nenhum |
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
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | Solicitação bem-sucedida | Inline |
Esquema da resposta
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
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| team_id | query | ResourceSpaceId | false | nenhum |
| invoice_code | query | string | false | nenhum |
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
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | HTTP bem-sucedido; continue julgando o código do corpo da resposta | Inline |
Esquema da resposta
Valores enumerados
| Propriedade | Valor |
|---|---|
| role_type | 1 |
| role_type | 2 |
| invoice_type | 0 |
| invoice_type | 1 |
| invoice_type | 2 |
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
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| body | body | any | true | nenhum |
Exemplos de resposta
Resposta 200
{
"code": 200,
"msg": "SUCCESS",
"data": null,
"request_id": "string"
}
Respostas
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | A solicitação foi bem-sucedida, os dados são nulos | Inline |
Esquema da resposta
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
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| team_id | query | ResourceSpaceId | false | nenhum |
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
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | Solicitação bem-sucedida | Inline |
Esquema da resposta
Valores enumerados
| Propriedade | Valor |
|---|---|
| role_type | 1 |
| role_type | 2 |
| invoice_type | 0 |
| invoice_type | 1 |
| invoice_type | 2 |
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
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| body | body | object | true | nenhum |
| » team_id | body | any | false | 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 |
| »» anonymous | body | string | false | nenhum |
| »» anonymous | body | TeamPublicId | false | 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 |
| » invoice_code | body | string | true | nenhum |
Exemplos de resposta
Resposta 200
{
"code": 200,
"msg": "SUCCESS",
"data": null,
"request_id": "string"
}
Respostas
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | A solicitação foi bem-sucedida, os dados são nulos | Inline |
Esquema da resposta
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
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| team_id | query | ResourceSpaceId | false | nenhum |
| status | query | integer | false | nenhum |
Valores enumerados
| Parameter | Value |
|---|---|
| status | 0 |
| status | 1 |
| status | 2 |
| status | 3 |
| status | 4 |
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
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | Solicitação bem-sucedida | Inline |
Esquema da resposta
Valores enumerados
| Propriedade | Valor |
|---|---|
| role_type | 1 |
| role_type | 2 |
| invoice_type | 0 |
| invoice_type | 1 |
| invoice_type | 2 |
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
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| body | body | object | true | nenhum |
| » team_id | body | any | false | 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 |
| »» anonymous | body | string | false | nenhum |
| »» anonymous | body | TeamPublicId | false | 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 |
| » invoice_code | body | string | true | nenhum |
| » order_ids | body | [integer] | true | nenhum |
Exemplos de resposta
Resposta 200
{
"code": 200,
"msg": "SUCCESS",
"data": {
"invoice_id": 1
},
"request_id": "string"
}
Respostas
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | Solicitação bem-sucedida | Inline |
Esquema da resposta
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
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| body | body | object | true | nenhum |
| » team_id | body | any | false | 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 |
| »» anonymous | body | string | false | nenhum |
| »» anonymous | body | TeamPublicId | false | 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 |
| » invoice_id | body | integer | true | nenhum |
| » reason | body | string | false | nenhum |
Exemplos de resposta
Resposta 200
{
"code": 200,
"msg": "SUCCESS",
"data": null,
"request_id": "string"
}
Respostas
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | A solicitação foi bem-sucedida, os dados são nulos | Inline |
Esquema da resposta
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
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| team_id | query | ResourceSpaceId | false | nenhum |
Exemplos de resposta
Resposta 200
{
"code": 200,
"msg": "SUCCESS",
"data": {
"invoiceable_amount": 0,
"invoiced_amount": 0,
"processing_amount": 0
},
"request_id": "string"
}
Respostas
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | Solicitação bem-sucedida | Inline |
Esquema da resposta
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
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| team_id | query | ResourceSpaceId | false | nenhum |
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
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | Solicitação bem-sucedida | Inline |
Esquema da resposta
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
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| body | body | object | true | nenhum |
| » name | body | string | true | Nome 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
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | HTTP bem-sucedido; continue julgando o código do corpo da resposta | Inline |
Esquema da resposta
Valores enumerados
| Propriedade | Valor |
|---|---|
| status | 0 |
| status | 1 |
| status | 2 |
| status | 3 |
| current_role | 1 |
| current_role | 2 |
| current_role | 3 |
| current_role | 4 |
| current_role | null |
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
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| page | query | integer | false | nenhum |
| page_size | query | integer | false | nenhum |
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
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | HTTP bem-sucedido; continue julgando o código do corpo da resposta | Inline |
Esquema da resposta
Valores enumerados
| Propriedade | Valor |
|---|---|
| status | 0 |
| status | 1 |
| status | 2 |
| status | 3 |
| current_role | 1 |
| current_role | 2 |
| current_role | 3 |
| current_role | 4 |
| current_role | null |
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
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| team_id | query | TeamPublicId | true | nenhum |
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
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | HTTP bem-sucedido; continue julgando o código do corpo da resposta | Inline |
Esquema da resposta
Valores enumerados
| Propriedade | Valor |
|---|---|
| status | 0 |
| status | 1 |
| status | 2 |
| status | 3 |
| current_role | 1 |
| current_role | 2 |
| current_role | 3 |
| current_role | 4 |
| current_role | null |
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
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| body | body | object | true | nenhum |
| » team_id | body | TeamPublicId | true | 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 |
| » name | body | string | true | nenhum |
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
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | HTTP bem-sucedido; continue julgando o código do corpo da resposta | Inline |
Esquema da resposta
Valores enumerados
| Propriedade | Valor |
|---|---|
| status | 0 |
| status | 1 |
| status | 2 |
| status | 3 |
| current_role | 1 |
| current_role | 2 |
| current_role | 3 |
| current_role | 4 |
| current_role | null |
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
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| body | body | object | true | nenhum |
| » team_id | body | TeamPublicId | true | 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 |
| » name | body | string | true | Confirmação do nome da equipe, deve ser exatamente igual ao nome atual da equipe |
| » verify_type | body | string | false | Método de verificação secundária; enviar junto com verify_code quando a verificação for necessária |
| » verify_code | body | string | false | Código de verificação em duas etapas; não é necessário quando estiver no estado de confiança de 15 minutos |
Valores enumerados
| Parameter | Value |
|---|---|
| » verify_type | phone |
| » verify_type | |
| » verify_type | |
| » verify_type | totp |
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
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | HTTP bem-sucedido; continue julgando o código do corpo da resposta | Inline |
Esquema da resposta
Valores enumerados
| Propriedade | Valor |
|---|---|
| status | 0 |
| status | 1 |
| status | 2 |
| status | 3 |
| current_role | 1 |
| current_role | 2 |
| current_role | 3 |
| current_role | 4 |
| current_role | null |
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
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| team_id | query | TeamPublicId | true | nenhum |
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
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | HTTP bem-sucedido; continue julgando o código do corpo da resposta | Inline |
Esquema da resposta
Valores enumerados
| Propriedade | Valor |
|---|---|
| status | 0 |
| status | 1 |
| status | 2 |
| status | 3 |
| current_role | 1 |
| current_role | 2 |
| current_role | 3 |
| current_role | 4 |
| current_role | null |
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
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| team_id | query | TeamPublicId | true | nenhum |
| page | query | integer | false | nenhum |
| page_size | query | integer | false | nenhum |
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
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | HTTP bem-sucedido; continue julgando o código do corpo da resposta | Inline |
Esquema da resposta
Valores enumerados
| Propriedade | Valor |
|---|---|
| role | 1 |
| role | 2 |
| role | 3 |
| role | 4 |
| status | 0 |
| status | 1 |
| status | 2 |
| status | 3 |
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
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| team_id | query | TeamPublicId | true | nenhum |
| page | query | integer | false | nenhum |
| page_size | query | integer | false | nenhum |
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
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | HTTP bem-sucedido; continue julgando o código do corpo da resposta | Inline |
Esquema da resposta
Valores enumerados
| Propriedade | Valor |
|---|---|
| record_type | member |
| record_type | invitation |
| invite_type | 0 |
| invite_type | 1 |
| invite_type | 2 |
| invite_type | 3 |
| delivery_type | 0 |
| delivery_type | 1 |
| delivery_type | 2 |
| delivery_type | 3 |
| role | 1 |
| role | 2 |
| role | 3 |
| role | 4 |
| status | 0 |
| status | 1 |
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
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| body | body | object | true | nenhum |
| » team_id | body | TeamPublicId | true | 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 |
| » team_member_id | body | integer | true | nenhum |
| » role | body | integer | true | nenhum |
Valores enumerados
| Parameter | Value |
|---|---|
| » role | 2 |
| » role | 3 |
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
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | HTTP bem-sucedido; continue julgando o código do corpo da resposta | Inline |
Esquema da resposta
Valores enumerados
| Propriedade | Valor |
|---|---|
| role | 1 |
| role | 2 |
| role | 3 |
| role | 4 |
| status | 0 |
| status | 1 |
| status | 2 |
| status | 3 |
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
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| body | body | object | true | nenhum |
| » team_id | body | TeamPublicId | true | 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 |
| » team_member_id | body | integer | true | nenhum |
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
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | HTTP foi bem-sucedido; quando o negócio dá certo data.status=3 | Inline |
Esquema da resposta
Valores enumerados
| Propriedade | Valor |
|---|---|
| role | 1 |
| role | 2 |
| role | 3 |
| role | 4 |
| status | 0 |
| status | 1 |
| status | 2 |
| status | 3 |
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
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| body | body | object | true | nenhum |
| » team_id | body | TeamPublicId | true | 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 |
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
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | HTTP foi bem-sucedido; quando o negócio é bem-sucedido, data.status=2 | Inline |
Esquema da resposta
Valores enumerados
| Propriedade | Valor |
|---|---|
| role | 1 |
| role | 2 |
| role | 3 |
| role | 4 |
| status | 0 |
| status | 1 |
| status | 2 |
| status | 3 |
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
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| body | body | object | true | nenhum |
| » team_id | body | TeamPublicId | true | 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 |
| » invite_type | body | integer | true | 1=Usuário registrado, 2=E-mail, 3=Número de celular |
| » role | body | integer | true | 2=administrador, 3=membro comum |
| » user_id | body | integer | false | Obrigatório quando convite_type=1 |
| body | string(email) | false | Obrigatório quando convite_type=2 | |
| » country_code | body | integer | false | Obrigatório quando convite_type=3 |
| » phone | body | string | false | Obrigatório quando convite_type=3 |
| » invitation_url_template | body | string | false | O 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 |
| » anonymous | body | object | false | nenhum |
| »» invite_type | body | any | false | nenhum |
| » anonymous | body | object | false | nenhum |
| »» invite_type | body | any | false | nenhum |
| » anonymous | body | object | false | nenhum |
| »» invite_type | body | any | false | nenhum |
Valores enumerados
| Parameter | Value |
|---|---|
| » invite_type | 1 |
| » invite_type | 2 |
| » invite_type | 3 |
| » role | 2 |
| » role | 3 |
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
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | HTTP bem-sucedido; continue a julgar o código do corpo da resposta, 200 significa sucesso nos negócios | Inline |
Esquema da resposta
Valores enumerados
| Propriedade | Valor |
|---|---|
| invite_type | 1 |
| invite_type | 2 |
| invite_type | 3 |
| delivery_type | 1 |
| delivery_type | 2 |
| delivery_type | 3 |
| role | 2 |
| role | 3 |
| status | 0 |
| status | 1 |
| status | 2 |
| status | 3 |
| status | 4 |
| queued | |
| failed | |
| skipped | |
| sms | queued |
| sms | failed |
| sms | skipped |
| site_inner_message | created |
| site_inner_message | exists |
| site_inner_message | failed |
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
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| team_id | query | TeamPublicId | true | Identidade pública da equipe |
| page | query | integer | false | Número da página, começando em 1 |
| page_size | query | integer | false | Quantidade 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
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | HTTP bem-sucedido; continue julgando o código do corpo da resposta | Inline |
Esquema da resposta
Valores enumerados
| Propriedade | Valor |
|---|---|
| invite_type | 1 |
| invite_type | 2 |
| invite_type | 3 |
| delivery_type | 1 |
| delivery_type | 2 |
| delivery_type | 3 |
| role | 2 |
| role | 3 |
| status | 0 |
| status | 1 |
| status | 2 |
| status | 3 |
| status | 4 |
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
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| invitation_token | query | string | true | O 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
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | HTTP bem-sucedido; continue julgando o código do corpo da resposta | Inline |
Esquema da resposta
Valores enumerados
| Propriedade | Valor |
|---|---|
| role | 2 |
| role | 3 |
| status | 0 |
| status | 1 |
| status | 2 |
| status | 3 |
| status | 4 |
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
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| body | body | object | true | nenhum |
| » team_id | body | TeamPublicId | true | 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 |
| » invitation_id | body | integer | true | ID 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
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | HTTP bem-sucedido; continue julgando o código do corpo da resposta | Inline |
Esquema da resposta
Valores enumerados
| Propriedade | Valor |
|---|---|
| invite_type | 1 |
| invite_type | 2 |
| invite_type | 3 |
| delivery_type | 1 |
| delivery_type | 2 |
| delivery_type | 3 |
| role | 2 |
| role | 3 |
| status | 0 |
| status | 1 |
| status | 2 |
| status | 3 |
| status | 4 |
| queued | |
| failed | |
| skipped | |
| sms | queued |
| sms | failed |
| sms | skipped |
| site_inner_message | created |
| site_inner_message | exists |
| site_inner_message | failed |
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
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| body | body | object | true | nenhum |
| » invitation_token | body | string | true | Token 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
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | HTTP foi bem-sucedido; quando o negócio é bem-sucedido, os dados são um objeto membro | Inline |
Esquema da resposta
Valores enumerados
| Propriedade | Valor |
|---|---|
| role | 1 |
| role | 2 |
| role | 3 |
| role | 4 |
| status | 0 |
| status | 1 |
| status | 2 |
| status | 3 |
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
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| body | body | object | true | nenhum |
| » invitation_token | body | string | true | Token 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
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | HTTP foi bem-sucedido; quando o negócio é bem-sucedido, data.status=2 | Inline |
Esquema da resposta
Valores enumerados
| Propriedade | Valor |
|---|---|
| invite_type | 1 |
| invite_type | 2 |
| invite_type | 3 |
| delivery_type | 1 |
| delivery_type | 2 |
| delivery_type | 3 |
| role | 2 |
| role | 3 |
| status | 0 |
| status | 1 |
| status | 2 |
| status | 3 |
| status | 4 |
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
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| body | body | object | true | nenhum |
| » team_id | body | TeamPublicId | true | 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 |
| » invitation_id | body | integer | true | ID 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
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | HTTP foi bem-sucedido; quando o negócio dá certo data.status=3 | Inline |
Esquema da resposta
Valores enumerados
| Propriedade | Valor |
|---|---|
| invite_type | 1 |
| invite_type | 2 |
| invite_type | 3 |
| delivery_type | 1 |
| delivery_type | 2 |
| delivery_type | 3 |
| role | 2 |
| role | 3 |
| status | 0 |
| status | 1 |
| status | 2 |
| status | 3 |
| status | 4 |
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
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| team_id | query | TeamPublicId | true | nenhum |
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
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | HTTP bem-sucedido; continue julgando o código do corpo da resposta | Inline |
Esquema da resposta
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
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| team_id | query | TeamPublicId | true | nenhum |
| page | query | integer | false | nenhum |
| page_size | query | integer | false | nenhum |
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
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | HTTP bem-sucedido; continue julgando o código do corpo da resposta | Inline |
Esquema da resposta
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
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| team_id | query | TeamPublicId | true | nenhum |
| page | query | integer | false | nenhum |
| page_size | query | integer | false | nenhum |
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
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | HTTP bem-sucedido; continue julgando o código do corpo da resposta | Inline |
Esquema da resposta
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
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| body | body | object | true | nenhum |
| » team_id | body | TeamPublicId | true | 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 |
| » user_product_id | body | integer | true | nenhum |
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
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | HTTP bem-sucedido; continue julgando o código do corpo da resposta | Inline |
Esquema da resposta
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
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| body | body | object | true | nenhum |
| » team_id | body | TeamPublicId | true | 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 |
| » user_product_id | body | integer | true | nenhum |
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
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | HTTP bem-sucedido; continue julgando o código do corpo da resposta | Inline |
Esquema da resposta
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
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| team_id | query | ResourceSpaceId | false | Identificador 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
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | HTTP 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
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
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| body | body | object | true | nenhum |
| » team_id | body | any | false | 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 |
| »» anonymous | body | string | false | nenhum |
| »» anonymous | body | TeamPublicId | false | 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 |
| » status | body | integer | true | 0=desligado, 1=ligado |
Valores enumerados
| Parameter | Value |
|---|---|
| » status | 0 |
| » status | 1 |
Exemplos de resposta
Resposta 200
{
"code": 200,
"msg": "SUCCESS",
"data": {},
"request_id": "string"
}
Respostas
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | HTTP foi bem-sucedido; quando o negócio é bem-sucedido, data.status é o status atualizado do switch. | Inline |
Esquema da resposta
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
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| team_id | query | ResourceSpaceId | false | nenhum |
| page | query | integer | false | nenhum |
| page_size | query | integer | false | nenhum |
| start_date | query | string(date) | false | Data de início, interpretada pelo fuso horário do site |
| end_date | query | string(date) | false | Data de término, interpretada pelo fuso horário do site |
| consumption_type | query | string | false | Tipo de consumo |
Exemplos de resposta
Resposta 200
{
"code": 200,
"msg": "SUCCESS",
"data": {},
"request_id": "string"
}
Respostas
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | HTTP foi bem-sucedido; quando o negócio é bem-sucedido, os dados incluem lista, página, page_size, total_count e total_page | Inline |
Esquema da resposta
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
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| team_id | query | ResourceSpaceId | false | nenhum |
| page | query | integer | false | nenhum |
| page_size | query | integer | false | nenhum |
Exemplos de resposta
Resposta 200
{
"code": 200,
"msg": "SUCCESS",
"data": {},
"request_id": "string"
}
Respostas
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | HTTP 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
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
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| team_id | query | ResourceSpaceId | false | nenhum |
| start_date | query | string(date) | false | Data de início, interpretada pelo fuso horário do site |
| end_date | query | string(date) | false | Data de término, interpretada pelo fuso horário do site |
Exemplos de resposta
Resposta 200
{
"code": 200,
"msg": "SUCCESS",
"data": {},
"request_id": "string"
}
Respostas
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | HTTP foi bem-sucedido; quando o negócio é bem-sucedido, os dados contêm por tipo e total | Inline |
Esquema da resposta
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
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| team_id | query | ResourceSpaceId | false | nenhum |
| start_date | query | string(date) | false | Data de início, padrão 6 dias atrás |
| end_date | query | string(date) | false | Data de término, o padrão é hoje |
| consumption_type | query | string | false | Tipos de consumo opcionais |
| fill_gaps | query | integer | false | Se deve preencher datas faltantes |
Valores enumerados
| Parameter | Value |
|---|---|
| fill_gaps | 0 |
| fill_gaps | 1 |
Exemplos de resposta
Resposta 200
{
"code": 200,
"msg": "SUCCESS",
"data": {},
"request_id": "string"
}
Respostas
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | HTTP foi bem-sucedido; quando o negócio é bem-sucedido, os dados contêm estatísticas diárias e resumo | Inline |
Esquema da resposta
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
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| team_id | query | ResourceSpaceId | false | nenhum |
| start_date | query | string(date) | false | Data de início, padrão 6 dias atrás |
| end_date | query | string(date) | false | Data de término, o padrão é hoje |
| consumption_type | query | string | false | Tipos de consumo opcionais |
| fill_gaps | query | integer | false | Se deve preencher horas faltantes |
Valores enumerados
| Parameter | Value |
|---|---|
| fill_gaps | 0 |
| fill_gaps | 1 |
Exemplos de resposta
Resposta 200
{
"code": 200,
"msg": "SUCCESS",
"data": {},
"request_id": "string"
}
Respostas
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | HTTP foi bem-sucedido; quando o negócio é bem-sucedido, os dados contêm estatísticas horárias e resumo | Inline |
Esquema da resposta
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
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| team_id | query | ResourceSpaceId | false | Identificador 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
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | HTTP 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
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
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| team_id | query | ResourceSpaceId | false | nenhum |
| page | query | integer | false | nenhum |
| page_size | query | integer | false | nenhum |
| start_date | query | string(date) | false | Data de início, interpretada pelo fuso horário do site |
| end_date | query | string(date) | false | Data de término, interpretada pelo fuso horário do site |
| consumption_type | query | string | false | Tipo de consumo |
Exemplos de resposta
Resposta 200
{
"code": 200,
"msg": "SUCCESS",
"data": {},
"request_id": "string"
}
Respostas
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | HTTP foi bem-sucedido; quando o negócio é bem-sucedido, os dados incluem lista, página, page_size, total_count e total_page | Inline |
Esquema da resposta
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
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| team_id | query | ResourceSpaceId | false | nenhum |
| page | query | integer | false | nenhum |
| page_size | query | integer | false | nenhum |
Exemplos de resposta
Resposta 200
{
"code": 200,
"msg": "SUCCESS",
"data": {},
"request_id": "string"
}
Respostas
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | HTTP 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
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
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| team_id | query | ResourceSpaceId | false | nenhum |
| start_date | query | string(date) | false | Data de início, interpretada pelo fuso horário do site |
| end_date | query | string(date) | false | Data de término, interpretada pelo fuso horário do site |
Exemplos de resposta
Resposta 200
{
"code": 200,
"msg": "SUCCESS",
"data": {},
"request_id": "string"
}
Respostas
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | HTTP foi bem-sucedido; quando o negócio é bem-sucedido, os dados contêm por tipo e total | Inline |
Esquema da resposta
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
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| team_id | query | ResourceSpaceId | false | nenhum |
| start_date | query | string(date) | false | Data de início, padrão 6 dias atrás |
| end_date | query | string(date) | false | Data de término, o padrão é hoje |
| consumption_type | query | string | false | Tipos de consumo opcionais |
| fill_gaps | query | integer | false | Se deve preencher datas faltantes |
Valores enumerados
| Parameter | Value |
|---|---|
| fill_gaps | 0 |
| fill_gaps | 1 |
Exemplos de resposta
Resposta 200
{
"code": 200,
"msg": "SUCCESS",
"data": {},
"request_id": "string"
}
Respostas
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | HTTP foi bem-sucedido; quando o negócio é bem-sucedido, os dados contêm estatísticas diárias e resumo | Inline |
Esquema da resposta
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
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| team_id | query | ResourceSpaceId | false | nenhum |
| start_date | query | string(date) | false | Data de início, padrão 6 dias atrás |
| end_date | query | string(date) | false | Data de término, o padrão é hoje |
| consumption_type | query | string | false | Tipos de consumo opcionais |
| fill_gaps | query | integer | false | Se deve preencher horas faltantes |
Valores enumerados
| Parameter | Value |
|---|---|
| fill_gaps | 0 |
| fill_gaps | 1 |
Exemplos de resposta
Resposta 200
{
"code": 200,
"msg": "SUCCESS",
"data": {},
"request_id": "string"
}
Respostas
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | HTTP foi bem-sucedido; quando o negócio é bem-sucedido, os dados contêm estatísticas horárias e resumo | Inline |
Esquema da resposta
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
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| team_id | query | ResourceSpaceId | false | nenhum |
| page | query | integer | false | nenhum |
| page_size | query | integer | false | nenhum |
| endpoint | query | string | false | tipo de terminal |
| status | query | string | false | nenhum |
| start_time | query | string | false | Horário do fuso horário do usuário, formato Y-m-d H:i:s |
| end_time | query | string | false | Fuso horário do usuário, incluindo limite final |
| url | query | string | false | URL de destino ou ID do raspador de dados |
| job_id | query | string | false | Prefixo do ID da tarefa |
Valores enumerados
| Parameter | Value |
|---|---|
| status | pending |
| status | crawling |
| status | completed |
| status | failed |
Exemplos de resposta
Resposta 200
{
"code": 200,
"msg": "SUCCESS",
"data": {},
"request_id": "string"
}
Respostas
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | HTTP foi bem-sucedido; quando o negócio é bem-sucedido, os dados contêm lista de paginação e metadados | Inline |
Esquema da resposta
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
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| team_id | query | ResourceSpaceId | false | nenhum |
| job_id | query | string | true | ID da tarefa |
Exemplos de resposta
Resposta 200
{
"code": 200,
"msg": "SUCCESS",
"data": {},
"request_id": "string"
}
Respostas
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | HTTP foi bem-sucedido; quando o negócio é bem-sucedido, os dados contêm job_id e crawl_result | Inline |
Esquema da resposta
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
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| team_id | query | ResourceSpaceId | false | nenhum |
| job_id | query | string | true | ID da tarefa |
| page | query | integer | false | número da página do subresultado de rastreamento/dados |
| page_size | query | integer | false | número de rastreamento/dados de páginas de subresultados |
Exemplos de resposta
Resposta 200
{
"code": 200,
"msg": "SUCCESS",
"data": {},
"request_id": "string"
}
Respostas
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | HTTP foi bem-sucedido; quando o negócio é bem-sucedido, os dados contêm trabalhos e detalhes alterados por endpoint. | Inline |
Esquema da resposta
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
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| team_id | query | ResourceSpaceId | false | nenhum |
| limit | query | integer | false | Quantidade de devolução; 0 retorna uma lista vazia |
Exemplos de resposta
Resposta 200
{
"code": 200,
"msg": "SUCCESS",
"data": {},
"request_id": "string"
}
Respostas
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | HTTP foi bem-sucedido; quando o negócio é bem-sucedido, data.list é o resultado da agregação do scraper. | Inline |
Esquema da resposta
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
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| team_id | query | ResourceSpaceId | false | nenhum |
| page | query | integer | false | nenhum |
| page_size | query | integer | false | nenhum |
| endpoint | query | string | false | Tipo de endpoint, geralmente batch_scrape |
| status | query | string | false | nenhum |
| start_time | query | string | false | Horário do fuso horário do usuário, formato Y-m-d H:i:s |
| end_time | query | string | false | Fuso horário do usuário, incluindo limite final |
| batch_id | query | string | false | Prefixo do ID da tarefa em lote |
Valores enumerados
| Parameter | Value |
|---|---|
| status | pending |
| status | crawling |
| status | completed |
| status | failed |
Exemplos de resposta
Resposta 200
{
"code": 200,
"msg": "SUCCESS",
"data": {},
"request_id": "string"
}
Respostas
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | HTTP foi bem-sucedido; quando o negócio é bem-sucedido, os dados contêm lista de paginação e metadados | Inline |
Esquema da resposta
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
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| team_id | query | ResourceSpaceId | false | nenhum |
| batch_id | query | string | true | ID da tarefa em lote |
| page | query | integer | false | Número da página do subitem |
| page_size | query | integer | false | Número de subpáginas |
Exemplos de resposta
Resposta 200
{
"code": 200,
"msg": "SUCCESS",
"data": {},
"request_id": "string"
}
Respostas
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | HTTP foi bem-sucedido; quando o negócio é bem-sucedido, os dados contêm detalhes do trabalho e da tarefa em lote | Inline |
Esquema da resposta
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
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | HTTP bem-sucedido; verifique o código comercial, 200 significa sucesso. | Inline |
Esquema da resposta
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
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| re_type | query | integer | false | nenhum |
| transaction_type | query | integer | false | nenhum |
| balance_type | query | integer | false | nenhum |
| page | query | integer | false | nenhum |
| page_size | query | integer | false | nenhum |
Valores enumerados
| Parameter | Value |
|---|---|
| re_type | 0 |
| re_type | 1 |
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
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | HTTP bem-sucedido; verifique o código comercial, 200 significa sucesso. | Inline |
Esquema da resposta
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
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| body | body | object | true | nenhum |
| » start_time | body | integer | true | Carimbo de data e hora inicial do Unix, segundos |
| » end_time | body | integer | true | carimbo de data/hora Unix final, segundos |
| » type | body | string | false | nenhum |
Valores enumerados
| Parameter | Value |
|---|---|
| » type | dynamic |
| » type | host_pool |
Exemplos de resposta
Resposta 200
{
"code": 200,
"msg": "SUCCESS",
"data": {
"task_id": 0,
"status": "string"
},
"request_id": "string"
}
Respostas
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | HTTP bem-sucedido; verifique o código comercial, 200 significa sucesso. | Inline |
Esquema da resposta
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
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| task_id | query | integer | true | nenhum |
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
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | HTTP bem-sucedido; verifique o código comercial, 200 significa sucesso. | Inline |
Esquema da resposta
Valores enumerados
| Propriedade | Valor |
|---|---|
| status | pending |
| status | processing |
| status | completed |
| status | failed |
| status | canceled |
| status | no_data |
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
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| page | query | integer | false | nenhum |
| size | query | integer | false | nenhum |
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
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | HTTP bem-sucedido; verifique o código comercial, 200 significa sucesso. | Inline |
Esquema da resposta
Valores enumerados
| Propriedade | Valor |
|---|---|
| status | pending |
| status | processing |
| status | completed |
| status | failed |
| status | canceled |
| status | no_data |
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
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| body | body | object | true | nenhum |
| » task_id | body | integer | true | nenhum |
Exemplos de resposta
Resposta 200
{
"code": 200,
"msg": "SUCCESS",
"data": null,
"request_id": "string"
}
Respostas
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | HTTP bem-sucedido; verifique o código comercial, 200 significa sucesso. | Inline |
Esquema da resposta
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
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| body | body | object | false | nenhum |
| » status | body | integer | false | nenhum |
| » page | body | integer | false | nenhum |
| » size | body | integer | false | nenhum |
Valores enumerados
| Parameter | Value |
|---|---|
| » status | 0 |
| » status | 1 |
| » status | 2 |
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
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | HTTP bem-sucedido; verifique o código comercial, 200 significa sucesso. | Inline |
Esquema da resposta
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
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| body | body | object | true | nenhum |
| » id | body | integer | true | nenhum |
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
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | HTTP bem-sucedido; verifique o código comercial, 200 significa sucesso. | Inline |
Esquema da resposta
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
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| page | query | integer | false | nenhum |
| size | query | integer | false | nenhum |
| read | query | integer | false | nenhum |
| type | query | integer | false | nenhum |
Valores enumerados
| Parameter | Value |
|---|---|
| read | 0 |
| read | 1 |
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
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | HTTP bem-sucedido; verifique o código comercial, 200 significa sucesso. | Inline |
Esquema da resposta
Valores enumerados
| Propriedade | Valor |
|---|---|
| read_status | 0 |
| read_status | 1 |
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
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| id | query | integer | true | nenhum |
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
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | HTTP bem-sucedido; verifique o código comercial, 200 significa sucesso. | Inline |
Esquema da resposta
Valores enumerados
| Propriedade | Valor |
|---|---|
| read_status | 0 |
| read_status | 1 |
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
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| body | body | object | true | nenhum |
| » id | body | integer | true | nenhum |
Exemplos de resposta
Resposta 200
{
"code": 200,
"msg": "SUCCESS",
"data": null,
"request_id": "string"
}
Respostas
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | HTTP bem-sucedido; verifique o código comercial, 200 significa sucesso. | Inline |
Esquema da resposta
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
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| body | body | object | true | nenhum |
| » ids | body | [integer] | true | nenhum |
Exemplos de resposta
Resposta 200
{
"code": 200,
"msg": "SUCCESS",
"data": null,
"request_id": "string"
}
Respostas
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | HTTP bem-sucedido; verifique o código comercial, 200 significa sucesso. | Inline |
Esquema da resposta
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
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | HTTP bem-sucedido; verifique o código comercial, 200 significa sucesso. | Inline |
Esquema da resposta
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
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | HTTP bem-sucedido; verifique o código comercial, 200 significa sucesso. | Inline |
Esquema da resposta
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
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | HTTP bem-sucedido; verifique o código comercial, 200 significa sucesso. | Inline |
Esquema da resposta
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
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| id | query | integer | true | nenhum |
Exemplos de resposta
Resposta 200
{
"code": 200,
"msg": "SUCCESS",
"data": {
"scenes": [
0
],
"subscribe_all": true
},
"request_id": "string"
}
Respostas
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | HTTP bem-sucedido; verifique o código comercial, 200 significa sucesso. | Inline |
Esquema da resposta
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
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | HTTP bem-sucedido; verifique o código comercial, 200 significa sucesso. | Inline |
Esquema da resposta
Valores enumerados
| Propriedade | Valor |
|---|---|
| status | 0 |
| status | 1 |
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
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| body | body | object | true | nenhum |
| » status | body | integer | true | nenhum |
Valores enumerados
| Parameter | Value |
|---|---|
| » status | 0 |
| » status | 1 |
Exemplos de resposta
Resposta 200
{
"code": 200,
"msg": "SUCCESS",
"data": null,
"request_id": "string"
}
Respostas
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | HTTP bem-sucedido; verifique o código comercial, 200 significa sucesso. | Inline |
Esquema da resposta
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
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | HTTP bem-sucedido; verifique o código comercial, 200 significa sucesso. | Inline |
Esquema da resposta
Valores enumerados
| Propriedade | Valor |
|---|---|
| enabled | 0 |
| enabled | 1 |
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
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| body | body | object | true | nenhum |
| » udp | body | integer | true | nenhum |
Valores enumerados
| Parameter | Value |
|---|---|
| » udp | 0 |
| » udp | 1 |
Exemplos de resposta
Resposta 200
{
"code": 200,
"msg": "SUCCESS",
"data": {
"enabled": 0
},
"request_id": "string"
}
Respostas
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | HTTP bem-sucedido; verifique o código comercial, 200 significa sucesso. | Inline |
Esquema da resposta
Valores enumerados
| Propriedade | Valor |
|---|---|
| enabled | 0 |
| enabled | 1 |
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
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| team_id | query | TeamPublicId | true | nenhum |
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
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | HTTP bem-sucedido; continue julgando o código do corpo da resposta | Inline |
Esquema da resposta
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
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| team_id | query | TeamPublicId | true | nenhum |
| page | query | integer | false | nenhum |
| page_size | query | integer | false | nenhum |
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
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | HTTP bem-sucedido; continue julgando o código do corpo da resposta | Inline |
Esquema da resposta
Valores enumerados
| Propriedade | Valor |
|---|---|
| direction | 0 |
| direction | 1 |
| transaction_type | 1 |
| transaction_type | 2 |
| transaction_type | 3 |
| transaction_type | 4 |
| transaction_type | 5 |
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
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| body | body | object | true | nenhum |
| » team_id | body | TeamPublicId | true | 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 |
| » amount | body | number(double) | true | nenhum |
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
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | HTTP bem-sucedido; continue julgando o código do corpo da resposta | Inline |
Esquema da resposta
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
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| body | body | object | true | nenhum |
| » team_id | body | TeamPublicId | true | 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 |
| » amount | body | number(double) | true | Nã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
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | HTTP bem-sucedido; continue julgando o código do corpo da resposta | Inline |
Esquema da resposta
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
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| team_id | query | ResourceSpaceId | false | A chave da equipe pode ser omitida; quando repassado, deve ser consistente com a equipe à qual a Chave está vinculada. |
| app_key | query | string(password) | true | chave de acesso |
| cc | query | string | false | País ou região |
| state | query | string | false | província ou estado |
| city | query | string | false | cidade |
| format | query | string | false | Obter formato |
| lb | query | string | false | Separador, válido apenas em formato de texto |
| num | query | number | false | Extrair quantidade |
| life | query | number | false | Período de espera - minutos |
| ep | query | string | false | rede proxy |
Valores enumerados
| Parameter | Value |
|---|---|
| ep | us |
| ep | hk |
| ep | de |
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
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | Solicitação bem-sucedida | Inline |
Esquema da resposta
Status Code 200
| Nome | Tipo | Obrigatório | Restrições | Descrição |
|---|---|---|---|---|
| » code | integer | true | nenhum | Código de status, 200 bem-sucedido, 3 app_key inválido, 156 conta não autenticada. |
| » msg | string | true | nenhum | mensagem de estado |
| » data | object | false | nenhum | none |
| »» list | [any] | false | nenhum | none |
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
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | Solicitação bem-sucedida | Inline |
Esquema da resposta
Status Code 200
| Nome | Tipo | Obrigatório | Restrições | Descrição |
|---|---|---|---|---|
| » code | integer | true | nenhum | Código de status, 200 bem-sucedido, 3 app_key inválido, 156 conta não autenticada. |
| » msg | string | true | nenhum | mensagem de estado |
| » data | object | false | nenhum | none |
| »» list | [object] | false | nenhum | lista |
| »»» name_zh_cn | string | false | nenhum | Nome do país ou região |
| »»» name_en | string | false | nenhum | Nome do país ou região |
| »»» continent_code | string | false | nenhum | código do continente |
| »»» country_code | string | false | nenhum | Código do país ou região |
| »»» items | [any] | false | nenhum | província ou estado |
| »»»» city | string | false | nenhum | nome da cidade |
| »»»» state | string | false | nenhum | Código do nome da província ou estado |
| »»»» continent_code | string | false | nenhum | código do continente |
| »»»» country_code | string | false | nenhum | Código do país ou região |
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
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| team_id | query | ResourceSpaceId | false | nenhum |
| start_date | query | string(date) | false | Padrão há 6 dias |
| end_date | query | string(date) | false | Padrão hoje |
| product_type | query | integer | false | nenhum |
Valores enumerados
| Parameter | Value |
|---|---|
| product_type | 9 |
| product_type | 17 |
| product_type | 22 |
Exemplos de resposta
Resposta 200
{
"code": 0,
"msg": "string",
"request_id": "string",
"data": {
"list": [
{
"count": 0,
"date": "2019-08-24"
}
]
}
}
Respostas
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | Solicitação bem-sucedida | Inline |
Esquema da resposta
Status Code 200
| Nome | Tipo | Obrigatório | Restrições | Descrição |
|---|---|---|---|---|
| » code | integer | false | nenhum | none |
| » msg | string | false | nenhum | none |
| » request_id | string | false | nenhum | none |
| » data | object | false | nenhum | none |
| »» list | [object] | false | nenhum | none |
| »»» count | integer | true | nenhum | none |
| »»» date | string(date) | true | nenhum | none |
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
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| team_id | query | ResourceSpaceId | false | A chave da equipe pode ser omitida; quando repassado, deve ser consistente com a equipe à qual a Chave está vinculada. |
| app_key | query | string(password) | true | chave de acesso |
| cc | query | string | false | País ou região |
| state | query | string | false | província ou estado |
| city | query | string | false | cidade |
| format | query | string | false | Obter formato |
| lb | query | string | false | Separador, válido apenas em formato de texto |
| num | query | number | false | Extrair quantidade |
| life | query | number | false | Período de espera - minutos |
| ep | query | string | false | rede proxy |
Valores enumerados
| Parameter | Value |
|---|---|
| ep | us |
| ep | hk |
| ep | de |
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
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | Solicitação bem-sucedida | Inline |
Esquema da resposta
Status Code 200
| Nome | Tipo | Obrigatório | Restrições | Descrição |
|---|---|---|---|---|
| » code | integer | true | nenhum | Código de status, 200 bem-sucedido, 3 app_key inválido, 156 conta não autenticada. |
| » msg | string | true | nenhum | mensagem de estado |
| » data | object | false | nenhum | none |
| »» list | [any] | false | nenhum | none |
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
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| username | query | string | true | Nome 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
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | Solicitação bem-sucedida | Inline |
Esquema da resposta
Status Code 200
| Nome | Tipo | Obrigatório | Restrições | Descrição |
|---|---|---|---|---|
| » code | integer | false | nenhum | Código de status, 200 sucessos |
| » msg | string | false | nenhum | mensagem de estado |
| » data | object | false | nenhum | none |
| »» cache | boolean | false | nenhum | Quer venha do cache |
| »» list | [object] | false | nenhum | none |
| »»» City | string | false | nenhum | cidade |
| »»» Area | string | false | nenhum | área |
| »»» State | string | false | nenhum | Estado/Província |
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
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| username | query | string | true | Nome 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
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | Solicitação bem-sucedida | Inline |
Esquema da resposta
Status Code 200
| Nome | Tipo | Obrigatório | Restrições | Descrição |
|---|---|---|---|---|
| » code | integer | false | nenhum | Código de status, 200 sucessos |
| » msg | string | false | nenhum | mensagem de estado |
| » data | object | false | nenhum | none |
| »» cache | boolean | false | nenhum | Quer venha do cache |
| »» list | [object] | false | nenhum | none |
| »»» City | string | false | nenhum | cidade |
| »»» Area | string | false | nenhum | área |
| »»» State | string | false | nenhum | Estado/Província |
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
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| username | query | string | true | Nome 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
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | Solicitação bem-sucedida | Inline |
Esquema da resposta
Status Code 200
| Nome | Tipo | Obrigatório | Restrições | Descrição |
|---|---|---|---|---|
| » code | integer | false | nenhum | Código de status, 200 sucessos |
| » msg | string | false | nenhum | mensagem de estado |
| » data | object | false | nenhum | none |
| »» cache | boolean | false | nenhum | Quer venha do cache |
| »» list | [object] | false | nenhum | Lista de áreas |
| »»» Area | string | false | nenhum | código de área |
| »»» states | [object] | false | nenhum | Lista de estados/províncias |
| »»»» State | string | false | nenhum | Nome do estado/província |
| »»»» cities | [string] | false | nenhum | Lista de cidades |
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
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | Solicitação bem-sucedida | Inline |
Esquema da resposta
Status Code 200
| Nome | Tipo | Obrigatório | Restrições | Descrição |
|---|---|---|---|---|
| » code | integer | true | nenhum | Código de status, 200 bem-sucedido, 3 app_key inválido, 156 conta não autenticada. |
| » msg | string | true | nenhum | mensagem de estado |
| » data | object | false | nenhum | none |
| »» list | [object] | false | nenhum | lista |
| »»» name_zh_cn | string | false | nenhum | Nome do país ou região |
| »»» name_en | string | false | nenhum | Nome do país ou região |
| »»» continent_code | string | false | nenhum | código do continente |
| »»» country_code | string | false | nenhum | Código do país ou região |
| »»» items | [any] | false | nenhum | província ou estado |
| »»»» city | string | false | nenhum | nome da cidade |
| »»»» state | string | false | nenhum | Código do nome da província ou estado |
| »»»» continent_code | string | false | nenhum | código do continente |
| »»»» country_code | string | false | nenhum | Código do país ou região |
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
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| country_code | query | string | true | Código do país ou região |
| state | query | string | true | Código do estado ou província |
Exemplos de resposta
Resposta 200
{
"code": 200,
"msg": "string",
"data": {
"list": [
"string"
]
}
}
Respostas
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | Solicitação bem-sucedida | Inline |
Esquema da resposta
Status Code 200
| Nome | Tipo | Obrigatório | Restrições | Descrição |
|---|---|---|---|---|
| » code | integer | true | nenhum | Código de status, 200 bem-sucedido, 3 app_key inválido, 156 conta não autenticada. |
| » msg | string | true | nenhum | mensagem de estado |
| » data | object | false | nenhum | none |
| »» list | [string] | false | nenhum | lista |
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
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | Solicitação bem-sucedida | Inline |
Esquema da resposta
Status Code 200
| Nome | Tipo | Obrigatório | Restrições | Descrição |
|---|---|---|---|---|
| » code | integer | true | nenhum | Código de status, 200 bem-sucedido, 3 app_key inválido, 156 conta não autenticada. |
| » msg | string | true | nenhum | mensagem de estado |
| » data | object | false | nenhum | none |
| »» list | [object] | false | nenhum | lista |
| »»» name_zh_cn | string | false | nenhum | Nome do país ou região |
| »»» name_en | string | false | nenhum | Nome do país ou região |
| »»» continent_code | string | false | nenhum | código do continente |
| »»» country_code | string | false | nenhum | Código do país ou região |
| »»» items | [any] | false | nenhum | província ou estado |
| »»»» state | string | false | nenhum | Código do nome da província ou estado |
| »»»» continent_code | string | false | nenhum | código do continente |
| »»»» country_code | string | false | nenhum | Código do país ou região |
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
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| country_code | query | string | true | Código do país ou região |
Exemplos de resposta
Resposta 200
{
"code": 200,
"msg": "string",
"data": {
"list": [
"string"
]
}
}
Respostas
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | Solicitação bem-sucedida | Inline |
Esquema da resposta
Status Code 200
| Nome | Tipo | Obrigatório | Restrições | Descrição |
|---|---|---|---|---|
| » code | integer | true | nenhum | Código de status, 200 bem-sucedido, 3 app_key inválido, 156 conta não autenticada. |
| » msg | string | true | nenhum | mensagem de estado |
| » data | object | false | nenhum | none |
| »» list | [string] | false | nenhum | lista |
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
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| team_id | query | ResourceSpaceId | false | Identificador 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 |
| area | query | string | false | Código do país |
| status | query | integer | false | 0=todos, 1=válido, 2=expirado |
| trade_no | query | string | false | Número do pedido |
| created_at | query | array[string] | false | Para criar um intervalo de tempo, o horário de início e de término deve ser passado ao mesmo tempo. |
Valores enumerados
| Parameter | Value |
|---|---|
| status | 0 |
| status | 1 |
| status | 2 |
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
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | Solicitação bem-sucedida | Inline |
Esquema da resposta
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
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| country_code | query | string | false | Código do país ou região |
| product_type | query | number | false | Tipo de produto, 25: IP residencial estático, 14: IP de data center |
| trade_no | query | string | false | Filtrar IP por número de pedido |
| page | query | number | false | Número da página |
| size | query | number | false | Quantidade por página |
| status | query | number | false | Status, 1: válido, 2: inválido, 3: prestes a expirar, 4: em manutenção |
Valores enumerados
| Parameter | Value |
|---|---|
| product_type | 14 |
| product_type | 25 |
| status | 1 - 2 - 3 - 4 |
Respostas
| Status | Significado | Descrição | Esquema |
|---|
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
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| isp | query | integer | false | Filtragem ISP, sem filtragem se não for transmitido (o padrão é 1, exceto site 1/4/5) |
| asn | query | integer | false | Se deve retornar dados de pacotes ASN |
| exclusive | query | integer | false | Se 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)
| valor | descrição |
|---|---|
| 0 | IP estático do data center (IDC) |
| 1 | IP estático inicial (ISP) |
asn: Se deve retornar dados de pacotes ASN
| valor | descrição |
|---|---|
| 0 | Não retornar dados de pacotes ASN (padrão) |
| 1 | Retornar dados do pacote ASN |
exclusive: Se deve contar de acordo com o inventário exclusivo
| valor | descrição |
|---|---|
| 0 | Estatísticas baseadas no calibre atual do usuário/grupo de compartilhamento (padrão) |
| 1 | Exclua todos os IPs atribuídos e conte apenas o inventário disponível |
Valores enumerados
| Parameter | Value |
|---|---|
| isp | 0 |
| isp | 1 |
| asn | 0 |
| asn | 1 |
| exclusive | 0 |
| exclusive | 1 |
Exemplos de resposta
Resposta 200
{
"code": 200,
"msg": "请求成功",
"data": {
"list": [
{
"code": "US",
"number": 55
}
]
}
}
Respostas
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | Solicitação bem-sucedida | Inline |
Esquema da resposta
Status Code 200
| Nome | Tipo | Obrigatório | Restrições | Descrição |
|---|---|---|---|---|
| » code | integer | true | nenhum | Código de status, 200 sucessos |
| » msg | string | true | nenhum | mensagem de estado |
| » data | object | false | nenhum | none |
| »» list | [any] | false | nenhum | none |
| »»» code | string | true | nenhum | Código do país ou região |
| »»» number | integer | true | nenhum | Quantidade |
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
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | Solicitação bem-sucedida | Inline |
Esquema da resposta
Status Code 200
| Nome | Tipo | Obrigatório | Restrições | Descrição |
|---|---|---|---|---|
| » code | integer | true | nenhum | Código de status, 200 sucessos |
| » msg | string | true | nenhum | mensagem de estado |
| » data | object | false | nenhum | none |
| »» list | [object] | false | nenhum | none |
| »»» code | string | true | nenhum | Código do país ou região, ISO 3166-1 alfa-2 |
| »»» number | integer | true | nenhum | Número de IPs de data center disponíveis no site atual |
| »»» name_zh_cn | string | false | nenhum | Nome chinês do país ou região |
| »»» name_en | string | false | nenhum | Nome inglês do país ou região |
| »»» square_flag | string | false | nenhum | URL da imagem da bandeira quadrada |
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
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| team_id | query | ResourceSpaceId | false | Identificador de espaço de recursos; espaço pessoal omite ou passa uma string vazia |
| product_type | query | integer | false | Nú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
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | Solicitação bem-sucedida | Inline |
Esquema da resposta
Status Code 200
| Nome | Tipo | Obrigatório | Restrições | Descrição |
|---|---|---|---|---|
| » code | integer | false | nenhum | Código de status, 200 sucessos |
| » msg | string | false | nenhum | mensagem de estado |
| » data | object | false | nenhum | none |
| »» list | [object] | false | nenhum | none |
| »»» ip | string | false | nenhum | IP da lista de permissões |
| »»» remark | string | false | nenhum | Observações |
| »»» product_type | integer | false | nenhum | Tipo de pacote |
| »»» created_at | string | false | nenhum | hora de criação |
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
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| body | body | object | false | nenhum |
| » team_id | body | any | false | 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 |
| »» anonymous | body | string | false | nenhum |
| »» anonymous | body | TeamPublicId | false | 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 |
| » app_key | body | string | false | Chave de autorização |
| » ips | body | string | true | Coloque IPs na lista de permissões que precisam ser adicionados, separe vários deles com vírgulas ou novas linhas. |
| » remark | body | string | false | Observações |
| » product_type | body | integer | false | Número do tipo de pacote |
| » user_product_id | body | integer | false | ID 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
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | Solicitação bem-sucedida | Inline |
Esquema da resposta
Status Code 200
| Nome | Tipo | Obrigatório | Restrições | Descrição |
|---|---|---|---|---|
| » code | integer | false | nenhum | Código de status, 200 sucessos |
| » msg | string | false | nenhum | mensagem de estado |
| » data | null | false | nenhum | none |
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
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| body | body | object | false | nenhum |
| » team_id | body | any | false | 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 |
| »» anonymous | body | string | false | nenhum |
| »» anonymous | body | TeamPublicId | false | 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 |
| » app_key | body | string | false | Chave de autorização |
| » ips | body | string | true | Lista de permissões de IPs que precisam ser excluídos, vários separados por vírgulas |
| » verify_type | body | string | false | Tipo de verificação: telefone, email, wechat, totp |
| » verify_code | body | string | false | Código de verificação |
Exemplos de resposta
Resposta 200
{
"code": 200,
"msg": "string",
"data": null
}
Respostas
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | Solicitação bem-sucedida | Inline |
Esquema da resposta
Status Code 200
| Nome | Tipo | Obrigatório | Restrições | Descrição |
|---|---|---|---|---|
| » code | integer | false | nenhum | Código de status, 200 sucessos |
| » msg | string | false | nenhum | mensagem de estado |
| » data | null | false | nenhum | none |
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
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| team_id | query | ResourceSpaceId | false | Identificador de espaço de recursos; espaço pessoal omite ou passa uma string vazia |
| product_type | query | integer | false | Nú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
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | Solicitação bem-sucedida | Inline |
Esquema da resposta
Status Code 200
| Nome | Tipo | Obrigatório | Restrições | Descrição |
|---|---|---|---|---|
| » code | integer | false | nenhum | Código de status, 200 sucessos |
| » msg | string | false | nenhum | mensagem de estado |
| » data | object | false | nenhum | none |
| »» list | [object] | false | nenhum | none |
| »»» ip | string | false | nenhum | IP da lista de permissões |
| »»» remark | string | false | nenhum | Observações |
| »»» product_type | integer | false | nenhum | Tipo de pacote |
| »»» created_at | string | false | nenhum | hora de criação |
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
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| body | body | object | false | nenhum |
| » team_id | body | any | false | 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 |
| »» anonymous | body | string | false | nenhum |
| »» anonymous | body | TeamPublicId | false | 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 |
| » app_key | body | string | false | Chave de autorização |
| » ips | body | string | true | Coloque IPs na lista de permissões que precisam ser adicionados, separe vários deles com vírgulas ou novas linhas. |
| » remark | body | string | false | Observações |
| » product_type | body | integer | false | Número do tipo de pacote |
| » user_product_id | body | integer | false | ID 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
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | Solicitação bem-sucedida | Inline |
Esquema da resposta
Status Code 200
| Nome | Tipo | Obrigatório | Restrições | Descrição |
|---|---|---|---|---|
| » code | integer | false | nenhum | Código de status, 200 sucessos |
| » msg | string | false | nenhum | mensagem de estado |
| » data | null | false | nenhum | none |
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
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| body | body | object | false | nenhum |
| » team_id | body | any | false | 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 |
| »» anonymous | body | string | false | nenhum |
| »» anonymous | body | TeamPublicId | false | 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 |
| » app_key | body | string | false | Chave de autorização |
| » ips | body | string | true | Lista de permissões de IPs que precisam ser excluídos, vários separados por vírgulas |
| » verify_type | body | string | false | Tipo de verificação: telefone, email, wechat, totp |
| » verify_code | body | string | false | Código de verificação |
Exemplos de resposta
Resposta 200
{
"code": 200,
"msg": "string",
"data": null
}
Respostas
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | Solicitação bem-sucedida | Inline |
Esquema da resposta
Status Code 200
| Nome | Tipo | Obrigatório | Restrições | Descrição |
|---|---|---|---|---|
| » code | integer | false | nenhum | Código de status, 200 sucessos |
| » msg | string | false | nenhum | mensagem de estado |
| » data | null | false | nenhum | none |
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
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| body | body | object | true | nenhum |
| » team_id | body | any | false | 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 |
| »» anonymous | body | string | false | nenhum |
| »» anonymous | body | TeamPublicId | false | 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 |
| » ip | body | string(ipv4) | true | nenhum |
| » remark | body | string | true | nenhum |
Exemplos de resposta
Resposta 200
{
"code": 200,
"msg": "SUCCESS",
"data": {},
"request_id": "string"
}
Respostas
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | Operação bem-sucedida | WebV1SuccessResponse |
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
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| body | body | object | false | nenhum |
| » team_id | body | any | false | 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 |
| »» anonymous | body | string | false | nenhum |
| »» anonymous | body | TeamPublicId | false | 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 |
Exemplos de resposta
Resposta 200
{
"code": 200,
"msg": "SUCCESS",
"data": {},
"request_id": "string"
}
Respostas
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | Operação bem-sucedida | WebV1SuccessResponse |
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
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| team_id | query | ResourceSpaceId | false | nenhum |
| product_type | query | integer | true | nenhum |
Exemplos de resposta
Resposta 200
{
"code": 200,
"msg": "SUCCESS",
"data": {},
"request_id": "string"
}
Respostas
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | Operação bem-sucedida | WebV1SuccessResponse |
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
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| team_id | query | ResourceSpaceId | false | nenhum |
Exemplos de resposta
Resposta 200
{
"code": 200,
"msg": "SUCCESS",
"data": {},
"request_id": "string"
}
Respostas
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | Operação bem-sucedida | WebV1SuccessResponse |
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
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| body | body | object | false | nenhum |
| » team_id | body | any | false | 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 |
| »» anonymous | body | string | false | nenhum |
| »» anonymous | body | TeamPublicId | false | 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 |
| » days | body | integer | false | nenhum |
| » product_type | body | integer | false | nenhum |
| » username | body | string | false | nenhum |
Exemplos de resposta
Resposta 200
{
"code": 200,
"msg": "SUCCESS",
"data": {
"list": [
{
"days": "2019-08-24",
"flow": 0
}
],
"days": 1
},
"request_id": "string"
}
Respostas
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | Solicitação bem-sucedida | Inline |
Esquema da resposta
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
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| body | body | object | false | nenhum |
| » team_id | body | any | false | 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 |
| »» anonymous | body | string | false | nenhum |
| »» anonymous | body | TeamPublicId | false | 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 |
Exemplos de resposta
Resposta 200
{
"code": 200,
"msg": "SUCCESS",
"data": {
"list": [
{
"username": "string",
"flow": 0
}
]
},
"request_id": "string"
}
Respostas
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | Solicitação bem-sucedida | Inline |
Esquema da resposta
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
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| body | body | object | false | nenhum |
| » team_id | body | any | false | 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 |
| »» anonymous | body | string | false | nenhum |
| »» anonymous | body | TeamPublicId | false | 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 |
Exemplos de resposta
Resposta 200
Respostas
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | Arquivo CSV codificado em GBK | string |
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
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| team_id | query | ResourceSpaceId | false | nenhum |
| unit | query | string | false | nenhum |
Valores enumerados
| Parameter | Value |
|---|---|
| unit | KB |
| unit | MB |
| unit | GB |
| unit | TB |
| unit | PB |
Exemplos de resposta
Resposta 200
{
"code": 200,
"msg": "SUCCESS",
"data": {
"limit": 0,
"total": 0,
"remain": 0,
"unit": "KB",
"timestamp": 0
},
"request_id": "string"
}
Respostas
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | Solicitação bem-sucedida | Inline |
Esquema da resposta
Valores enumerados
| Propriedade | Valor |
|---|---|
| unit | KB |
| unit | MB |
| unit | GB |
| unit | TB |
| unit | PB |
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
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| team_id | query | ResourceSpaceId | false | nenhum |
| start | query | string(date) | false | nenhum |
| end | query | string(date) | false | nenhum |
| username | query | string | false | nenhum |
| user_product_id | query | integer | false | nenhum |
Exemplos de resposta
Resposta 200
{
"code": 200,
"msg": "SUCCESS",
"data": {
"list": [
{
"date": "2019-08-24",
"rate": 0,
"corrent": 0
}
]
},
"request_id": "string"
}
Respostas
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | Solicitação bem-sucedida | Inline |
Esquema da resposta
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
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| team_id | query | ResourceSpaceId | false | nenhum |
| start_time | query | string | false | nenhum |
| end_time | query | string | false | nenhum |
| product_type | query | integer | false | nenhum |
| username | query | string | false | nenhum |
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
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | Solicitação bem-sucedida | Inline |
Esquema da resposta
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
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| team_id | query | ResourceSpaceId | false | Identificador de espaço de recursos; espaço pessoal omite ou passa uma string vazia |
| app_key | query | string(password) | true | Chave de autenticação |
| start_time | query | string(Y-m-d H:i:s) | false | Hora de início, com precisão de segundos. Observe que o registro é atrasado em 5 minutos. O padrão é dentro de 7 dias. |
| end_time | query | string(Y-m-d H:i:s) | false | Prazo, com precisão de segundos. Observe que o registro é atrasado em 5 minutos. Hora atual padrão. |
| username | query | string | false | Nome 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_type | query | number | false | Tipo de pacote |
Exemplos de resposta
Resposta 200
{
"code": 200,
"msg": "string",
"data": {
"list": [
{
"day": "2022-08-01",
"flow": 0
}
]
}
}
Respostas
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | Solicitação bem-sucedida | Inline |
Esquema da resposta
Status Code 200
| Nome | Tipo | Obrigatório | Restrições | Descrição |
|---|---|---|---|---|
| » code | integer | true | nenhum | Código de status, 200 bem-sucedido, 3 app_key inválido, 156 conta não autenticada. |
| » msg | string | true | nenhum | mensagem de estado |
| » data | object | false | nenhum | none |
| »» list | [object] | false | nenhum | none |
| »»» day | string | false | nenhum | Data |
| »»» flow | integer | false | nenhum | Tráfego de consumo, unidade KB |
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
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| team_id | query | ResourceSpaceId | false | nenhum |
| start_time | query | string(date) | false | nenhum |
| end_time | query | string(date) | false | nenhum |
| export | query | string | false | nenhum |
Valores enumerados
| Parameter | Value |
|---|---|
| export | csv |
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
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | Resultados estatísticos JSON; O arquivo CSV é retornado quando export=csv | string |
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
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| team_id | query | ResourceSpaceId | false | nenhum |
| start_time | query | string(date) | false | nenhum |
| end_time | query | string(date) | false | nenhum |
| export | query | string | false | nenhum |
Valores enumerados
| Parameter | Value |
|---|---|
| export | csv |
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
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | Resultado da proporção JSON; O arquivo CSV é retornado quando export=csv | string |
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
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| team_id | query | ResourceSpaceId | false | Identificador de espaço de recursos; espaço pessoal omite ou passa uma string vazia |
| app_key | query | string(password) | true | Chave de autenticação |
| trade_no | query | string | false | Número do pedido, insira o número completo do pedido. A pesquisa difusa não é suportada. |
| page | query | number | false | Paginação, padrão: 1 |
| size | query | number | false | Número de páginas exibidas, padrão: 20 |
| product_type | query | number | false | Tipo 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
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | Solicitação bem-sucedida | Inline |
Esquema da resposta
Status Code 200
| Nome | Tipo | Obrigatório | Restrições | Descrição |
|---|---|---|---|---|
| » code | integer | true | nenhum | Código de status, 200 bem-sucedido, 3 app_key inválido, 156 conta não autenticada. |
| » msg | string | true | nenhum | mensagem de estado |
| » data | object | false | nenhum | none |
| »» list | [object] | false | nenhum | none |
| »»» id | integer | false | nenhum | Número do pacote |
| »»» created_at | string | false | nenhum | Tempo efetivo do pacote |
| »»» expired_at | string | false | nenhum | O prazo de validade do pacote. Após a expiração, o tráfego não poderá ser usado. |
| »»» product_type | productTypes | false | nenhum | 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 |
| »»» trade_no | string | false | nenhum | Número da transação do pedido |
| »»» order | object | false | nenhum | none |
| »»»» created_at | string | false | nenhum | Hora de criação do pedido |
| »»»» pay_at | string | false | nenhum | Prazo de pagamento do pedido |
| »»»» title | string | false | nenhum | Descrição do pedido |
| »» page | integer | true | nenhum | Página atual |
| »» page_size | integer | false | nenhum | tamanho da paginação |
| »» total_count | integer | false | nenhum | Número total de registros |
| »» total_page | integer | false | nenhum | Número total de páginas |
Valores enumerados
| Propriedade | Valor |
|---|---|
| product_type | 9 |
| product_type | 11 |
| product_type | 14 |
| product_type | 25 |
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
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| team_id | query | ResourceSpaceId | false | Identificador de espaço de recursos; espaço pessoal omite ou passa uma string vazia |
| app_key | query | string(password) | true | Chave de autenticação |
| product_type | query | integer | false | Tipo de produto, suporta apenas 9 (pacote de tráfego dinâmico), 12 (pacote de tráfego IDC de longo prazo) |
Valores enumerados
| Parameter | Value |
|---|---|
| product_type | 9 |
| product_type | 12 |
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
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | Solicitação bem-sucedida | Inline |
Esquema da resposta
Status Code 200
| Nome | Tipo | Obrigatório | Restrições | Descrição |
|---|---|---|---|---|
| » code | integer | false | nenhum | Código de status, 200 bem-sucedido, 3 app_key inválido, 156 conta não autenticada. |
| » msg | string | false | nenhum | mensagem de estado |
| » data | object | false | nenhum | none |
| »» total | integer | false | nenhum | Tráfego/volume total de IP (unidade: KB) |
| »» total_count | integer | false | nenhum | Número total de pacotes |
| »» effective | integer | false | nenhum | Valor restante efetivo (unidade: KB) |
| »» effective_count | integer | false | nenhum | Número de pacotes válidos |
| »» effective_total | integer | false | nenhum | Valor total efetivo (unidade: KB) |
| »» effective_used | integer | false | nenhum | Quantidade efetiva utilizada (unidade: KB) |
| »» temporary | integer | false | nenhum | Valor total devido (vencimento em até 7 dias, unidade: KB) |
| »» temporary_count | integer | false | nenhum | Número de pacotes vencidos (validade em 7 dias) |
| »» expired | integer | false | nenhum | Quantidade restante expirada (unidade: KB) |
| »» expired_count | integer | false | nenhum | Número de pacotes expirados |
| »» used | integer | false | nenhum | Quantidade total usada (unidade: KB) |
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
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| body | body | object | false | nenhum |
| » team_id | body | any | false | 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 |
| »» anonymous | body | string | false | nenhum |
| »» anonymous | body | TeamPublicId | false | 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 |
| » status | body | integer | false | nenhum |
| » page | body | integer | false | nenhum |
| » size | body | integer | false | nenhum |
| » user_product_id | body | integer | false | nenhum |
| » country_code | body | string | false | nenhum |
| » product_type | body | integer | false | nenhum |
| » ip | body | string(ipv4) | false | nenhum |
| » auto_renewal | body | integer | false | nenhum |
| » support_renewal | body | integer | false | nenhum |
| » remaining_days | body | integer | false | nenhum |
| » limit_days | body | integer | false | nenhum |
| » sort | body | string | false | nenhum |
| » remark | body | string | false | nenhum |
Valores enumerados
| Parameter | Value |
|---|---|
| » auto_renewal | 0 |
| » auto_renewal | 1 |
| » support_renewal | 0 |
| » support_renewal | 1 |
| » sort | exp_asc |
| » sort | exp_desc |
Exemplos de resposta
Resposta 200
{
"code": 200,
"msg": "SUCCESS",
"data": {},
"request_id": "string"
}
Respostas
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | Operação bem-sucedida | WebV1SuccessResponse |
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
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| body | body | object | true | nenhum |
| » team_id | body | any | false | 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 |
| »» anonymous | body | string | false | nenhum |
| »» anonymous | body | TeamPublicId | false | 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 |
| » id | body | integer | true | nenhum |
Exemplos de resposta
Resposta 200
{
"code": 200,
"msg": "SUCCESS",
"data": {},
"request_id": "string"
}
Respostas
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | Operação bem-sucedida | WebV1SuccessResponse |
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
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| body | body | object | true | nenhum |
| » team_id | body | any | false | 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 |
| »» anonymous | body | string | false | nenhum |
| »» anonymous | body | TeamPublicId | false | 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 |
| » ids | body | [integer] | true | nenhum |
Exemplos de resposta
Resposta 200
{
"code": 200,
"msg": "SUCCESS",
"data": {},
"request_id": "string"
}
Respostas
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | Operação bem-sucedida | WebV1SuccessResponse |
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
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| body | body | object | true | nenhum |
| » team_id | body | any | false | 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 |
| »» anonymous | body | string | false | nenhum |
| »» anonymous | body | TeamPublicId | false | 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 |
| » id | body | integer | true | nenhum |
| » remark | body | string | true | nenhum |
Exemplos de resposta
Resposta 200
{
"code": 200,
"msg": "SUCCESS",
"data": {},
"request_id": "string"
}
Respostas
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | Operação bem-sucedida | WebV1SuccessResponse |
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
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| body | body | object | true | nenhum |
| » team_id | body | any | false | 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 |
| »» anonymous | body | string | false | nenhum |
| »» anonymous | body | TeamPublicId | false | 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 |
| » ids | body | [integer] | true | nenhum |
| » udp | body | integer | true | nenhum |
Valores enumerados
| Parameter | Value |
|---|---|
| » udp | 0 |
| » udp | 1 |
Exemplos de resposta
Resposta 200
{
"code": 200,
"msg": "SUCCESS",
"data": {},
"request_id": "string"
}
Respostas
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | Operação bem-sucedida | WebV1SuccessResponse |
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
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| body | body | object | true | nenhum |
| » team_id | body | any | false | 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 |
| »» anonymous | body | string | false | nenhum |
| »» anonymous | body | TeamPublicId | false | 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 |
| » id | body | integer | true | ID do plano do usuário |
| » country_code | body | string | false | Código do país/região de destino; se não for aprovado, o país/região do IP atual será usado primeiro. |
| » ip | body | string | false | Filtragem 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
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | Solicitação bem-sucedida | Inline |
Esquema da resposta
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
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| team_id | query | ResourceSpaceId | false | Identificador de espaço de recursos; espaço pessoal omite ou passa uma string vazia |
| page | query | integer | false | nenhum |
| page_size | query | integer | false | nenhum |
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
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | Solicitação bem-sucedida | Inline |
Esquema da resposta
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
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| body | body | object | true | nenhum |
| » team_id | body | any | false | 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 |
| »» anonymous | body | string | false | nenhum |
| »» anonymous | body | TeamPublicId | false | 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 |
| » user_product_id | body | integer | true | nenhum |
| » status | body | integer | false | 0=desativar, 1=ativar |
Valores enumerados
| Parameter | Value |
|---|---|
| » status | 0 |
| » status | 1 |
Exemplos de resposta
Resposta 200
{
"code": 200,
"msg": "SUCCESS",
"data": {
"id": 1
},
"request_id": "string"
}
Respostas
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | Solicitação bem-sucedida | Inline |
Esquema da resposta
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
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| body | body | object | true | nenhum |
| » team_id | body | any | false | 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 |
| »» anonymous | body | string | false | nenhum |
| »» anonymous | body | TeamPublicId | false | 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 |
| » user_product_ids | body | [integer] | true | nenhum |
| » status | body | integer | false | 0=desativar, 1=ativar |
Valores enumerados
| Parameter | Value |
|---|---|
| » status | 0 |
| » status | 1 |
Exemplos de resposta
Resposta 200
{
"code": 200,
"msg": "SUCCESS",
"data": {
"results": [
{
"user_product_id": 1,
"success": true,
"id": 1
}
]
},
"request_id": "string"
}
Respostas
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | A solicitação foi bem-sucedida; cada pacote retorna os resultados do processamento de forma independente. | Inline |
Esquema da resposta
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
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| body | body | object | true | nenhum |
| » team_id | body | any | false | 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 |
| »» anonymous | body | string | false | nenhum |
| »» anonymous | body | TeamPublicId | false | 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 |
| » product_type | body | integer | true | nenhum |
| » days_before_expire | body | integer | false | nenhum |
| » traffic_threshold | body | integer | false | Unidades GB, suportadas apenas em 12/09/24 |
| » renewal_cycle_days | body | integer | false | Compatível apenas em 14/11/16/25 e deve ser o ciclo atual do produto à venda |
| » anonymous | body | object | false | nenhum |
| » anonymous | body | object | false | nenhum |
| » anonymous | body | object | false | nenhum |
Valores enumerados
| Parameter | Value |
|---|---|
| » product_type | 9 |
| » product_type | 11 |
| » product_type | 12 |
| » product_type | 14 |
| » product_type | 16 |
| » product_type | 24 |
| » product_type | 25 |
Exemplos de resposta
Resposta 200
{
"code": 200,
"msg": "SUCCESS",
"data": null,
"request_id": "string"
}
Respostas
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | A solicitação foi bem-sucedida, os dados são nulos | Inline |
Esquema da resposta
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
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| body | body | object | false | nenhum |
| » team_id | body | any | false | 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 |
| »» anonymous | body | string | false | nenhum |
| »» anonymous | body | TeamPublicId | false | 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 |
| » product_type | body | integer | false | Se não for aprovado, todos os tipos suportados serão retornados. |
Valores enumerados
| Parameter | Value |
|---|---|
| » product_type | 9 |
| » product_type | 11 |
| » product_type | 12 |
| » product_type | 14 |
| » product_type | 16 |
| » product_type | 24 |
| » product_type | 25 |
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
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | Solicitação bem-sucedida | Inline |
Esquema da resposta
Valores enumerados
| Propriedade | Valor |
|---|---|
| product_type | 9 |
| product_type | 11 |
| product_type | 12 |
| product_type | 14 |
| product_type | 16 |
| product_type | 24 |
| product_type | 25 |
| source | user |
| source | system |
| source | user |
| source | system |
| traffic_source | user |
| traffic_source | system |
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
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| body | body | object | true | nenhum |
| » team_id | body | any | false | 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 |
| »» anonymous | body | string | false | nenhum |
| »» anonymous | body | TeamPublicId | false | 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 |
| » user_product_id | body | integer | true | nenhum |
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
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | Solicitação bem-sucedida | Inline |
Esquema da resposta
Valores enumerados
| Propriedade | Valor |
|---|---|
| time_unit | day |
| time_unit | hour |
| status | 0 |
| status | 1 |
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
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| body | body | object | false | nenhum |
| » team_id | body | any | false | 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 |
| »» anonymous | body | string | false | nenhum |
| »» anonymous | body | TeamPublicId | false | 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 |
| » user_product_id | body | integer | false | Se não for aprovado, todos os registros no espaço atual serão consultados. |
| » page | body | integer | false | nenhum |
| » size | body | integer | false | nenhum |
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
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | Solicitação bem-sucedida | Inline |
Esquema da resposta
Valores enumerados
| Propriedade | Valor |
|---|---|
| trigger_type | 0 |
| trigger_type | 1 |
| status | 1 |
| status | 2 |
| status | 3 |
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
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| team_id | query | ResourceSpaceId | false | nenhum |
| trade_no | query | string | true | nenhum |
| pm_id | query | integer | false | nenhum |
Exemplos de resposta
Resposta 200
{
"code": 200,
"msg": "SUCCESS",
"data": {},
"request_id": "string"
}
Respostas
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | Operação bem-sucedida | WebV1SuccessResponse |
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
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| body | body | object | true | nenhum |
| » team_id | body | any | false | 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 |
| »» anonymous | body | string | false | nenhum |
| »» anonymous | body | TeamPublicId | false | 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 |
| » trade_no | body | string | true | nenhum |
| » pay_method | body | integer | false | nenhum |
| » pm_id | body | integer | false | nenhum |
| » trade_type | body | string | false | nenhum |
Exemplos de resposta
Resposta 200
{
"code": 200,
"msg": "SUCCESS",
"data": {},
"request_id": "string"
}
Respostas
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | Operação bem-sucedida | WebV1SuccessResponse |
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
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| team_id | query | ResourceSpaceId | false | nenhum |
| trade_no | query | string | true | nenhum |
| pm_id | query | integer | false | nenhum |
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
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | Solicitação bem-sucedida | Inline |
Esquema da resposta
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
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| team_id | query | ResourceSpaceId | false | nenhum |
| trade_no | query | string | true | nenhum |
| pm_id | query | integer | false | nenhum |
Exemplos de resposta
Resposta 200
"string"
Respostas
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | Página de pagamento HTML | string |
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
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| trade_no | query | string | false | Número do pedido - pode ser repassado quando alguns pedidos exigirem uma forma de pagamento específica |
| currency | query | string | false | unidade 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
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | obter sucesso | Inline |
Esquema da resposta
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
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| trade_no | query | string | false | Nú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
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | obter sucesso | Inline |
Esquema da resposta
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
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | OK | Inline |
Esquema da resposta
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
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| type | query | integer | false | Tipo de pacote, consulte a descrição da enumeração Product.type. Se não for aprovado, todos os tipos serão retornados. |
| parent_product_type | query | integer | false | Tipo 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_days | query | any | false | Filtragem por período de validade, suporta valor único ou matriz, como 30/[30,90,365] |
| show_type | query | any | false | Filtragem de tipo de exibição, suporta valor único ou matriz |
Valores enumerados
| Parameter | Value |
|---|---|
| parent_product_type | 14 |
| parent_product_type | 25 |
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
| Status | Significado | Descrição | Esquema |
|---|---|---|---|
| 200 | OK | OK | Inline |
Esquema da resposta
Esquemas
OpenApiAccountProfile
{
"id": 0,
"username": "string",
"nickname": "string",
"email": "string",
"balance": "string",
"gift_balance": "string",
"currency": "string",
"language": "string",
"timezone": "string"
}
Propriedades
| Nome | Tipo | Obrigatório | Restrições | Descrição |
|---|---|---|---|---|
| id | integer | true | nenhum | ID do usuário |
| username | string | true | nenhum | Nome de usuário |
| nickname | string | true | nenhum | Apelido |
| string | true | nenhum | Vincular e-mail | |
| balance | string | true | nenhum | Saldo de recarga, string decimal |
| gift_balance | string | true | nenhum | Saldo de bônus atual, sequência decimal |
| currency | string | true | nenhum | Moeda do site |
| language | string | true | nenhum | Idioma do usuário, o idioma do site será usado se não estiver configurado |
| timezone | string | true | nenhum | Fuso 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
| Nome | Tipo | Obrigatório | Restrições | Descrição |
|---|---|---|---|---|
| id | integer,string | false | nenhum | Os valores do banco de dados podem ser serializados como strings |
| re_type | integer,string | false | nenhum | 0 despesas, 1 receita |
| transaction_type | integer,string | false | nenhum | tipo de transação |
| balance_type | integer,string | false | nenhum | Tipo de saldo |
| fee | string,number | false | nenhum | Alterar 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
| Nome | Tipo | Obrigatório | Restrições | Descrição |
|---|---|---|---|---|
| id | integer,string | false | nenhum | Os valores do banco de dados podem ser serializados como strings |
| user_id | integer,string | false | nenhum | Detalhes da interface retorna |
| start_time | string | false | nenhum | Y-m-d H:i:s; data não RFC 3339 |
| end_time | string | false | nenhum | Y-m-d H:i:s; data não RFC 3339 |
| status | string | false | nenhum | none |
| file_size | integer,string,null | false | nenhum | none |
| record_count | integer,string,null | false | nenhum | none |
| created_at | string | false | nenhum | Y-m-d H:i:s; data não RFC 3339 |
| completed_at | string | false | nenhum | Y-m-d H:i:s; data não RFC 3339 |
| file_url | string | false | nenhum | Após a conclusão, a interface de detalhes retorna |
| download_url | string | false | nenhum | Retorno após a conclusão, endereço de download de assinatura válido por 24 horas |
| error_message | string | false | nenhum | Em caso de falha, a interface de detalhes pode retornar |
Valores enumerados
| Propriedade | Valor |
|---|---|
| status | pending |
| status | processing |
| status | completed |
| status | failed |
| status | canceled |
| status | no_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
| Nome | Tipo | Obrigatório | Restrições | Descrição |
|---|---|---|---|---|
| id | integer,string | false | nenhum | Os valores do banco de dados podem ser serializados como strings |
| coupon_id | integer,string | false | nenhum | Os valores do banco de dados podem ser serializados como strings |
| type | integer,string | false | nenhum | Os valores do banco de dados podem ser serializados como strings |
| status | integer,string | false | nenhum | Os valores do banco de dados podem ser serializados como strings |
| source | integer,string | false | nenhum | Os valores do banco de dados podem ser serializados como strings |
| title | string | false | nenhum | none |
| title_en | string | false | nenhum | none |
| description | string | false | nenhum | none |
| description_en | string | false | nenhum | none |
| start_amount | string,number,null | false | nenhum | none |
| start_amount_usd | string,number,null | false | nenhum | none |
| start_amount_hkd | string,number,null | false | nenhum | none |
| deduction_amount | string,number,null | false | nenhum | none |
| deduction_amount_usd | string,number,null | false | nenhum | none |
| deduction_amount_hkd | string,number,null | false | nenhum | none |
| discount_rate | string,number,null | false | nenhum | none |
| discount_ceiling_amount | string,number,null | false | nenhum | none |
| discount_ceiling_amount_usd | string,number,null | false | nenhum | none |
| discount_ceiling_amount_hkd | string,number,null | false | nenhum | none |
| created_at | string,null | false | nenhum | Y-m-d H:i:s |
| effect_at | string,null | false | nenhum | Y-m-d H:i:s |
| expired_at | string,null | false | nenhum | Y-m-d H:i:s |
| used_at | string,null | false | nenhum | Y-m-d H:i:s |
| product_types | string,null | false | nenhum | Tipos de pacotes aplicáveis |
| created_timestamp | integer,null | false | nenhum | none |
| effect_timestamp | integer,null | false | nenhum | none |
| expired_timestamp | integer,null | false | nenhum | none |
| used_timestamp | integer,null | false | nenhum | none |
| is_expired | boolean | false | nenhum | Listar retornos da interface |
OpenApiNotification
{
"id": 0,
"title": "string",
"content": "string",
"type": 0,
"read_status": 0,
"created_at": "string",
"created_timestamp": 0
}
Propriedades
| Nome | Tipo | Obrigatório | Restrições | Descrição |
|---|---|---|---|---|
| id | integer,string | false | nenhum | Os valores do banco de dados podem ser serializados como strings |
| title | string | false | nenhum | none |
| content | string | false | nenhum | Conteúdo renderizado no idioma solicitado |
| type | integer,string | false | nenhum | Os valores do banco de dados podem ser serializados como strings |
| read_status | integer | false | nenhum | none |
| created_at | string | false | nenhum | Y-m-d H:i:s; data não RFC 3339 |
| created_timestamp | integer | false | nenhum | none |
Valores enumerados
| Propriedade | Valor |
|---|---|
| read_status | 0 |
| read_status | 1 |
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
| Nome | Tipo | Obrigatório | Restrições | Descrição |
|---|---|---|---|---|
| anonymous | integer | false | nenhum | 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 |
Valores enumerados
| Propriedade | Valor |
|---|---|
| anonymous | 9 |
| anonymous | 11 |
| anonymous | 14 |
| anonymous | 25 |
apiKey
"pa$$word"
Chave API; passado usando apiKeyAuth ou o parâmetro de solicitação declarado pela operação
Propriedades
| Nome | Tipo | Obrigatório | Restrições | Descrição |
|---|---|---|---|---|
| anonymous | string(password) | false | nenhum | Chave 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
| Nome | Tipo | Obrigatório | Restrições | Descrição |
|---|---|---|---|---|
| anonymous | integer | false | nenhum | Código de status, 200 bem-sucedido, 3 app_key inválido |
responseMsg
"success"
response message
Propriedades
| Nome | Tipo | Obrigatório | Restrições | Descrição |
|---|---|---|---|---|
| anonymous | string | false | nenhum | response 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
| Nome | Tipo | Obrigatório | Restrições | Descrição |
|---|---|---|---|---|
| code | integer | true | nenhum | none |
| msg | string | true | nenhum | none |
| data | object,array,string,number,boolean,null | true | nenhum | Dados de negócios, o tipo específico é definido pela interface |
| request_id | string | true | nenhum | Solicitar ID de rastreamento do link |
WebV1ErrorResponse
{
"code": 2,
"msg": "parameter error",
"data": {},
"request_id": "string"
}
Propriedades
| Nome | Tipo | Obrigatório | Restrições | Descrição |
|---|---|---|---|---|
| code | integer | true | nenhum | Código de erro comercial |
not
| Nome | Tipo | Obrigatório | Restrições | Descrição |
|---|---|---|---|---|
| » anonymous | any | false | nenhum | none |
continued
| Nome | Tipo | Obrigatório | Restrições | Descrição |
|---|---|---|---|---|
| msg | string | true | nenhum | Descrição do erro |
| data | object,array,null | true | nenhum | Erro de dados adicionais, nulo se não houver dados adicionais |
| request_id | string | true | nenhum | Solicitar 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
| Nome | Tipo | Obrigatório | Restrições | Descrição |
|---|---|---|---|---|
| anonymous | string | false | nenhum | 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 |
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
| Nome | Tipo | Obrigatório | Restrições | Descrição |
|---|---|---|---|---|
| anonymous | string | false | nenhum | none |
xor
| Nome | Tipo | Obrigatório | Restrições | Descrição |
|---|---|---|---|---|
| anonymous | TeamPublicId | false | nenhum | 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 |
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
| Nome | Tipo | Obrigatório | Restrições | Descrição |
|---|---|---|---|---|
| id | TeamPublicId | true | nenhum | 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 |
| name | string | true | nenhum | Nome da equipe |
| super_admin_user_id | integer | true | nenhum | ID de usuário do superadministrador |
| status | integer | true | nenhum | Status da equipe: 0=desativado, 1=válido, 2=dissolvido, 3=dissolvido |
| current_role | integer,null | true | nenhum | A função do usuário atual na equipe; nulo se não puder ser determinado |
| dissolving_at | string,null | true | nenhum | Iniciar o tempo de dissolução |
| dissolved_at | string,null | true | nenhum | Tempo de conclusão da dissolução |
| created_at | string | true | nenhum | hora de criação |
| updated_at | string | true | nenhum | Hora de atualização |
Valores enumerados
| Propriedade | Valor |
|---|---|
| status | 0 |
| status | 1 |
| status | 2 |
| status | 3 |
| current_role | 1 |
| current_role | 2 |
| current_role | 3 |
| current_role | 4 |
| current_role | null |
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
| Nome | Tipo | Obrigatório | Restrições | Descrição |
|---|---|---|---|---|
| id | integer | true | nenhum | ID do plano do usuário |
| user_id | integer | true | nenhum | ID de usuário do proprietário do recurso |
| team_id | ResourceSpaceId | true | nenhum | 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 |
| team_user_id | integer | true | nenhum | Criação real de IDs de usuários membros |
| product_id | integer | true | nenhum | ID do produto |
| product_type | integer | true | nenhum | tipo de produto |
| parent_product_type | integer | true | nenhum | Tipo de produto pai |
| status | integer | true | nenhum | Status do pacote |
| total_amount | integer(int64) | true | nenhum | valor total |
| remain | integer(int64) | true | nenhum | Montante restante |
| bandwidth | integer | false | nenhum | Largura de banda (Mbps); retornado apenas por product_type=19 ou 11 |
| concurrency | integer | false | nenhum | Número de simultaneidades; apenas product_type=11 é retornado |
| expired_at | string,null | true | nenhum | Prazo de validade |
| created_at | string | true | nenhum | hora de criação |
| ip | string | false | nenhum | Endereço IP estático; apenas product_type=19 retorna |
| country_code | string | false | nenhum | Código IP estático do país; apenas product_type=19 retorna |
| country_name | string | false | nenhum | Nome do país IP estático; retornado apenas por product_type=19 |
| asn | string | false | nenhum | ASN de IP estático; apenas product_type=19 é retornado |
| port | integer | false | nenhum | Porta 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
| Nome | Tipo | Obrigatório | Restrições | Descrição |
|---|---|---|---|---|
| team_id | TeamPublicId | true | nenhum | 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 |
| product_types | [integer] | true | nenhum | O 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_count | integer(int64) | false | nenhum | Fluxo residual tipo 9 |
| product_residence_total_count | integer(int64) | false | nenhum | Tipo 9 Tráfego Total |
| pdrue2_timestamp | integer(int64) | false | nenhum | Digite 11 último carimbo de data e hora de expiração; 0 quando não há pacote de equipe |
| remain | integer,string | false | nenhum | Tipo 17 Quantidade Restante |
| total_amount | integer,string | false | nenhum | Tipo 17 Quantidade total |
| scraping_remain | integer(int64) | false | nenhum | Digite 18 vezes restantes |
| scraping_total_amount | integer(int64) | false | nenhum | Digite 18 vezes no total |
| scraping_timestamp | string | false | nenhum | Digite 18 último prazo de expiração; "-" quando não há pacote |
| scraping_timestamp2 | integer(int64) | false | nenhum | Carimbo de data e hora de expiração mais recente tipo 18 |
| common_scraping_remain | integer(int64) | false | nenhum | Digite 29 tempos restantes |
| common_scraping_total_amount | integer(int64) | false | nenhum | Tipo 29 Total de Tempos |
| common_scraping_timestamp | string | false | nenhum | Digite 29 último prazo de expiração; "-" quando não há pacote |
| common_scraping_timestamp2 | integer(int64) | false | nenhum | Carimbo de data e hora de expiração mais recente tipo 29 |
| pdidcr_count | integer | false | nenhum | Quantidade de pacote válido tipo 12 |
| pdidcr_total | integer | false | nenhum | Número total de pacotes do tipo 12 |
| pdidcr_traffic_remain | integer(int64) | false | nenhum | Fluxo Residual Tipo 12 |
| pdidcr_traffic_total | integer(int64) | false | nenhum | Tipo 12 Tráfego Total |
| p_sitai_ip_count | integer | false | nenhum | Digite 13 Número IP válido |
| p_sitai_ip | integer | false | nenhum | Quantidade de pacote válido tipo 13 |
| p_sitai_ip_total | integer | false | nenhum | Número total de pacotes do tipo 13 |
| p_sitai_remain | integer(int64) | false | nenhum | Fluxo residual tipo 13/24 |
| p_sitai_total | integer(int64) | false | nenhum | Tipo 13/24 Fluxo Total |
| pdidc_count | integer | false | nenhum | Quantidade de pacote válido tipo 14 |
| pdidc_total | integer | false | nenhum | Número total de pacotes tipo 14 |
| pdidc_ip_count | integer | false | nenhum | Digite 14 Número IP válido |
| pdidc_ip_all_count | integer | false | nenhum | Tipo 14 IP Total |
| pdispr_count | integer | false | nenhum | Quantidade de pacote válido tipo 15 |
| pdispr_total | integer | false | nenhum | Número total de pacotes tipo 15 |
| pdispr_traffic_remain | integer(int64) | false | nenhum | Fluxo residual tipo 15 |
| pdispr_traffic_total | integer(int64) | false | nenhum | Tipo 15 Tráfego Total |
| product_datacenter_isp_traffic_ip_count | integer | false | nenhum | Digite 16 Número IP válido |
| product_datacenter_isp_traffc_ip | integer | false | nenhum | Tipo 16 Quantidade de Pacote Válido; Ortografia historicamente compatível |
| product_datacenter_isp_traffc_ip_total | integer | false | nenhum | Total Tipo 16 Pacotes; Ortografias historicamente compatíveis |
| product_datacenter_isp_traffic_ip | integer | false | nenhum | Quantidade de pacote válido tipo 16 |
| product_datacenter_isp_traffic_ip_total | integer | false | nenhum | Número total de pacotes tipo 16 |
| product_datacenter_isp_traffc_remain | integer(int64) | false | nenhum | Tráfego residual tipo 16/24; ortografia historicamente compatível |
| product_datacenter_isp_traffc_total | integer(int64) | false | nenhum | Vazão total tipo 16/24; ortografia historicamente compatível |
| product_datacenter_isp_traffic_remain | integer(int64) | false | nenhum | Fluxo residual tipo 16/24 |
| product_datacenter_isp_traffic_total | integer(int64) | false | nenhum | Tipo 16/24 Fluxo Total |
| product_datacenter_isp_ip | integer | false | nenhum | Digite 21 ou 25 quantidade de pacote válida |
| product_datacenter_isp_ip_total | integer | false | nenhum | Digite 21 ou 25 pacotes no total |
| product_datacenter_isp_ip_count | integer | false | nenhum | Digite 21 ou 25 Número IP válido |
| product_datacenter_isp_ip_all_count | integer | false | nenhum | Total Tipo 21 ou 25 IP |
| product_datacenter_isp_ip_traffic_remain | integer(int64) | false | nenhum | O tipo 21 corresponde ao fluxo restante do tipo 24 |
| product_datacenter_isp_ip_traffic_total | integer(int64) | false | nenhum | O tipo 21 corresponde ao fluxo total do tipo 24 |
| product_agent_residence_remain_count | integer(int64) | false | nenhum | Fluxo Residual Tipo 22 |
| product_agent_residence_total_count | integer(int64) | false | nenhum | Tipo 22 Tráfego Total |
| product_serp_remain | integer(int64) | false | nenhum | Digite 27 vezes restantes |
| product_serp_total | integer(int64) | false | nenhum | Tipo 27 Total de Tempos |
| product_serp_timestamp | string | false | nenhum | Digite 27 último prazo de expiração; "-" quando não há pacote |
| product_serp_timestamp2 | integer(int64) | false | nenhum | Carimbo de data e hora de expiração mais recente do tipo 27 |
| product_video_remain | integer(int64) | false | nenhum | Fluxo Residual Tipo 28 |
| product_video_total | integer(int64) | false | nenhum | Tipo 28 Fluxo Total |
| product_video_timestamp | string | false | nenhum | Digite 28 último prazo de expiração; "-" quando não há pacote |
| product_video_timestamp2 | integer(int64) | false | nenhum | Digite 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
| Nome | Tipo | Obrigatório | Restrições | Descrição |
|---|---|---|---|---|
| team_id | TeamPublicId | true | nenhum | 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 |
| balance | number(double) | true | nenhum | Saldo atual da equipe disponível |
| total_recharge_fee | number(double) | true | nenhum | O principal atual não gasto da recarga da equipe, excluindo o valor da transferência de saldo pessoal |
| updated_at | string | true | nenhum | Hora 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
| Nome | Tipo | Obrigatório | Restrições | Descrição |
|---|---|---|---|---|
| id | integer | true | nenhum | none |
| team_id | TeamPublicId | true | nenhum | 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 |
| operator_user_id | integer | true | nenhum | Operadora, o reembolso do sistema é 0 |
| creator | TeamCreator | false | nenhum | none |
| direction | integer | true | nenhum | 0=despesa, 1=receita |
| transaction_type | integer | true | nenhum | 1=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 |
| amount | number(double) | true | nenhum | A quantidade dessa mudança, a direção é representada pela direção |
| after_balance | number(double) | true | nenhum | Saldo da carteira da equipe após alteração |
| link_id | integer | true | nenhum | ID do pedido associado; quando o saldo pessoal é transferido, é o ID do usuário operacional |
| request_id | string | true | nenhum | none |
| remark | string | true | nenhum | none |
| created_at | string | true | nenhum | none |
Valores enumerados
| Propriedade | Valor |
|---|---|
| direction | 0 |
| direction | 1 |
| transaction_type | 1 |
| transaction_type | 2 |
| transaction_type | 3 |
| transaction_type | 4 |
| transaction_type | 5 |
TeamCreator
{
"user_id": 0,
"display_name": "string",
"nickname": "string",
"username": "string",
"email": "string",
"phone": "string"
}
Propriedades
| Nome | Tipo | Obrigatório | Restrições | Descrição |
|---|---|---|---|---|
| user_id | integer | true | nenhum | ID do usuário operador; operação do sistema é 0 |
| display_name | string | true | nenhum | Exibir nome, anotar apelido, nome de usuário, e-mail e número de celular em ordem |
| nickname | string | true | nenhum | none |
| username | string | true | nenhum | none |
| string | true | nenhum | A perspectiva do não administrador é o valor da dessensibilização | |
| phone | string | true | nenhum | A 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
| Nome | Tipo | Obrigatório | Restrições | Descrição |
|---|---|---|---|---|
| anonymous | WebV1SuccessResponse | false | nenhum | none |
and
| Nome | Tipo | Obrigatório | Restrições | Descrição |
|---|---|---|---|---|
| anonymous | object | false | nenhum | none |
| » data | Team | false | nenhum | none |
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
| Nome | Tipo | Obrigatório | Restrições | Descrição |
|---|---|---|---|---|
| anonymous | WebV1SuccessResponse | false | nenhum | none |
and
| Nome | Tipo | Obrigatório | Restrições | Descrição |
|---|---|---|---|---|
| anonymous | object | false | nenhum | none |
| » data | object | false | nenhum | none |
| »» list | [Team] | true | nenhum | none |
| »» total | integer | true | nenhum | none |
| »» page | integer | true | nenhum | none |
| »» page_size | integer | true | nenhum | none |
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
| Nome | Tipo | Obrigatório | Restrições | Descrição |
|---|---|---|---|---|
| anonymous | WebV1SuccessResponse | false | nenhum | none |
and
| Nome | Tipo | Obrigatório | Restrições | Descrição |
|---|---|---|---|---|
| anonymous | object | false | nenhum | none |
| » data | object | false | nenhum | none |
| »» list | [TeamMember] | true | nenhum | none |
| »» total | integer | true | nenhum | none |
| »» page | integer | true | nenhum | none |
| »» page_size | integer | true | nenhum | none |
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
| Nome | Tipo | Obrigatório | Restrições | Descrição |
|---|---|---|---|---|
| anonymous | WebV1SuccessResponse | false | nenhum | none |
and
| Nome | Tipo | Obrigatório | Restrições | Descrição |
|---|---|---|---|---|
| anonymous | object | false | nenhum | none |
| » data | object | false | nenhum | none |
| »» list | [TeamPerson] | true | nenhum | none |
| »» total | integer | true | nenhum | none |
| »» page | integer | true | nenhum | none |
| »» page_size | integer | true | nenhum | none |
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
| Nome | Tipo | Obrigatório | Restrições | Descrição |
|---|---|---|---|---|
| anonymous | WebV1SuccessResponse | false | nenhum | none |
and
| Nome | Tipo | Obrigatório | Restrições | Descrição |
|---|---|---|---|---|
| anonymous | object | false | nenhum | none |
| » data | TeamAsset | false | nenhum | none |
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
| Nome | Tipo | Obrigatório | Restrições | Descrição |
|---|---|---|---|---|
| anonymous | WebV1SuccessResponse | false | nenhum | none |
and
| Nome | Tipo | Obrigatório | Restrições | Descrição |
|---|---|---|---|---|
| anonymous | object | false | nenhum | none |
| » data | TeamProductInfo | false | nenhum | 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 |
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
| Nome | Tipo | Obrigatório | Restrições | Descrição |
|---|---|---|---|---|
| anonymous | WebV1SuccessResponse | false | nenhum | none |
and
| Nome | Tipo | Obrigatório | Restrições | Descrição |
|---|---|---|---|---|
| anonymous | object | false | nenhum | none |
| » data | TeamWallet | false | nenhum | Carteira 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
| Nome | Tipo | Obrigatório | Restrições | Descrição |
|---|---|---|---|---|
| anonymous | WebV1SuccessResponse | false | nenhum | none |
and
| Nome | Tipo | Obrigatório | Restrições | Descrição |
|---|---|---|---|---|
| anonymous | object | false | nenhum | none |
| » data | object | false | nenhum | none |
| »» list | [TeamWalletRecord] | true | nenhum | none |
| »» total | integer | true | nenhum | none |
| »» page | integer | true | nenhum | none |
| »» page_size | integer | true | nenhum | none |
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
| Nome | Tipo | Obrigatório | Restrições | Descrição |
|---|---|---|---|---|
| anonymous | WebV1SuccessResponse | false | nenhum | none |
and
| Nome | Tipo | Obrigatório | Restrições | Descrição |
|---|---|---|---|---|
| anonymous | object | false | nenhum | none |
| » data | object | false | nenhum | none |
| »» list | [TeamAsset] | true | nenhum | none |
| »» total | integer | true | nenhum | none |
| »» page | integer | true | nenhum | none |
| »» page_size | integer | true | nenhum | none |
UserApiKeyMetadata
{
"id": 1,
"api_key": "string",
"team_user_id": 0,
"remark": "string",
"status": 0,
"created_at": "string",
"updated_at": "string"
}
Propriedades
| Nome | Tipo | Obrigatório | Restrições | Descrição |
|---|---|---|---|---|
| id | integer | true | nenhum | API Key ID |
| api_key | string | true | nenhum | A resposta da criação é a Chave completa; a lista da equipe é o valor mascarado |
| team_user_id | integer | true | nenhum | A chave da equipe, na verdade, contém o ID do membro e a chave pessoal é 0 |
| remark | string | true | nenhum | Observações |
| status | integer | true | nenhum | 0=desativar, 1=ativar |
| created_at | string | true | nenhum | hora de criação |
| updated_at | string,null | false | nenhum | Hora de atualização |
Valores enumerados
| Propriedade | Valor |
|---|---|
| status | 0 |
| status | 1 |
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
| Nome | Tipo | Obrigatório | Restrições | Descrição |
|---|---|---|---|---|
| invoice_code | string | false | nenhum | none |
| name | string | false | nenhum | none |
| org_name | string | false | nenhum | none |
| first_name | string | false | nenhum | none |
| last_name | string | false | nenhum | none |
| phone | string | false | nenhum | none |
| string(email) | false | nenhum | none | |
| role_type | integer | false | nenhum | none |
| invoice_type | integer | false | nenhum | none |
| vat_id | string | false | nenhum | none |
| tax_no | string | false | nenhum | none |
| address_country | string | false | nenhum | none |
| address_city | string | false | nenhum | none |
| address_line1 | string | false | nenhum | none |
| address_line2 | string | false | nenhum | none |
| address_postal_code | string | false | nenhum | none |
| bank_name | string | false | nenhum | none |
| bank_account | string | false | nenhum | none |
| is_def | boolean | false | nenhum | none |
Valores enumerados
| Propriedade | Valor |
|---|---|
| role_type | 1 |
| role_type | 2 |
| invoice_type | 0 |
| invoice_type | 1 |
| invoice_type | 2 |
MonthlyRenewalRequest
{
"team_id": "A1b2C3d4E5f6",
"user_product_ids": [
1
],
"user_coupon_id": 1,
"coupon_sn": "string"
}
Propriedades
| Nome | Tipo | Obrigatório | Restrições | Descrição |
|---|---|---|---|---|
| team_id | ResourceSpaceId | false | nenhum | 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 |
| user_product_ids | any | true | nenhum | Matriz de ID do plano do usuário, também compatível com strings separadas por vírgula em inglês |
oneOf
| Nome | Tipo | Obrigatório | Restrições | Descrição |
|---|---|---|---|---|
| » anonymous | [integer] | false | nenhum | none |
xor
| Nome | Tipo | Obrigatório | Restrições | Descrição |
|---|---|---|---|---|
| » anonymous | string | false | nenhum | none |
continued
| Nome | Tipo | Obrigatório | Restrições | Descrição |
|---|---|---|---|---|
| user_coupon_id | integer | false | nenhum | none |
| coupon_sn | string | false | nenhum | none |
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
| Nome | Tipo | Obrigatório | Restrições | Descrição |
|---|---|---|---|---|
| id | integer | true | nenhum | ID do convite |
| team_id | TeamPublicId | true | nenhum | 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 |
| inviter_user_id | integer | true | nenhum | ID do usuário convidador |
| invitee_user_id | integer | true | nenhum | ID do usuário convidado, 0 se nenhum usuário registrado tiver sido correspondido ainda |
| invite_type | integer | true | nenhum | Tipo de convite: 1=usuário registrado, 2=e-mail, 3=número de celular |
| invite_country_code | integer | true | nenhum | Có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_target | string | true | nenhum | Alvo de convite padronizado; o usuário registrado é o usuário:{user_id} |
| delivery_type | integer | true | nenhum | Canal 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 |
| role | integer | true | nenhum | Função alvo: 2=administrador, 3=membro comum |
| status | integer | true | nenhum | Status do convite: 0=pendente, 1=aceito, 2=rejeitado, 3=cancelado, 4=expirado |
| accepted_by_user_id | integer | true | nenhum | ID do usuário aceitante, 0 se não for aceito |
| expired_at | string | true | nenhum | Tempo de expiração, formato AAAA-MM-DD HH:mm:ss |
| accepted_at | string,null | true | nenhum | Tempo de aceitação |
| rejected_at | string,null | true | nenhum | tempo de rejeição |
| cancelled_at | string,null | true | nenhum | Tempo de cancelamento |
| created_at | string | true | nenhum | Hora de criação, formato AAAA-MM-DD HH:mm:ss |
Valores enumerados
| Propriedade | Valor |
|---|---|
| invite_type | 1 |
| invite_type | 2 |
| invite_type | 3 |
| delivery_type | 1 |
| delivery_type | 2 |
| delivery_type | 3 |
| role | 2 |
| role | 3 |
| status | 0 |
| status | 1 |
| status | 2 |
| status | 3 |
| status | 4 |
TeamMember
{
"team_member_id": 1,
"team_id": "A1b2C3d4E5f6",
"user_id": 1,
"role": 1,
"status": 0,
"joined_at": "string",
"nickname": "string",
"username": "string"
}
Propriedades
| Nome | Tipo | Obrigatório | Restrições | Descrição |
|---|---|---|---|---|
| team_member_id | integer | true | nenhum | ID de membro |
| team_id | TeamPublicId | true | nenhum | 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 |
| user_id | integer | true | nenhum | ID de usuário membro |
| role | integer | true | nenhum | Função: 1=superadministrador, 2=administrador, 3=membro comum, 4=membro financeiro |
| status | integer | true | nenhum | Status do membro: 0=desativado, 1=válido, 2=saído, 3=removido |
| joined_at | string,null | true | nenhum | Hora de adesão, formato AAAA-MM-DD HH:mm:ss |
| nickname | string | true | nenhum | Apelido do membro |
| username | string | true | nenhum | Nome de usuário do membro |
Valores enumerados
| Propriedade | Valor |
|---|---|
| role | 1 |
| role | 2 |
| role | 3 |
| role | 4 |
| status | 0 |
| status | 1 |
| status | 2 |
| status | 3 |
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
| Nome | Tipo | Obrigatório | Restrições | Descrição |
|---|---|---|---|---|
| record_type | string | true | nenhum | Tipo de registro; membro é um membro válido, o convite é um convite pendente |
| record_id | integer | true | nenhum | ID de associação ou ID de convite |
| team_id | TeamPublicId | true | nenhum | 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 |
| user_id | integer | true | nenhum | ID do usuário, usuários convidados não registrados são 0 |
| inviter_user_id | integer | true | nenhum | ID do usuário convidador, registro de membro é 0 |
| invite_type | integer | true | nenhum | Tipo de convite, registro de membro é 0 |
| invite_country_code | integer | true | nenhum | País ou código de área do número de celular, registro de membro é 0 |
| invite_target | string | true | nenhum | Destino do convite, registro de membro é uma string vazia |
| delivery_type | integer | true | nenhum | Canal de entrega original, registro de membro é 0 |
| role | integer | true | nenhum | Função: 1=superadministrador, 2=administrador, 3=membro comum, 4=membro financeiro |
| status | integer | true | nenhum | membro é fixado em 1, convite é fixado em 0 |
| display_name | string | true | nenhum | Exibir 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 |
| nickname | string | true | nenhum | Apelido do membro ou usuário convidado registrado |
| username | string | true | nenhum | Membro ou nome de usuário convidado registrado |
| string | true | nenhum | E-mail; superadministradores e administradores retornam valores completos, membros comuns retornam valores de dessensibilização com asteriscos | |
| phone | string | true | nenhum | Número de telemóvel; superadministradores e administradores retornam o valor completo, e membros comuns retornam o valor insensível com um asterisco. |
| joined_at | string,null | true | nenhum | Hora de adesão do membro, o registro do convite é nulo |
| expired_at | string,null | true | nenhum | Prazo de expiração do convite, o registro do membro é nulo |
| created_at | string | true | nenhum | Hora de criação do registro, formato AAAA-MM-DD HH:mm:ss |
Valores enumerados
| Propriedade | Valor |
|---|---|
| record_type | member |
| record_type | invitation |
| invite_type | 0 |
| invite_type | 1 |
| invite_type | 2 |
| invite_type | 3 |
| delivery_type | 0 |
| delivery_type | 1 |
| delivery_type | 2 |
| delivery_type | 3 |
| role | 1 |
| role | 2 |
| role | 3 |
| role | 4 |
| status | 0 |
| status | 1 |
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
| Nome | Tipo | Obrigatório | Restrições | Descrição |
|---|---|---|---|---|
| anonymous | WebV1SuccessResponse | false | nenhum | none |
and
| Nome | Tipo | Obrigatório | Restrições | Descrição |
|---|---|---|---|---|
| anonymous | object | false | nenhum | none |
| » data | TeamInvitation | false | nenhum | none |
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
| Nome | Tipo | Obrigatório | Restrições | Descrição |
|---|---|---|---|---|
| anonymous | WebV1SuccessResponse | false | nenhum | none |
and
| Nome | Tipo | Obrigatório | Restrições | Descrição |
|---|---|---|---|---|
| anonymous | object | false | nenhum | none |
| » data | TeamMember | false | nenhum | none |
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
| Nome | Tipo | Obrigatório | Restrições | Descrição |
|---|---|---|---|---|
| anonymous | WebV1SuccessResponse | false | nenhum | none |
and
| Nome | Tipo | Obrigatório | Restrições | Descrição |
|---|---|---|---|---|
| anonymous | object | false | nenhum | none |
| » data | object | false | nenhum | none |
| »» invitation | TeamInvitation | true | nenhum | none |
| »» invitation_token | string | true | nenhum | Token de convite em texto simples, reservado apenas para clientes existentes compatíveis; novos clientes usam Invitation_url diretamente |
| »» invitation_url | string(uri) | true | nenhum | Link de processamento de front-end contendo token de convite |
| »» notification_channels | TeamInvitationNotificationChannels | true | nenhum | none |
TeamInvitationNotificationChannels
{
"email": "queued",
"sms": "queued",
"site_inner_message": "created"
}
Propriedades
| Nome | Tipo | Obrigatório | Restrições | Descrição |
|---|---|---|---|---|
| string | false | nenhum | Resultados do canal de e-mail | |
| sms | string | false | nenhum | Resultados do canal SMS |
| site_inner_message | string | false | nenhum | Resultados do canal de mensagens do site |
Valores enumerados
| Propriedade | Valor |
|---|---|
| queued | |
| failed | |
| skipped | |
| sms | queued |
| sms | failed |
| sms | skipped |
| site_inner_message | created |
| site_inner_message | exists |
| site_inner_message | failed |
TeamInvitationPreviewResponse
{
"code": 200,
"msg": "SUCCESS",
"data": {
"team_name": "string",
"role": 2,
"status": 0,
"expired_at": "string"
},
"request_id": "string"
}
Propriedades
allOf
| Nome | Tipo | Obrigatório | Restrições | Descrição |
|---|---|---|---|---|
| anonymous | WebV1SuccessResponse | false | nenhum | none |
and
| Nome | Tipo | Obrigatório | Restrições | Descrição |
|---|---|---|---|---|
| anonymous | object | false | nenhum | none |
| » data | object | false | nenhum | none |
| »» team_name | string | true | nenhum | Nome da equipe |
| »» role | integer | true | nenhum | função alvo |
| »» status | integer | true | nenhum | status do convite |
| »» expired_at | string | true | nenhum | Tempo de expiração, formato AAAA-MM-DD HH:mm:ss |
Valores enumerados
| Propriedade | Valor |
|---|---|
| role | 2 |
| role | 3 |
| status | 0 |
| status | 1 |
| status | 2 |
| status | 3 |
| status | 4 |
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
| Nome | Tipo | Obrigatório | Restrições | Descrição |
|---|---|---|---|---|
| anonymous | WebV1SuccessResponse | false | nenhum | none |
and
| Nome | Tipo | Obrigatório | Restrições | Descrição |
|---|---|---|---|---|
| anonymous | object | false | nenhum | none |
| » data | object | false | nenhum | none |
| »» invitation | TeamInvitation | true | nenhum | none |
| »» invitation_url | string(uri) | true | nenhum | Novo link de processamento de convites; link antigo não funciona mais |
| »» notification_channels | TeamInvitationNotificationChannels | true | nenhum | none |
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
| Nome | Tipo | Obrigatório | Restrições | Descrição |
|---|---|---|---|---|
| anonymous | WebV1SuccessResponse | false | nenhum | none |
and
| Nome | Tipo | Obrigatório | Restrições | Descrição |
|---|---|---|---|---|
| anonymous | object | false | nenhum | none |
| » data | object | false | nenhum | none |
| »» list | [TeamInvitation] | true | nenhum | none |
| »» total | integer | true | nenhum | número total de convites |
| »» page | integer | true | nenhum | Número da página atual |
| »» page_size | integer | true | nenhum | nú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
| Nome | Tipo | Obrigatório | Restrições | Descrição |
|---|---|---|---|---|
| id | integer | false | nenhum | none |
| string(email) | false | nenhum | none | |
| phone | string | false | nenhum | none |
| balance | number(float) | false | nenhum | none |
| status | integer | false | nenhum | none |
| is_real_name | boolean | false | nenhum | none |
| created_at | string(date-time) | false | nenhum | none |
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
| Nome | Tipo | Obrigatório | Restrições | Descrição |
|---|---|---|---|---|
| id | integer | false | nenhum | ID do pedido |
| trade_no | string | false | nenhum | Número de pedido interno |
| out_trade_no | string | false | nenhum | Número de pedido externo |
| product_id | integer | false | nenhum | ID do pacote |
| product_type | integer | false | nenhum | Tipo de pacote, consulte a enumeração do tipo de produto |
| amount | integer | false | nenhum | Quantidade de compra |
| unit_price | number(float) | false | nenhum | preço unitário |
| total_fee | number(float) | false | nenhum | Preço total do pedido (excluindo descontos e taxas de manuseio) |
| goods_fee | number(float) | false | nenhum | Preço do produto (incluindo descontos, excluindo taxas de manuseio) |
| pay_fee | number(float) | false | nenhum | Valor real pago (incluindo descontos e taxas de manuseio) |
| discount_fee | number(float) | false | nenhum | Valor do desconto |
| handling_fee | number(float) | false | nenhum | taxa de manuseio |
| refund_fee | number(float) | false | nenhum | Valor do reembolso |
| pm_id | integer | false | nenhum | ID da forma de pagamento (de /openapi/payment/list) |
| pm_title | string | false | nenhum | Nome da forma de pagamento |
| pm_logo | string | false | nenhum | URL do logotipo da forma de pagamento |
| status | integer | false | nenhum | Status do pedido |
| title | string | false | nenhum | Título do pacote |
| detail | string | false | nenhum | Descrição do pacote |
| region_desc | string | false | nenhum | Descrição da especificação da região |
| pay_at | string(date-time) | false | nenhum | prazo de pagamento |
| pay_timestamp | integer | false | nenhum | Data e hora do pagamento |
| created_at | string(date-time) | false | nenhum | hora de criação |
| pay_fee_status | integer | false | nenhum | Status de pagamento longo e curto: 0 normal 1 pagamento longo (pagamento a maior) 2 pagamento curto |
| invoice | object | false | nenhum | Informações da fatura (valiosas apenas para ordens de pagamento on-line) |
| » name | string | false | nenhum | nome completo |
| » org_name | string | false | nenhum | Nome da empresa |
| » first_name | string | false | nenhum | none |
| » last_name | string | false | nenhum | none |
| » phone | string | false | nenhum | none |
| string(email) | false | nenhum | none | |
| » role_type | integer | false | nenhum | 1 pessoa 2 empresas |
| » vat_id | string | false | nenhum | Número de identificação fiscal |
| » address_country | string | false | nenhum | none |
| » address_city | string | false | nenhum | none |
| » address_line1 | string | false | nenhum | none |
| » address_line2 | string | false | nenhum | none |
| » address_postal_code | string | false | nenhum | none |
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
| Nome | Tipo | Obrigatório | Restrições | Descrição |
|---|---|---|---|---|
| product_id | integer | false | nenhum | ID do pacote |
| amount | integer | false | nenhum | Quantidade |
| discount_fee | number(float) | false | nenhum | Valor do desconto |
| total_fee | number(float) | false | nenhum | Total do pedido |
| pay_fee | number(float) | false | nenhum | Valor real pago |
| product_type | integer | false | nenhum | Tipo de pacote |
| title | string | false | nenhum | Título do pacote |
| detail | string | false | nenhum | Descrição do pacote |
| ip_result | [object] | false | nenhum | Resultados de renovação em lote de IP (retornados somente durante a renovação de IP) |
| » ip | string | false | nenhum | none |
| » price | number(float) | false | nenhum | none |
| » country_code | string | false | nenhum | none |
| » current_time | string(date-time) | false | nenhum | none |
| » renewal_time | string(date-time) | false | nenhum | none |
| » country | object | false | nenhum | none |
| »» name_zh_cn | string | false | nenhum | none |
| »» flag | string | false | nenhum | URL do sinalizador do círculo |
| »» square_flag | string | false | nenhum | URL 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
| Nome | Tipo | Obrigatório | Restrições | Descrição |
|---|---|---|---|---|
| id | integer | false | nenhum | ID do pacote |
| title | string | false | nenhum | Título principal do pacote |
| type | integer | false | nenhum | Tipo de pacote |
| show_type | integer | false | nenhum | Tipo de exibição: 1 Normal 2 Grande recomendação 3 Não disponível para compra (precisa de personalização) 4 Avaliação |
| status | integer | false | nenhum | Status: 1 nas prateleiras 0 fora das prateleiras |
| price | number(float) | false | nenhum | Preço em RMB |
| usd_price | number(float) | false | nenhum | preço do dólar |
| price_hkd | number(float) | false | nenhum | Preço do dólar de Hong Kong |
| original_price | number(float) | false | nenhum | Preço original (CNY) |
| original_usd_price | number(float) | false | nenhum | Preço original (USD) |
| original_price_hkd | number(float) | false | nenhum | Preço original (HKD) |
| local_price | number(float) | false | nenhum | Preço localizado (depende deferred_currency) |
| local_original_price | number(float) | false | nenhum | Preço original localizado (depende deferred_currency) |
| preferred_currency | string | false | nenhum | Recomenda-se exibir a moeda, como usd/cny/hkd |
| support_currencies | string | false | nenhum | Lista de moedas suportadas, separadas por vírgulas, como usd,cny |
| flow_value | number(float) | false | nenhum | Tráfego padrão do plano de dados (GB) |
| flow_give | number(float) | false | nenhum | Tráfego livre (GB) |
| balance_give | number(float) | false | nenhum | Bônus de recarga de saldo |
| balance_value | number(float) | false | nenhum | Valor de recarga |
| time_validity | number(float) | false | nenhum | O período de validade padrão dos planos padrão |
| time_price | number(float) | false | nenhum | Preço do pacote padrão por IP |
| time_days | integer | false | nenhum | Número de dias de validade, como 30/90/180/365 |
| tip1 | string | false | nenhum | Descrição do rótulo 1 |
| tip2 | string | false | nenhum | Descrição do rótulo 2 |
| introduce | [string] | false | nenhum | Lista de introdução de texto |
| region_list_id | integer | false | nenhum | ID da região |
| renew_product_list | string | false | nenhum | Lista de IDs de pacotes renováveis (separados por vírgula) |
| parent_product_type | integer | false | nenhum | Tipo de pacote pai (válido quando type=19): 14 ou 25 |
| total_count | integer | false | nenhum | Estoque total, 0 significa sem limite |
| remain_count | integer | false | nenhum | estoque restante |
| extension_of_time_days | [integer] | false | nenhum | Lista de múltiplos de duração. Se estiver vazio ou contiver apenas 1, significa que não é compatível. |
| time_days_price_rate | number(float) | false | nenhum | Coeficiente de preço de duração, preço × (1 + (múltiplo-1) × taxa) |
| desc | object | false | nenhum | Informações de descrição do pacote |
| » subtitle | string | false | nenhum | legenda |
| » flow_value | number(float) | false | nenhum | none |
| » flow_give | number(float) | false | nenhum | none |
| » balance_give | number(float) | false | nenhum | none |
| » time_validity | number(float) | false | nenhum | none |
| » time_price | number(float) | false | nenhum | none |
| » tip1 | string | false | nenhum | none |
| » tip2 | string | false | nenhum | none |
| » introduce | [string] | false | nenhum | none |
| sku | object | false | nenhum | Parâmetros de especificação (retornados quando type=11) |
| » bandwidth_list | [object] | false | nenhum | Lista de especificações de largura de banda |
| »» id | integer | false | nenhum | none |
| »» value | integer | false | nenhum | Valor de largura de banda (Mbps) |
| »» price | number(float) | false | nenhum | none |
| »» price_usd | number(float) | false | nenhum | none |
| »» price_hkd | number(float) | false | nenhum | none |
| » duration_list | [object] | false | nenhum | Lista de especificações de duração |
| »» id | integer | false | nenhum | none |
| »» value | integer | false | nenhum | Duração (dias) |
| »» price | number(float) | false | nenhum | none |
| »» price_usd | number(float) | false | nenhum | none |
| »» price_hkd | number(float) | false | nenhum | none |
| » concurrency_list | [object] | false | nenhum | Lista de especificações de simultaneidade |
| »» id | integer | false | nenhum | none |
| »» value | integer | false | nenhum | Número de simultaneidades |
| »» price | number(float) | false | nenhum | none |
| »» price_usd | number(float) | false | nenhum | none |
| »» price_hkd | number(float) | false | nenhum | none |
WhiteIp
{
"id": 0,
"ip": "string",
"remark": "string",
"created_at": "2019-08-24T14:15:22Z"
}
Propriedades
| Nome | Tipo | Obrigatório | Restrições | Descrição |
|---|---|---|---|---|
| id | integer | false | nenhum | none |
| ip | string | false | nenhum | none |
| remark | string | false | nenhum | none |
| created_at | string(date-time) | false | nenhum | none |
WhitelistAccount
{
"id": 0,
"username": "string",
"limit": 0,
"used": 0,
"status": 0
}
Propriedades
| Nome | Tipo | Obrigatório | Restrições | Descrição |
|---|---|---|---|---|
| id | integer | false | nenhum | none |
| username | string | false | nenhum | none |
| limit | integer | false | nenhum | none |
| used | integer | false | nenhum | none |
| status | integer | false | nenhum | none |
Coupon
{
"id": 0,
"name": "string",
"code": "string",
"discount": 0.1,
"expire_time": "2019-08-24T14:15:22Z"
}
Propriedades
| Nome | Tipo | Obrigatório | Restrições | Descrição |
|---|---|---|---|---|
| id | integer | false | nenhum | none |
| name | string | false | nenhum | none |
| code | string | false | nenhum | none |
| discount | number(float) | false | nenhum | none |
| expire_time | string(date-time) | false | nenhum | none |
Article
{
"id": 0,
"title": "string",
"content": "string",
"created_at": "2019-08-24T14:15:22Z"
}
Propriedades
| Nome | Tipo | Obrigatório | Restrições | Descrição |
|---|---|---|---|---|
| id | integer | false | nenhum | none |
| title | string | false | nenhum | none |
| content | string | false | nenhum | none |
| created_at | string(date-time) | false | nenhum | none |
Pagination
{
"total": 0,
"page_no": 0,
"page_size": 0,
"total_pages": 0
}
Propriedades
| Nome | Tipo | Obrigatório | Restrições | Descrição |
|---|---|---|---|---|
| total | integer | false | nenhum | none |
| page_no | integer | false | nenhum | none |
| page_size | integer | false | nenhum | none |
| total_pages | integer | false | nenhum | none |
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
| Nome | Tipo | Obrigatório | Restrições | Descrição |
|---|---|---|---|---|
| id | integer | false | nenhum | none |
| user_id | integer | false | nenhum | none |
| team_id | ResourceSpaceId | false | nenhum | 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 |
| team_user_id | integer | false | nenhum | none |
| product_type | integer | false | nenhum | none |
| left_traffic | integer | false | nenhum | Campo obsoleto |
| left_days | integer | false | nenhum | Campo obsoleto |
| user_product_id | integer | false | nenhum | none |
| product_id | integer | false | nenhum | Campo obsoleto |
| status | integer | false | nenhum | 0=desativar, 1=ativar |
| currency | string | false | nenhum | none |
| agreed_price | number | false | nenhum | Preço total acordado |
| agreed_bandwidth_price | number | false | nenhum | Preço unitário de largura de banda acordado para o Pacote 11 |
| agreed_concurrency_price | number | false | nenhum | Preço unitário simultâneo acordado para o Pacote 11 |
| bandwidth_id | integer | false | nenhum | none |
| concurrency_id | integer | false | nenhum | none |
| duration | integer | false | nenhum | Tempo de renovação, dia da unidade |
| renew_product_id | integer | false | nenhum | none |
| days_before_expire | integer | false | nenhum | none |
| traffic_threshold | integer | false | nenhum | Limite de tráfego, unidade de valor do banco de dados KB |
| parent_product_type | integer | false | nenhum | none |
| created_at | string | false | nenhum | none |
| updated_at | string | false | nenhum | none |
Valores enumerados
| Propriedade | Valor |
|---|---|
| status | 0 |
| status | 1 |
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
| Nome | Tipo | Obrigatório | Restrições | Descrição |
|---|---|---|---|---|
| id | integer | true | nenhum | none |
| user_id | integer | true | nenhum | none |
| team_id | ResourceSpaceId | true | nenhum | 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 |
| team_user_id | integer | true | nenhum | none |
| config_id | integer | true | nenhum | none |
| user_product_id | integer | true | nenhum | none |
| product_type | integer | true | nenhum | none |
| renew_product_id | integer | true | nenhum | none |
| order_id | integer | true | nenhum | none |
| fee | number | true | nenhum | none |
| currency | string | true | nenhum | none |
| before_expired_at | string,null | false | nenhum | none |
| after_expired_at | string,null | false | nenhum | none |
| before_remain | integer(int64) | true | nenhum | none |
| after_remain | integer(int64) | true | nenhum | none |
| trigger_type | integer | true | nenhum | 0=Antes da expiração, 1=Tráfego insuficiente |
| status | integer | true | nenhum | 1=sucesso, 2=revogado, 3=falhou |
| revoke_at | string,null | false | nenhum | none |
| revoke_remark | string | true | nenhum | none |
| created_at | string | true | nenhum | none |
| updated_at | string | true | nenhum | none |
Valores enumerados
| Propriedade | Valor |
|---|---|
| trigger_type | 0 |
| trigger_type | 1 |
| status | 1 |
| status | 2 |
| status | 3 |
MonthlyRenewalBatch
{
"type": "current",
"start_at": "string",
"end_at": "string",
"target_expired_at": "string",
"timezone": "string"
}
Propriedades
| Nome | Tipo | Obrigatório | Restrições | Descrição |
|---|---|---|---|---|
| type | string | true | nenhum | none |
| start_at | string | true | nenhum | none |
| end_at | string | true | nenhum | none |
| target_expired_at | string | true | nenhum | none |
| timezone | string | true | nenhum | none |
Valores enumerados
| Propriedade | Valor |
|---|---|
| type | current |
| type | next |
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
| Nome | Tipo | Obrigatório | Restrições | Descrição |
|---|---|---|---|---|
| id | integer | false | nenhum | ID histórico de detalhes de faturamento |
| user_product_id | integer | true | nenhum | none |
| product_id | integer | true | nenhum | none |
| product_type | integer | true | nenhum | none |
| parent_product_type | integer | true | nenhum | none |
| title | string | true | nenhum | none |
| expired_at | string | true | nenhum | none |
| target_expired_at | string | true | nenhum | none |
| renew_days | integer | true | nenhum | none |
| unit_month_price | number | false | nenhum | none |
| pay_fee | number | true | nenhum | none |
| currency | string | true | nenhum | none |
| bandwidth | integer | false | nenhum | none |
| bandwidth_mbsp | number | false | nenhum | Valor de conversão de largura de banda |
| concurrency | integer | false | nenhum | none |
| ip | string | false | nenhum | Retornos de pacote IP estático |
| country_code | string | false | nenhum | Retornos de pacote IP estático |
| paid_at | string,null | false | nenhum | none |
| refunded_at | string,null | false | nenhum | none |
| created_at | string | false | nenhum | none |
| updated_at | string | false | nenhum | none |
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
| Nome | Tipo | Obrigatório | Restrições | Descrição |
|---|---|---|---|---|
| id | integer | true | nenhum | none |
| invoice_no | string | true | nenhum | none |
| invoice_amount | number | true | nenhum | none |
| invoice_download_url | string | true | nenhum | none |
| status | integer | true | nenhum | none |
| remark | string | true | nenhum | none |
| order_ids | [integer] | true | nenhum | none |
| created_at | integer | true | nenhum | Carimbo de data/hora Unix |
| invoice_info | any | true | nenhum | none |
oneOf
| Nome | Tipo | Obrigatório | Restrições | Descrição |
|---|---|---|---|---|
| » anonymous | object | false | nenhum | none |
| »» invoice_code | string | true | nenhum | none |
| »» name | string | true | nenhum | none |
| »» org_name | string | true | nenhum | none |
| »» role_type | integer | true | nenhum | none |
| »» invoice_type | integer | true | nenhum | none |
xor
| Nome | Tipo | Obrigatório | Restrições | Descrição |
|---|---|---|---|---|
| » anonymous | null | false | nenhum | none |
Valores enumerados
| Propriedade | Valor |
|---|---|
| role_type | 1 |
| role_type | 2 |
| invoice_type | 0 |
| invoice_type | 1 |
| invoice_type | 2 |
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
| Nome | Tipo | Obrigatório | Restrições | Descrição |
|---|---|---|---|---|
| trade_no | string | true | nenhum | none |
| pm_id | integer | true | nenhum | none |
| pay_method | integer | true | nenhum | none |
| trade_type | string | true | nenhum | none |
| country_code | string | true | nenhum | none |
| currency | string | true | nenhum | none |
| goods_fee | number | true | nenhum | none |
| discount_fee | number | true | nenhum | none |
| handling_fee | number | true | nenhum | none |
| pay_fee | number | true | nenhum | none |
| total_fee | number | true | nenhum | none |
| pay_method_info | any | true | nenhum | none |
oneOf
| Nome | Tipo | Obrigatório | Restrições | Descrição |
|---|---|---|---|---|
| » anonymous | object | false | nenhum | none |
| »» id | integer | true | nenhum | none |
| »» type | integer | true | nenhum | none |
| »» title | string | true | nenhum | none |
| »» group | string | true | nenhum | none |
| »» handling_rate | number | true | nenhum | none |
| »» handling_fee | number | true | nenhum | none |
| »» handling_fee_currency | string | true | nenhum | none |
| »» handling_fee_converted | number | true | nenhum | none |
xor
| Nome | Tipo | Obrigatório | Restrições | Descrição |
|---|---|---|---|---|
| » anonymous | null | false | nenhum | none |
continued
| Nome | Tipo | Obrigatório | Restrições | Descrição |
|---|---|---|---|---|
| origin | object | true | nenhum | none |
| » pm_id | integer | true | nenhum | none |
| » pay_method | integer | true | nenhum | none |
| » goods_fee | number | true | nenhum | none |
| » discount_fee | number | true | nenhum | none |
| » handling_fee | number | true | nenhum | none |
| » pay_fee | number | true | nenhum | none |
| » total_fee | number | true | nenhum | none |