Zum Inhalt springen
Geprüft

Das angemeldete Konto lesen

Hole mit einem Aufruf und ohne Felder denselben Kontodatensatz, den ein Dashboard beim Laden einer Seite liest.

get_account_info ist derselbe Aufruf, den das Dashboard bei jedem Laden einer Seite macht: keine Parameter außer deiner Zugangsberechtigung, ein Kontodatensatz als Antwort, der Tarif, Nutzung, Speicher und Abrechnungsstatus in einem einzigen Roundtrip abdeckt. Nutze ihn immer dann, wenn dein eigenes Backend wissen muss, mit wem es spricht oder in welchem Tarif und Kontingent dieses Konto gerade ist.

Methode

POST/cpi/get_account_info
user

Get Account Info

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

Schritt für Schritt

Rufe sie mit nichts als deinem Schlüssel auf

get_account_info deklariert keine eigenen Felder. Das Konto, für das sie antwortet, ist dasjenige, das deine Zugangsberechtigung authentifiziert: ein konto- oder projektbezogener API-Schlüssel im Body, oder der xu-gtp-token-Header eines angemeldeten Besuchers, wenn du den Aufruf stattdessen aus einer Browsersitzung machst.

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

Die Antwort

data ist das Kontodokument, gekürzt auf das, was ein Client lesen sollte. Die Felder unten sind die echten Schlüssel, aus denen get_account_data die Antwort baut, kein Ausschnitt einer größeren unbekannten Struktur:

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 ist das Profil: Die E-Mail-Adresse ist das Feld, an dem du die meisten Integrationen festmachst.
  • is_boarded ist ein ausdrücklicher Boolean (fehlt nie), dasselbe Flag, mit dem das Dashboard entscheidet, ob das Onboarding gezeigt wird.
  • drive_usage.quota_bytes / quota_unlimited ist dieselbe Obergrenze, aus der der Speicherbalken gezeichnet wird. quota_unlimited: true bedeutet, dass du quota_bytes bei diesem Konto keine Bedeutung beimessen sollst.
  • billing_status enthält jedes Flag für Sperre, Aussetzung und Beendigung als ein Objekt. Alles darin ist bei einem gesunden Konto null (oder 0). Ein wahrer Wert irgendwo darin ist also das ganze Signal, das du brauchst, um anzuhalten und eine Abrechnungsmeldung zu zeigen, statt fortzufahren.

Fehler

Unter Fehler findest du die Codes, die für jede Methode gelten.

Weiter