Przejdź do treści
Zweryfikowano

Odczytaj zalogowane konto

Pobierz ten sam rekord konta, który czyta strona pulpitu przy ładowaniu, jednym wywołaniem i bez pól.

get_account_info to to samo wywołanie, które pulpit wykonuje przy każdym załadowaniu strony: żadnych parametrów poza Twoim poświadczeniem, jeden rekord konta w odpowiedzi, obejmujący plan, użycie, miejsce na dane i stan rozliczeń w jednej rundzie. Sięgnij po nie, ilekroć Twój backend musi wiedzieć, z kim rozmawia albo na jakim planie i limicie jest to konto.

Metoda

POST/cpi/get_account_info
user

Get Account Info

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

Krok po kroku

Wywołaj je samym kluczem

get_account_info nie deklaruje własnych pól. Konto, dla którego odpowiada, to to, które uwierzytelnia Twoje poświadczenie: klucz API o zakresie konta lub projektu w treści albo nagłówek xu-gtp-token zalogowanego odwiedzającego, jeśli wywołujesz to z sesji przeglądarki.

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

Odpowiedź

data to dokument konta, przycięty do tego, co powinien czytać klient. Poniższe pola to prawdziwe klucze, z których get_account_data buduje odpowiedź, a nie próbka większego nieznanego kształtu:

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 to profil: e-mail to pole, po którym zindeksujesz większość integracji.
  • is_boarded to jawna wartość logiczna (nigdy nie brakuje), ta sama flaga, którą pulpit czyta, żeby zdecydować, czy pokazać wprowadzenie.
  • drive_usage.quota_bytes / quota_unlimited to ten sam pułap, z którego rysuje się pasek miejsca; quota_unlimited: true oznacza, że nie należy doszukiwać się znaczenia w quota_bytes dla tego konta.
  • billing_status niesie każdą flagę blokady/zawieszenia/zamknięcia jako jeden obiekt. Na zdrowym koncie wszystko w nim to null (lub 0), więc prawdziwa wartość gdziekolwiek w nim to cały sygnał potrzebny, żeby się zatrzymać i pokazać komunikat o rozliczeniach zamiast iść dalej.

Błędy

Zobacz Błędy, żeby poznać kody wspólne dla każdej metody.

Dalej