Hopp til innholdet
Bekreftet

Les den innloggede kontoen

Hent den samme kontoposten en side i oversiktspanelet leser, med ett kall og uten felt.

get_account_info er det samme kallet oversiktspanelet gjør ved hver sideinnlasting: ingen parametere utover legitimasjonen din, én kontopost tilbake, som dekker plan, bruk, lagring og faktureringstilstand i én runde. Bruk det når din egen backend trenger å vite hvem den snakker med, eller hvilken plan og kvote kontoen er på akkurat nå.

Metode

POST/cpi/get_account_info
user

Get Account Info

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

Gjennomgang

Kall den med ingenting annet enn nøkkelen din

get_account_info deklarerer ingen egne felt. Kontoen den svarer for er den legitimasjonen din autentiserer, en API-nøkkel på konto- eller prosjektnivå i innholdet, eller xu-gtp-token-headeren til en innlogget besøkende hvis du kaller dette fra en nettleserøkt 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, kuttet ned til det en klient bør lese. Feltene nedenfor er de ekte nøklene get_account_data bygger svaret fra, ikke et utvalg av en større ukjent 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-post er feltet de fleste integrasjoner bruker som nøkkel.
  • is_boarded er en eksplisitt boolsk verdi (aldri manglende), det samme flagget oversiktspanelet leser for å avgjøre om introduksjonen skal vises.
  • drive_usage.quota_bytes / quota_unlimited er det samme taket lagringslinjen tegnes ut fra. quota_unlimited: true betyr at du ikke skal lese noe inn i quota_bytes for den kontoen.
  • billing_status har hvert flagg for stans, suspensjon og avslutning som ett objekt. Alt i det er null (eller 0) på en frisk konto, så en sann verdi hvor som helst der er hele signalet du trenger for å stoppe og vise en faktureringsmelding i stedet for å gå videre.

Feil

Se Feil for kodene alle metoder deler.

Neste