Ugrás a tartalomhoz
Ellenőrizve

A bejelentkezett fiók beolvasása

Kérje le ugyanazt a fiókrekordot, amelyet egy irányítópult-oldal betöltése olvas, egyetlen hívással és mezők nélkül.

A get_account_info ugyanaz a hívás, amelyet az irányítópult minden oldalbetöltéskor végez: a hitelesítő adaton kívül nincs paraméter, egyetlen fiókrekord jön vissza, amely egyetlen körben lefedi a csomagot, a használatot, a tárhelyet és a számlázási állapotot. Akkor nyúljon hozzá, amikor a saját háttérrendszerének tudnia kell, kivel beszél, vagy hogy a fiók éppen milyen csomagon és kvótán van.

Metódus

POST/cpi/get_account_info
user

Get Account Info

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

Végigvezető

Hívja meg a kulcsán kívül semmivel

A get_account_info nem deklarál saját mezőket. A fiók, amelyre válaszol, az, amelyet a hitelesítő adata azonosít: fiókhoz vagy projekthez kötött API-kulcs a törzsben, vagy egy bejelentkezett látogató xu-gtp-token fejléce, ha ehelyett böngészőmunkamenetből hívja.

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 válasz

A data a fiókdokumentum, arra vágva, amit egy kliensnek olvasnia kell. Az alábbi mezők a valódi kulcsok, amelyekből a get_account_data a választ építi, nem egy nagyobb ismeretlen alak mintája:

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" }
  }
}
  • Az account_info a profil: az e-mail az a mező, amelyre a legtöbb integrációt kulcsolni fogja.
  • Az is_boarded kifejezett logikai érték (soha nem hiányzik), ugyanaz a jelző, amelyből az irányítópult eldönti, hogy megjelenítse-e a bevezetést.
  • A drive_usage.quota_bytes / quota_unlimited ugyanaz a plafon, amelyből a tárhelysáv rajzol; a quota_unlimited: true azt jelenti, hogy annál a fióknál ne tulajdonítson jelentést a quota_bytes értéknek.
  • A billing_status minden zárolási/felfüggesztési/megszüntetési jelzőt egyetlen objektumként hordoz. Egészséges fióknál minden benne null (vagy 0), így bármely igaz érték ott a teljes jel, amely alapján meg kell állnia, és számlázási üzenetet kell mutatnia a folytatás helyett.

Hibák

A minden metódus által közös kódokat lásd az Errors oldalon.

Következő