Aller au contenu
Vérifié

Lire le compte connecté

Récupérez le même enregistrement de compte que lit le chargement d'une page du tableau de bord, avec un seul appel et aucun champ.

get_account_info est le même appel que le tableau de bord effectue à chaque chargement de page : aucun paramètre en dehors de votre identifiant, un enregistrement de compte en retour, couvrant le forfait, l'utilisation, le stockage et l'état de facturation en un seul aller-retour. Utilisez-le chaque fois que votre propre backend doit savoir à qui il parle, ou quel forfait et quel quota ce compte a actuellement.

Méthode

POST/cpi/get_account_info
user

Get Account Info

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

Pas à pas

Appelez-la avec votre seule clé

get_account_info ne déclare aucun champ. Le compte pour lequel elle répond est celui que votre identifiant authentifie : une clé API de compte ou de projet dans le corps, ou l'en-tête xu-gtp-token d'un visiteur connecté si vous l'appelez plutôt depuis une session de navigateur.

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'])

La réponse

data est le document du compte, réduit à ce qu'un client doit lire. Les champs ci-dessous sont les vraies clés à partir desquelles get_account_data construit la réponse, pas un échantillon d'une forme plus grande et inconnue :

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 est le profil : l'e-mail est le champ sur lequel vous appuierez la plupart des intégrations.
  • is_boarded est un booléen explicite (jamais absent), le même indicateur que lit le tableau de bord pour décider s'il doit afficher l'intégration initiale.
  • drive_usage.quota_bytes / quota_unlimited est le même plafond que dessine la barre de stockage ; quota_unlimited: true signifie qu'il ne faut accorder aucun sens à quota_bytes pour ce compte.
  • billing_status porte tous les indicateurs de blocage, de suspension et de résiliation dans un seul objet. Tout y vaut null (ou 0) sur un compte sain : une valeur vraie à cet endroit est donc tout le signal dont vous avez besoin pour vous arrêter et afficher un message de facturation au lieu de continuer.

Erreurs

Consultez Erreurs pour les codes communs à toutes les méthodes.

Suite