Saltar para o conteúdo
Verificado

Ler a conta com sessão iniciada

Obtenha o mesmo registo de conta que um painel lê ao carregar a página, com uma chamada e sem campos.

get_account_info é a mesma chamada que o painel faz em cada carregamento de página: sem parâmetros além da sua credencial, regressa um registo de conta, que cobre o plano, a utilização, o armazenamento e o estado de faturação numa só ida e volta. Use-a sempre que o seu próprio backend precise de saber com quem está a falar, ou em que plano e quota essa conta está atualmente.

Método

POST/cpi/get_account_info
user

Get Account Info

Returns the account data for the requesting user, optionally enforcing usage limits.

Passo a passo

Chame-o apenas com a sua chave

get_account_info não declara campos próprios. A conta a que responde é aquela que a sua credencial autentica, uma chave de API de conta ou de projeto no corpo, ou o cabeçalho xu-gtp-token de um visitante com sessão iniciada se estiver a chamá-lo a partir de uma sessão de navegador.

curl -s https://xuda.ai/cpi/get_account_info \
  -H 'content-type: application/json' \
  -d '{"api_key":"YOUR_API_KEY"}'
const res = await fetch('https://xuda.ai/cpi/get_account_info', {
  method: 'POST',
  headers: { 'content-type': 'application/json' },
  body: JSON.stringify({ api_key: 'YOUR_API_KEY' }),
});
const { code, data } = await res.json();
if (code > 0) console.log(data.account_info.email, data.membership_plan);
import requests

res = requests.post(
    'https://xuda.ai/cpi/get_account_info',
    json={'api_key': 'YOUR_API_KEY'},
)
body = res.json()
if body['code'] > 0:
    print(body['data']['account_info']['email'], body['data']['membership_plan'])

A resposta

data é o documento da conta, reduzido ao que um cliente deve ler. Os campos abaixo são as chaves reais a partir das quais get_account_data constrói a resposta, não uma amostra de uma estrutura maior desconhecida:

json
{
  "code": 1,
  "data": {
    "_id": "acc_8f2a1c",
    "uid": "acc_8f2a1c",
    "account_info": {
      "email": "[email protected]",
      "first_name": "Jordan",
      "last_name": "Rivera",
      "phone_number": "+1 555 0142"
    },
    "stat": 3,
    "is_boarded": true,
    "membership_plan": "growth",
    "plan_info": { "...": "the current plan's own fields" },
    "support_plan": "standard",
    "ai_workspace_plan": "starter",
    "account_project_id": "app_5d9e21",
    "account_hosted_email": null,
    "drive_plan": "drive_free",
    "drive_usage": {
      "user_drive_size": 18291029,
      "studio_drive_size": 402981,
      "workspace_drive_size": 0,
      "total_drive_size": 18694010,
      "quota_bytes": 5368709120,
      "quota_unlimited": false
    },
    "billing_status": {
      "account_suspension_status": null,
      "account_billing_hold_status": null,
      "account_termination_status": null,
      "account_email_bounce_suspended": 0
    },
    "preferences": {},
    "login_screen": { "...": "the effective pre-auth login screen for this account" }
  }
}
  • account_info é o perfil: o e-mail é o campo em que vai basear a maioria das integrações.
  • is_boarded é um booleano explícito (nunca em falta), a mesma flag que o painel lê para decidir se mostra a integração inicial.
  • drive_usage.quota_bytes / quota_unlimited é o mesmo limite a partir do qual a barra de armazenamento é desenhada; quota_unlimited: true significa que não deve atribuir qualquer sentido a quota_bytes nessa conta.
  • billing_status traz todas as flags de retenção, suspensão e terminação num só objeto. Tudo nele é null (ou 0) numa conta saudável, por isso um valor verdadeiro em qualquer ponto é todo o sinal de que precisa para parar e mostrar uma mensagem de faturação em vez de prosseguir.

Erros

Consulte Erros para ver os códigos partilhados por todos os métodos.

A seguir