Naar de inhoud springen
Geverifieerd

Het ingelogde account lezen

Haal met één aanroep en zonder velden hetzelfde accountrecord op dat een dashboardpagina bij het laden leest.

get_account_info is dezelfde aanroep die het dashboard bij elke paginalading doet: geen parameters behalve je inloggegevens, één accountrecord terug met abonnement, gebruik, opslag en factureringsstatus in één keer. Gebruik hem als je eigen backend moet weten met wie hij praat, of op welk abonnement en welke quota dat account zit.

Methode

POST/cpi/get_account_info
user

Get Account Info

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

Stappenplan

Roep hem aan met alleen je sleutel

get_account_info heeft geen eigen velden. Het account waarvoor hij antwoordt is het account dat je inloggegevens authenticeren: een API-sleutel van een account of project in de body, of de xu-gtp-token-header van een ingelogde bezoeker als je dit vanuit een browsersessie aanroept.

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

Het antwoord

data is het accountdocument, teruggebracht tot wat een client hoort te lezen. De velden hieronder zijn de echte sleutels waaruit get_account_data het antwoord opbouwt, geen steekproef uit een grotere onbekende vorm:

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 is het profiel: het e-mailadres is het veld waarop je de meeste integraties baseert.
  • is_boarded is een expliciete boolean (nooit afwezig), dezelfde vlag die het dashboard leest om te bepalen of de onboarding getoond wordt.
  • drive_usage.quota_bytes / quota_unlimited is hetzelfde plafond waar de opslagbalk van uitgaat; quota_unlimited: true betekent dat je aan quota_bytes voor dat account geen betekenis moet hechten.
  • billing_status bevat elke vlag voor blokkade, opschorting en beëindiging als één object. Alles erin is null (of 0) bij een gezond account, dus een waarde die waar is, waar dan ook daarin, is het hele signaal dat je moet stoppen en een factureringsbericht moet tonen in plaats van door te gaan.

Fouten

Zie Errors voor de codes die elke methode deelt.

Volgende stap