Hoppa till innehållet
Verifierad

Läs det inloggade kontot

Hämta samma kontopost som en sidladdning i instrumentpanelen läser, med ett anrop och inga fält.

get_account_info är samma anrop som instrumentpanelen gör vid varje sidladdning: inga parametrar utöver din inloggningsuppgift, en kontopost tillbaka, som täcker plan, användning, lagring och faktureringsstatus i en enda rundtur. Använd det när din egen backend behöver veta vem den pratar med, eller vilken plan och kvot kontot just nu har.

Metod

POST/cpi/get_account_info
user

Get Account Info

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

Genomgång

Anropa det med bara din nyckel

get_account_info deklarerar inga egna fält. Kontot det svarar för är det som din inloggningsuppgift autentiserar, en API-nyckel för konto eller projekt i kroppen, eller en inloggad besökares xu-gtp-token-header om du anropar det från en webbläsarsession i stället.

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 är kontodokumentet, beskuret till det en klient bör läsa. Fälten nedan är de verkliga nycklar som get_account_data bygger svaret av, inte ett urval av en större okänd 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 är profilen: e-postadressen är det fält du kommer att nyckla de flesta integrationer på.
  • is_boarded är en uttrycklig boolesk (saknas aldrig), samma flagga som instrumentpanelen läser för att avgöra om introduktionen ska visas.
  • drive_usage.quota_bytes / quota_unlimited är samma tak som lagringsfältet ritas från; quota_unlimited: true betyder att du inte ska läsa någon mening i quota_bytes för det kontot.
  • billing_status bär varje flagga för spärr, avstängning och avslut som ett enda objekt. Allt i det är null (eller 0) på ett friskt konto, så ett sant värde var som helst där är hela signalen du behöver för att stanna och visa ett faktureringsmeddelande i stället för att gå vidare.

Fel

Se Fel för de koder som delas av alla metoder.

Nästa