Gå til indhold
Bekræftet

Læs den loggede konto

Hent den samme kontopost, som en dashboard-sideindlæsning læser, med ét kald og ingen felter.

get_account_info er det samme kald, dashboardet foretager ved hver sideindlæsning: ingen parametre ud over din legitimation, én kontopost tilbage, der dækker plan, forbrug, lager og faktureringstilstand i ét rundtur. Brug det, når din egen backend skal vide, hvem den taler med, eller hvilken plan og kvote kontoen aktuelt har.

Metode

POST/cpi/get_account_info
user

Get Account Info

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

Gennemgang

Kald den med intet andet end din nøgle

get_account_info erklærer ingen egne felter. Kontoen, den svarer for, er den, din legitimation godkender: en kontoafgrænset eller projektafgrænset API-nøgle i brødteksten, eller en logget besøgendes xu-gtp-token-header, hvis du kalder den fra en browsersession i stedet.

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

Svaret

data er kontodokumentet, beskåret til det, en klient bør læse. Felterne nedenfor er de reelle nøgler, get_account_data bygger svaret ud fra, ikke et udsnit af en større ukendt form:

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 er profilen: e-mail er det felt, du vil nøgle de fleste integrationer på.
  • is_boarded er en eksplicit boolean (aldrig manglende), det samme flag, dashboardet læser for at afgøre, om introduktionen skal vises.
  • drive_usage.quota_bytes / quota_unlimited er det samme loft, som lagerlinjen tegnes ud fra; quota_unlimited: true betyder, at du ikke skal læse noget i quota_bytes for den konto.
  • billing_status bærer alle flag for spærring, suspendering og nedlukning som ét objekt. Alt i det er null (eller 0) på en sund konto, så en sand værdi et vilkårligt sted deri er hele det signal, du har brug for til at stoppe og vise en faktureringsbesked i stedet for at fortsætte.

Fejl

Se Fejl for de koder, alle metoder deler.

Næste