Preskočiť na obsah
Overené

Prečítať prihlásený účet

Načítajte ten istý záznam účtu, aký číta načítanie stránky dashboardu, jedným volaním a bez polí.

get_account_info je to isté volanie, ktoré dashboard robí pri každom načítaní stránky: žiadne parametre okrem vášho poverenia, späť jeden záznam účtu, ktorý v jednom kole pokrýva plán, využitie, úložisko a stav fakturácie. Použite ho vždy, keď váš vlastný backend potrebuje vedieť, s kým sa rozpráva, alebo na akom pláne a kvóte je daný účet práve teraz.

Method

POST/cpi/get_account_info
user

Get Account Info

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

Walkthrough

Call it with nothing but your key

get_account_info nedeklaruje vlastné polia. Účet, na ktorý odpovedá, je ten, ktorý vaše poverenie overuje: API kľúč účtu alebo projektu v tele, alebo hlavička xu-gtp-token prihláseného návštevníka, ak ho voláte z relácie prehliadača.

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

The response

data je dokument účtu, skrátený na to, čo má klient čítať. Polia nižšie sú skutočné kľúče, z ktorých get_account_data zostavuje odpoveď, nie ukážka väčšieho neznámeho tvaru:

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 je profil: e-mail je pole, podľa ktorého budete väčšinu integrácií indexovať.
  • is_boarded je výslovný boolean (nikdy nechýba), ten istý príznak, ktorý dashboard číta, aby rozhodol, či zobraziť zapracovanie.
  • drive_usage.quota_bytes / quota_unlimited je ten istý strop, z ktorého sa kreslí pruh úložiska; quota_unlimited: true znamená, že pre daný účet nemáte z quota_bytes vyvodzovať žiadny význam.
  • billing_status nesie každý príznak blokovania, pozastavenia a ukončenia ako jeden objekt. Všetko v ňom je null (alebo 0) na zdravom účte, takže pravdivá hodnota kdekoľvek tam je celý signál, ktorý potrebujete, aby ste sa zastavili a zobrazili správu o fakturácii namiesto pokračovania.

Errors

Kódy spoločné pre každú metódu nájdete v časti Errors.

Next