דילוג לתוכן
אומת

קריאת החשבון המחובר

שליפת אותה רשומת חשבון שדף בדשבורד קורא בטעינה, בקריאה אחת וללא שדות.

get_account_info היא אותה קריאה שהדשבורד מבצע בכל טעינת דף: ללא פרמטרים מלבד האישור שלכם, רשומת חשבון אחת חוזרת, ובה מצב התוכנית, השימוש, האחסון והחיוב בסבב אחד. כדאי להשתמש בה כל פעם שה-backend שלכם צריך לדעת עם מי הוא מדבר, או באיזו תוכנית ומכסה החשבון נמצא כרגע.

שיטה

POST/cpi/get_account_info
user

Get Account Info

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

הדרכה צעד אחר צעד

קוראים לה עם המפתח בלבד

get_account_info לא מצהירה על שדות משלה. החשבון שהיא עונה עבורו הוא זה שהאישור שלכם מאמת: מפתח API ברמת חשבון או ברמת פרויקט בגוף הבקשה, או כותרת xu-gtp-token של מבקר מחובר אם קוראים לה מתוך סשן דפדפן.

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

התשובה

data הוא מסמך החשבון, מקוצץ למה שלקוח צריך לקרוא. השדות להלן הם המפתחות האמיתיים ש-get_account_data בונה מהם את התשובה, לא דוגמה למבנה גדול יותר שאינו ידוע:

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 הוא הפרופיל: האימייל הוא השדה שרוב האינטגרציות ייעזרו בו כמפתח.
  • is_boarded הוא ערך בוליאני מפורש (אף פעם לא חסר), אותו דגל שהדשבורד קורא כדי להחליט אם להציג היכרות ראשונית.
  • drive_usage.quota_bytes / quota_unlimited הוא אותה תקרה שפס האחסון משרטט ממנה; quota_unlimited: true אומר שאין להסיק דבר מהערך quota_bytes של החשבון הזה.
  • billing_status נושא כל דגל של עצירה, השעיה או סגירה כאובייקט אחד. כל מה שבתוכו הוא null (או 0) בחשבון תקין, ולכן ערך אמת כלשהו שם הוא כל האות שצריך כדי לעצור ולהציג הודעת חיוב במקום להמשיך.

שגיאות

ראו שגיאות לקודים המשותפים לכל השיטות.

הבא