NSocks

Permite gerenciar contas pessoais, recursos de agentes e faturamento de equipes por meio do prefixo OpenAPI do site.

O método de autenticação baseia-se na definição de segurança de cada operação:

• apiKeyAuth: Insira sua chave de API pessoal ou da equipe consultando o parâmetro app_key; o backend também aceita parâmetros key, appkey, openid e parâmetros no corpo da requisição POST.
• bearerAuth: Autorização: Portador <JWT> Isso é usado para tokens de login na web. Não use a chave de API como um JWT.
• A chave da API da equipe está vinculada a uma equipe fixa; para interfaces que suportam espaços de equipe, o team_id pode ser omitido, mas se for passado explicitamente, deve ser consistente com a equipe vinculada à chave.
• APIs que suportam apenas espaços pessoais rejeitarão chaves de API de equipe; as operações da equipe ainda seguirão as permissões de recursos dos membros que detêm o espaço.

A resposta JSON inclui código, mensagem, dados e ID da solicitação. O código 200 indica operação bem-sucedida; o código HTTP 200 também pode conter um código de erro. A mensagem varia de acordo com o idioma da solicitação; 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 de quantidade, fluxo, data e paginação estão sujeitos ao respectivo esquema de interface.

URLs base: "https://api.nsocks.com"

Autenticação

• Autenticação HTTP, esquema: bearer

• Chave de API (apiKeyAuth2)
  • Nome do parâmetro: app_key, em: query. Chave de API pessoal ou de equipe. O parâmetro de consulta recomendado é app_key; ele também é compatível com key/appkey/openid e corpos de requisição POST. Chaves de equipe só podem acessar interfaces compatíveis vinculadas à equipe.

Gerenciamento de chaves de API

Lista de chaves da API GET

GET /ep/api-keys

Parâmetros da solicitação

Voltar ao exemplo

200 Respostas

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

Retornar resultados

Estrutura de dados de retorno

Código de status 200

Valor de enumeração

Criar chave de API via POST

POST /ep/api-keys/create

Parâmetros da solicitação do corpo

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

Parâmetros da solicitação

Voltar ao exemplo

200 Respostas

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

Retornar resultados

Estrutura de dados de retorno

Valor de enumeração

POST Habilitar chave de API

POST /ep/api-keys/enable

Parâmetros da solicitação do corpo

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

Parâmetros da solicitação

Retornar resultados

POST Desativar chave de API

POST /ep/api-keys/disable

Parâmetros da solicitação do corpo

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

Parâmetros da solicitação

Retornar resultados

POST Delete API Key

POST /ep/api-keys/delete

Parâmetros da solicitação do corpo

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

Parâmetros da solicitação

Retornar resultados

POST para modificar observações da chave da API

POST /ep/api-keys/update-remark

Parâmetros da solicitação do corpo

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

Parâmetros da solicitação

Retornar resultados

Gestão de Equipes

POSTAGEM Criar Equipe

POST /ep/team/create

Parâmetros da solicitação do corpo

{
  "name": "string"
}

Parâmetros da solicitação

Voltar ao exemplo

200 Respostas

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

Retornar resultados

Estrutura de dados de retorno

Valor de enumeração

OBTER lista de equipes atualmente acessíveis ao usuário

GET /ep/team/list

Parâmetros da solicitação

Voltar ao exemplo

200 Respostas

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [{}],
    "total": 0,
    "page": 1,
    "page_size": 1
  },
  "request_id": "string"
}

Retornar resultados

Estrutura de dados de retorno

Valor de enumeração

Detalhes da equipe

OBTER /ep/equipe/detalhes

Parâmetros da solicitação

Voltar ao exemplo

200 Respostas

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

Retornar resultados

Estrutura de dados de retorno

Valor de enumeração

POSTAGEM para alterar o nome da equipe

POST /ep/team/update-name

Parâmetros da solicitação do corpo

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

Parâmetros da solicitação

Voltar ao exemplo

200 Respostas

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

Retornar resultados

Estrutura de dados de retorno

Valor de enumeração

POST dissolve a equipe

POST /ep/team/dissolve

Essa função só pode ser chamada pelo superadministrador da equipe. O nome na solicitação deve corresponder exatamente ao nome atual da equipe. Esta interface impõe uma verificação secundária: ela retorna o código 348 se o usuário não estiver em um 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 um processo de dissolução inacabado.

Parâmetros da solicitação do corpo

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

Parâmetros da solicitação

Valor de enumeração

Voltar ao exemplo

200 Respostas

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

Retornar resultados

Estrutura de dados de retorno

Valor de enumeração

Consulta GET para o status de dissolução da equipe

OBTER /ep/team/dissolve-status

Parâmetros da solicitação

Voltar ao exemplo

200 Respostas

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

Retornar resultados

Estrutura de dados de retorno

Valor de enumeração

Ativos da equipe

Obtenha informações sobre o pacote para equipes

OBTER /ep/team/product-info

Retorna um resumo do pacote para o espaço de recursos da equipe especificada, com campos consistentes com os campos do pacote em /web_v1/user/info. O perfil, o saldo ou o ID numérico interno da equipe do superadministrador não serão retornados. Para obter detalhes sobre os pacotes de pontos, acesse /web_v1/credit/info.

Parâmetros da solicitação

Voltar ao exemplo

200 Respostas

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

Retornar resultados

Estrutura de dados de retorno

Lista de ativos da equipe OBTER

OBTER /ep/team/assets

Parâmetros da solicitação

Voltar ao exemplo

200 Respostas

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [{}],
    "total": 0,
    "page": 1,
    "page_size": 1
  },
  "request_id": "string"
}

Retornar resultados

Estrutura de dados de retorno

OBTENHA ativos pessoais que podem ser incluídos na equipe.

OBTER /ep/team/assets/personal-candidates

Parâmetros da solicitação

Voltar ao exemplo

200 Respostas

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [{}],
    "total": 0,
    "page": 1,
    "page_size": 1
  },
  "request_id": "string"
}

Retornar resultados

Estrutura de dados de retorno

Transferência de ativos pessoais POST para a equipe

POST /ep/team/assets/moved-in

Parâmetros da solicitação do corpo

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

Parâmetros da solicitação

Voltar ao exemplo

200 Respostas

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

Retornar resultados

Estrutura de dados de retorno

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

POST /ep/team/assets/moved-out

Parâmetros da solicitação do corpo

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

Parâmetros da solicitação

Voltar ao exemplo

200 Respostas

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

Retornar resultados

Estrutura de dados de retorno

Carteira da Equipe

Consulta GET carteira da equipe

OBTER /ep/team/wallet/detail

É necessária a permissão VIEW_BILLING. A carteira da equipe é separada dos saldos individuais do superadministrador e dos membros.

Parâmetros da solicitação

Voltar ao exemplo

200 Respostas

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

Retornar resultados

Estrutura de dados de retorno

Consulta GET ao histórico de transações da carteira da equipe

OBTER /ep/team/wallet/records

É necessária a permissão VIEW_BILLING. Os valores das transações são sempre positivos e as alterações nos fundos são indicadas pelo campo de direção.

Parâmetros da solicitação

Voltar ao exemplo

200 Respostas

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [{}],
    "total": 0,
    "page": 1,
    "page_size": 1
  },
  "request_id": "string"
}

Retornar resultados

Estrutura de dados de retorno

Valor de enumeração

O saldo pessoal POST foi transferido para a carteira da equipe.

POST /ep/team/wallet/transfer-in

Somente os superadministradores da equipe têm a permissão TRANSFER_BALANCE. A transferência de fundos deduzirá automaticamente o valor do saldo de recarga pessoal do administrador e o adicionará à carteira da equipe; o valor transferido não está incluído no total_recharge_fee e não pode ser transferido de volta para o saldo pessoal.

Parâmetros da solicitação do corpo

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

Parâmetros da solicitação

Voltar ao exemplo

200 Respostas

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

Retornar resultados

Estrutura de dados de retorno

O saldo da equipe POST foi transferido de volta para a conta pessoal.

POST /ep/team/wallet/transfer-out

Esta função só pode ser chamada por um superadministrador logado. Ela deduz atomicamente do saldo da equipe e aumenta o saldo de recarga individual; ela não altera o valor total de recarga da equipe ou do indivíduo. Ela pode ser usada para recuperar saldos de equipes dissolvidas, mas não pode ser chamada por equipes dissolvidas.

Parâmetros da solicitação do corpo

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

Parâmetros da solicitação

Voltar ao exemplo

200 Respostas

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

Retornar resultados

Estrutura de dados de retorno

Membros da equipe

Lista de membros da equipe GET

OBTER /ep/team/members

Parâmetros da solicitação

Voltar ao exemplo

200 Respostas

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [{}],
    "total": 0,
    "page": 1,
    "page_size": 1
  },
  "request_id": "string"
}

Retornar resultados

Estrutura de dados de retorno

Valor de enumeração

Lista Unificada de Membros da Equipe GET

OBTER /ep/equipe/pessoas

Retorna os membros válidos; superadministradores e administradores também verão os convites pendentes. Outros status de convite são mantidos apenas na lista de histórico de convites.

Parâmetros da solicitação

Voltar ao exemplo

200 Respostas

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [{}],
    "total": 0,
    "page": 1,
    "page_size": 1
  },
  "request_id": "string"
}

Retornar resultados

Estrutura de dados de retorno

Valor de enumeração

POST Ajustar funções de membros

POST /ep/team/members/update-role

Parâmetros da solicitação do corpo

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

Parâmetros da solicitação

Valor de enumeração

Voltar ao exemplo

200 Respostas

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

Retornar resultados

Estrutura de dados de retorno

Valor de enumeração

POSTAGEM Remover membro da equipe

POST /ep/team/members/remove

Parâmetros da solicitação do corpo

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

Parâmetros da solicitação

Voltar ao exemplo

200 Respostas

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

Retornar resultados

Estrutura de dados de retorno

Valor de enumeração

POST - Sair da Equipe

POST /ep/team/members/leave

Parâmetros da solicitação do corpo

{
  "team_id": "A1b2C3d4E5f6"
}

Parâmetros da solicitação

Voltar ao exemplo

200 Respostas

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

Retornar resultados

Estrutura de dados de retorno

Valor de enumeração

Convite para a Equipe

POSTAGEM Criar convite para a equipe

POST /ep/team/invitations/create

Os convites são criados com base em usuários cadastrados, endereços de e-mail ou números de telefone. Quando um endereço de e-mail ou número de telefone corresponde a um usuário neste site, a resposta será normalizada para invite_type=1. O front-end pode enviar um modelo de caminho relativo da URL de convite deste site, e o servidor simplesmente substituirá por um token de convite de uso único. Se um usuário não registrado se cadastrar usando o número de celular do convite ou concluir a verificação usando o endereço de e-mail do convite, o servidor vinculará o convite ainda válido ao novo usuário, rotacionará o token e reenviará apenas uma mensagem não lida no aplicativo; o token antigo no e-mail ou SMS original se tornará inválido. Se o convite por e-mail ainda não tiver sido vinculado automaticamente, a conta atual registrada com o endereço de e-mail do convite poderá recebê-lo diretamente, sem precisar aguardar a verificação por e-mail.

Parâmetros da solicitação do corpo

{
  "team_id": "A1b2C3d4E5f6",
  "invite_type": 1,
  "role": 2,
  "user_id": 1,
  "email": "user@example.com",
  "country_code": 1,
  "phone": "string",
  "invitation_url_template": "/team/invitation/{{token}}"
}

Parâmetros da solicitação

Valor de enumeração

Voltar ao exemplo

200 Respostas

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "invitation": {
      "id": null,
      "team_id": null,
      "inviter_user_id": null,
      "invitee_user_id": null,
      "invite_type": null,
      "invite_country_code": null,
      "invite_target": null,
      "delivery_type": null,
      "role": null,
      "status": null,
      "accepted_by_user_id": null,
      "expired_at": null,
      "accepted_at": null,
      "rejected_at": null,
      "cancelled_at": null,
      "created_at": null
    },
    "invitation_token": "string",
    "invitation_url": "http://example.com",
    "notification_channels": {
      "email": null,
      "sms": null,
      "site_inner_message": null
    }
  },
  "request_id": "string"
}

Retornar resultados

Estrutura de dados de retorno

Valor de enumeração

GET Lista de convidados da equipe

OBTER /ep/team/invitations

O acesso está disponível apenas para superadministradores ou administradores da equipe; convites pendentes expirados serão atualizados para expirados antes de retornarem.

Parâmetros da solicitação

Voltar ao exemplo

200 Respostas

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [{}],
    "total": 0,
    "page": 1,
    "page_size": 1
  },
  "request_id": "string"
}

Retornar resultados

Estrutura de dados de retorno

Valor de enumeração

RECEBA o convite para a Equipe de Pré-visualização

OBTER /ep/team/invitations/preview

Convites de pré-visualização anônimos são enviados usando um token de convite único; o ID numérico do convite não é usado no link.

Parâmetros da solicitação

Voltar ao exemplo

200 Respostas

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

Retornar resultados

Estrutura de dados de retorno

Valor de enumeração

POST reenviar notificação de convite da equipe

POST /ep/team/invitations/resend

Reenvie o convite pelo canal de distribuição original; os usuários registrados também receberão uma mensagem no aplicativo. O reenvio rotacionará os tokens e todos os links de convite anteriores se tornarão inválidos imediatamente.

Parâmetros da solicitação do corpo

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

Parâmetros da solicitação

Voltar ao exemplo

200 Respostas

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "invitation": {
      "id": null,
      "team_id": null,
      "inviter_user_id": null,
      "invitee_user_id": null,
      "invite_type": null,
      "invite_country_code": null,
      "invite_target": null,
      "delivery_type": null,
      "role": null,
      "status": null,
      "accepted_by_user_id": null,
      "expired_at": null,
      "accepted_at": null,
      "rejected_at": null,
      "cancelled_at": null,
      "created_at": null
    },
    "invitation_url": "http://example.com",
    "notification_channels": {
      "email": null,
      "sms": null,
      "site_inner_message": null
    }
  },
  "request_id": "string"
}

Retornar resultados

Estrutura de dados de retorno

Valor de enumeração

POST ACEITAR convite para a equipe

POST /ep/team/invitations/accept

O usuário atualmente conectado aceita o convite usando um token de convite único, que deve corresponder ao destino do convite e pertencer ao site ao qual o convite se refere; o team_id não precisa ser informado.

Parâmetros da solicitação do corpo

{
  "invitation_token": "string"
}

Parâmetros da solicitação

Voltar ao exemplo

200 Respostas

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

Retornar resultados

Estrutura de dados de retorno

Valor de enumeração

POSTAGEM - Rejeitar convite para a equipe

POST /ep/team/invitations/reject

O usuário atualmente conectado utiliza um token de convite único para rejeitar convites que correspondam à sua identidade; o ID da equipe não é obrigatório.

Parâmetros da solicitação do corpo

{
  "invitation_token": "string"
}

Parâmetros da solicitação

Voltar ao exemplo

200 Respostas

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

Retornar resultados

Estrutura de dados de retorno

Valor de enumeração

Cancelar convite da equipe

POST /ep/team/invitations/cancel

Para cancelar convites pendentes em uma equipe específica, o operador deve ter autoridade para convidar o usuário para essa função.

Parâmetros da solicitação do corpo

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

Parâmetros da solicitação

Voltar ao exemplo

200 Respostas

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

Retornar resultados

Estrutura de dados de retorno

Valor de enumeração

Gestão de Pontos

Obtenha informações sobre o pacote de pontos

GET /web_v1/credit/info

Consulte o resumo dos pacotes de pontos para o espaço de recursos atual. O espaço de equipe requer a permissão USE_ASSETS; esta interface é compatível com o status de login, chave de API pessoal e chave de API da equipe.

Parâmetros da solicitação

Voltar ao exemplo

200 Respostas

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

Retornar resultados

Estrutura de dados de retorno

POST para configurar a reposição automática de pontos para o saldo

POST /web_v1/credit/update-auto-supplement

Essa configuração permite o reabastecimento automático do espaço de recursos atual enquanto você estiver conectado. O espaço de equipe requer a permissão USE_OWNER_PAYMENT_CAPABILITIES e atualmente só pode ser acessado pelo superadministrador da equipe; o espaço de equipe está desativado por padrão.

Parâmetros da solicitação do corpo

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

Parâmetros da solicitação

Valor de enumeração

Voltar ao exemplo

200 Respostas

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

Retornar resultados

Estrutura de dados de retorno

OBTER Obter registro de consumo de pontos

GET /web_v1/credit/consumption-logs

O status de login ou a chave de API permite a consulta paginada dos registros de consumo de pontos de espaço de recursos atuais. Os espaços de equipe exigem a permissão VIEW_BILLING.

Parâmetros da solicitação

Voltar ao exemplo

200 Respostas

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

Retornar resultados

Estrutura de dados de retorno

RECEBER Recuperar Pontos Reiniciar Registro

GET /web_v1/credit/reset-logs

Status de login ou chave de API: consulta página por página dos registros de redefinição de pontos para o espaço de recursos atual. Os espaços de equipe exigem a permissão VIEW_BILLING.

Parâmetros da solicitação

Voltar ao exemplo

200 Respostas

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

Retornar resultados

Estrutura de dados de retorno

Obtenha estatísticas de pontos via GET

OBTER /web_v1/credit/stats

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

Parâmetros da solicitação

Voltar ao exemplo

200 Respostas

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

Retornar resultados

Estrutura de dados de retorno

RECEBA Estatísticas diárias de pontos

OBTER /web_v1/credit/daily-stats

Consulta de status de login ou chave de API para consumo diário de créditos do espaço de recursos atual, com valores padrão de 7 dias. Membros comuns da equipe visualizam apenas seu próprio consumo; administradores, superadministradores e membros da área financeira com privilégios VIEW_BILLING visualizam os dados completos da equipe. Os registros da equipe para membros sem histórico de consumo são visíveis apenas para a visualização completa. As consultas de chave de API podem conter um máximo de 31 dias corridos (inclusive), com a data de início não posterior à data de término.

Parâmetros da solicitação

Valor de enumeração

Voltar ao exemplo

200 Respostas

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

Retornar resultados

Estrutura de dados de retorno

OBTER Estatísticas de pontos por hora

OBTER /web_v1/credit/hourly-stats

Consulta de status de login ou chave de API para consumo de crédito por hora do espaço de recursos atual, considerando os últimos 7 dias por padrão. Espaços de equipe exigem a permissão VIEW_BILLING. As consultas de chave de API podem conter um máximo de 31 dias corridos (inclusive), e a data de início não pode ser posterior à data de término.

Parâmetros da solicitação

Valor de enumeração

Voltar ao exemplo

200 Respostas

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

Retornar resultados

Estrutura de dados de retorno

Obtenha informações sobre o pacote de pontos

OBTER /ep/credit/info

Consulte o resumo dos pacotes de pontos para o espaço de recursos atual. O espaço de equipe requer a permissão USE_ASSETS; esta interface é compatível com o status de login, chave de API pessoal e chave de API da equipe.

Parâmetros da solicitação

Voltar ao exemplo

200 Respostas

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

Retornar resultados

Estrutura de dados de retorno

OBTER Obter registro de consumo de pontos

OBTER /ep/credit/consumption-logs

O status de login ou a chave de API permite a consulta paginada dos registros de consumo de pontos de espaço de recursos atuais. Os espaços de equipe exigem a permissão VIEW_BILLING.

Parâmetros da solicitação

Voltar ao exemplo

200 Respostas

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

Retornar resultados

Estrutura de dados de retorno

RECEBER Recuperar Pontos Reiniciar Registro

OBTER /ep/credit/reset-logs

Status de login ou chave de API: consulta página por página dos registros de redefinição de pontos para o espaço de recursos atual. Os espaços de equipe exigem a permissão VIEW_BILLING.

Parâmetros da solicitação

Voltar ao exemplo

200 Respostas

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

Retornar resultados

Estrutura de dados de retorno

Obtenha estatísticas de pontos via GET

OBTER /ep/credit/stats

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

Parâmetros da solicitação

Voltar ao exemplo

200 Respostas

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

Retornar resultados

Estrutura de dados de retorno

RECEBA Estatísticas diárias de pontos

OBTER /ep/credit/daily-stats

Consulta de status de login ou chave de API para consumo diário de créditos do espaço de recursos atual, com valores padrão de 7 dias. Membros comuns da equipe visualizam apenas seu próprio consumo; administradores, superadministradores e membros da área financeira com privilégios VIEW_BILLING visualizam os dados completos da equipe. Os registros da equipe para membros sem histórico de consumo são visíveis apenas para a visualização completa. As consultas de chave de API podem conter um máximo de 31 dias corridos (inclusive), com a data de início não posterior à data de término.

Parâmetros da solicitação

Valor de enumeração

Voltar ao exemplo

200 Respostas

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

Retornar resultados

Estrutura de dados de retorno

OBTER Estatísticas de pontos por hora

OBTER /ep/credit/hourly-stats

Consulta de status de login ou chave de API para consumo de crédito por hora do espaço de recursos atual, considerando os últimos 7 dias por padrão. Espaços de equipe exigem a permissão VIEW_BILLING. As consultas de chave de API podem conter um máximo de 31 dias corridos (inclusive), e a data de início não pode ser posterior à data de término.

Parâmetros da solicitação

Valor de enumeração

Voltar ao exemplo

200 Respostas

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

Retornar resultados

Estrutura de dados de retorno

Registro de atividades do Xcrawl

OBTER Lista de Tarefas Recentes do Xcrawl

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

Faça login para consultar a lista e o resumo das tarefas individuais no espaço de recursos atual. O espaço de equipe requer a permissão USE_ASSETS; membros comuns só podem visualizar tarefas geradas por suas próprias credenciais, enquanto administradores e superadministradores podem visualizar todas as tarefas da equipe.

Parâmetros da solicitação

Valor de enumeração

Voltar ao exemplo

200 Respostas

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

Retornar resultados