τεκμηρίωση
API πίνακα ελέγχου

Προφίλ και ασφάλεια

Markdown

Μέθοδοι, πεδία αιτημάτων και απαντήσεις.

Πλήρης οδηγός

Η ενότητα περιλαμβάνει 6 μεθόδους. Ανοίξτε τη μέθοδο για να δείτε τους όρους πρόσβασης, τα πεδία αιτήματος και την απάντηση.

Μέθοδος και διαδρομήΠεριγραφήΠρόσβαση
PUT /api/v1/userΤροποποίηση προφίλToken πίνακα ελέγχου
GET /api/v1/user/passkeysΛίστα passkeyToken πίνακα ελέγχου
PUT /api/v1/user/passwordΑλλαγή κωδικού πρόσβασηςToken πίνακα ελέγχου
GET /api/v1/user/profileΠροφίλ, υπόλοιπο και συνδέσεις λογαριασμούToken πίνακα ελέγχου
GET /api/v1/user/totp/statusΚατάσταση 2FA (TOTP)Token πίνακα ελέγχου
GET /api/v1/user/totp/verification-methodΜέθοδος επαλήθευσης TOTPToken πίνακα ελέγχου
PUT /api/v1/user — Τροποποίηση προφίλ

Πρόσβαση: Token πίνακα ελέγχου

PUT/api/v1/user

Πεδία JSON / φόρμας

Το πεδίοΤύποςΥποχρεωτικόΈλεγχος / περιγραφή
usernamestringόχι; μπορεί να είναι null
avatar_urlstringόχι; μπορεί να είναι null
balance_notify_enabledbooleanόχι; μπορεί να είναι null
balance_notify_thresholdnumberόχι; μπορεί να είναι null
Πρότυπο σώματος αιτήματος
{
  "username": "PLACEHOLDER_USERNAME (string)",
  "avatar_url": "PLACEHOLDER_AVATAR_URL (string)",
  "balance_notify_enabled": "PLACEHOLDER_BALANCE_NOTIFY_ENABLED (boolean)",
  "balance_notify_threshold": "PLACEHOLDER_BALANCE_NOTIFY_THRESHOLD (number)"
}

Το PLACEHOLDER υποδηλώνει τη δική σας είσοδο και τον τύπο της. Αντικαταστήστε τις τιμές και κρατήστε μόνο τα προαιρετικά πεδία που χρειάζονται· οι συμβολοσειρές-δείκτες δεν αποστέλλονται αντί για αριθμούς, boolean, αντικείμενα ή πίνακες.

Σχήμα αιτήματος: UpdateProfileRequest

Απάντηση

Η απάντηση JSON περιέχει code, message και data. Το περιεχόμενο του data περιγράφεται στα σχήματα παρακάτω.

Σχήματα δεδομένων απάντησης: User, UserProfileResponse. Τα πεδία και οι τύποι βρίσκονται στις σελίδες «Σχήματα δεδομένων».

Σχήμα απάντησης, ενδεικτικές τιμές
{
  "code": 0,
  "message": "success",
  "data": {
    "id": "PLACEHOLDER_ID (integer)",
    "email": "PLACEHOLDER_EMAIL (string)",
    "username": "PLACEHOLDER_USERNAME (string)",
    "role": "PLACEHOLDER_ROLE (string)",
    "balance": "PLACEHOLDER_BALANCE (number)",
    "frozen_balance": "PLACEHOLDER_FROZEN_BALANCE (number)",
    "concurrency": "PLACEHOLDER_CONCURRENCY (integer)",
    "status": "PLACEHOLDER_STATUS (string)",
    "last_active_at": "PLACEHOLDER_LAST_ACTIVE_AT (string)",
    "created_at": "PLACEHOLDER_CREATED_AT (string)",
    "updated_at": "PLACEHOLDER_UPDATED_AT (string)",
    "deleted_at": "PLACEHOLDER_DELETED_AT (string)",
    "balance_notify_enabled": "PLACEHOLDER_BALANCE_NOTIFY_ENABLED (boolean)",
    "balance_notify_threshold_type": "PLACEHOLDER_BALANCE_NOTIFY_THRESHOLD_TYPE (string)",
    "balance_notify_threshold": "PLACEHOLDER_BALANCE_NOTIFY_THRESHOLD (number)",
    "balance_notify_extra_emails": "PLACEHOLDER_BALANCE_NOTIFY_EXTRA_EMAILS (array)",
    "total_recharged": "PLACEHOLDER_TOTAL_RECHARGED (number)",
    "rpm_limit": "PLACEHOLDER_RPM_LIMIT (integer)",
    "api_keys": "PLACEHOLDER_API_KEYS (array)",
    "avatar_url": "PLACEHOLDER_AVATAR_URL (string)",
    "email_bound": "PLACEHOLDER_EMAIL_BOUND (boolean)"
  }
}

Ιδιαιτερότητες: Όλα τα προσωπικά δεδομένα και αντικείμενα περιορίζονται στο υποκείμενο του JWT.

Ιδιαιτερότητες: Η λειτουργία αλλάζει την κατάσταση ή συνεχίζει διαδικασία εξουσιοδότησης μίας χρήσης· το παράδειγμα περιγράφει τη σύμβαση και δεν εκτελείται.

Ιδιαιτερότητες: Τα όρια δαπανών των κλειδιών (quota, quota_used) επιστρέφονται στην απάντηση των κλειδιών και όχι στο προφίλ. Το frozen_balance είναι δεσμευμένο ποσό και δεν πρέπει να θεωρείται διαθέσιμο υπόλοιπο.

GET /api/v1/user/passkeys — Λίστα passkey

Πρόσβαση: Token πίνακα ελέγχου

GET/api/v1/user/passkeys
Ανάγνωση· το ID προέρχεται από την προηγούμενη απάντησή σας
curl --fail-with-body "https://ailoot.ai/api/v1/user/passkeys" \
  -H "Authorization: Bearer $TOKEN"

Δεν απαιτείται σώμα αιτήματος. Στείλτε τις παραπάνω παραμέτρους στο URL.

Απάντηση

Η απάντηση JSON περιέχει code, message και data. Το περιεχόμενο του data περιγράφεται στα σχήματα παρακάτω.

Σχήματα δεδομένων απάντησης: PasskeyCredentialSummary. Τα πεδία και οι τύποι βρίσκονται στις σελίδες «Σχήματα δεδομένων».

Σχήμα απάντησης, ενδεικτικές τιμές
{
  "code": 0,
  "message": "success",
  "data": {
    "id": "PLACEHOLDER_ID (integer)",
    "name": "PLACEHOLDER_NAME (string)",
    "created_at": "PLACEHOLDER_CREATED_AT (string)",
    "last_used_at": "PLACEHOLDER_LAST_USED_AT (string)",
    "backup": "PLACEHOLDER_BACKUP (boolean)"
  }
}

Ιδιαιτερότητες: Όλα τα προσωπικά δεδομένα και αντικείμενα περιορίζονται στο υποκείμενο του JWT.

Ιδιαιτερότητες: Το credential λαμβάνεται από το navigator.credentials· το session_token από το begin. Σώμα αιτήματος Finish <=65536 byte· η εγγραφή και η διαγραφή απαιτούν κωδικό πρόσβασης.

PUT /api/v1/user/password — Αλλαγή κωδικού πρόσβασης

Πρόσβαση: Token πίνακα ελέγχου

PUT/api/v1/user/password

Πεδία JSON / φόρμας

Το πεδίοΤύποςΥποχρεωτικόΈλεγχος / περιγραφή
old_passwordstringναιrequired
new_passwordstringναιrequired,min=6
Πρότυπο σώματος αιτήματος
{
  "old_password": "PLACEHOLDER_OLD_PASSWORD (string)",
  "new_password": "PLACEHOLDER_NEW_PASSWORD (string)"
}

Το PLACEHOLDER υποδηλώνει τη δική σας είσοδο και τον τύπο της. Αντικαταστήστε τις τιμές και κρατήστε μόνο τα προαιρετικά πεδία που χρειάζονται· οι συμβολοσειρές-δείκτες δεν αποστέλλονται αντί για αριθμούς, boolean, αντικείμενα ή πίνακες.

Σχήμα αιτήματος: ChangePasswordRequest

Απάντηση

Η απάντηση JSON περιέχει code, message και data. Το περιεχόμενο του data περιγράφεται στα σχήματα παρακάτω.

Σχήμα απάντησης, ενδεικτικές τιμές
{
  "code": 0,
  "message": "success",
  "data": {
    "message": "VALUE_FROM_RESPONSE"
  }
}

Ιδιαιτερότητες: Όλα τα προσωπικά δεδομένα και αντικείμενα περιορίζονται στο υποκείμενο του JWT.

Ιδιαιτερότητες: Η λειτουργία αλλάζει την κατάσταση ή συνεχίζει διαδικασία εξουσιοδότησης μίας χρήσης· το παράδειγμα περιγράφει τη σύμβαση και δεν εκτελείται.

GET /api/v1/user/profile — Προφίλ, υπόλοιπο και συνδέσεις λογαριασμού

Πρόσβαση: Token πίνακα ελέγχου

GET/api/v1/user/profile
Ανάγνωση· το ID προέρχεται από την προηγούμενη απάντησή σας
curl --fail-with-body "https://ailoot.ai/api/v1/user/profile" \
  -H "Authorization: Bearer $TOKEN"

Δεν απαιτείται σώμα αιτήματος. Στείλτε τις παραπάνω παραμέτρους στο URL.

Απάντηση

Η απάντηση JSON περιέχει code, message και data. Το περιεχόμενο του data περιγράφεται στα σχήματα παρακάτω.

Σχήματα δεδομένων απάντησης: User, UserProfileResponse. Τα πεδία και οι τύποι βρίσκονται στις σελίδες «Σχήματα δεδομένων».

Σχήμα απάντησης, ενδεικτικές τιμές
{
  "code": 0,
  "message": "success",
  "data": {
    "id": "PLACEHOLDER_ID (integer)",
    "email": "PLACEHOLDER_EMAIL (string)",
    "username": "PLACEHOLDER_USERNAME (string)",
    "role": "PLACEHOLDER_ROLE (string)",
    "balance": "PLACEHOLDER_BALANCE (number)",
    "frozen_balance": "PLACEHOLDER_FROZEN_BALANCE (number)",
    "concurrency": "PLACEHOLDER_CONCURRENCY (integer)",
    "status": "PLACEHOLDER_STATUS (string)",
    "last_active_at": "PLACEHOLDER_LAST_ACTIVE_AT (string)",
    "created_at": "PLACEHOLDER_CREATED_AT (string)",
    "updated_at": "PLACEHOLDER_UPDATED_AT (string)",
    "deleted_at": "PLACEHOLDER_DELETED_AT (string)",
    "balance_notify_enabled": "PLACEHOLDER_BALANCE_NOTIFY_ENABLED (boolean)",
    "balance_notify_threshold_type": "PLACEHOLDER_BALANCE_NOTIFY_THRESHOLD_TYPE (string)",
    "balance_notify_threshold": "PLACEHOLDER_BALANCE_NOTIFY_THRESHOLD (number)",
    "balance_notify_extra_emails": "PLACEHOLDER_BALANCE_NOTIFY_EXTRA_EMAILS (array)",
    "total_recharged": "PLACEHOLDER_TOTAL_RECHARGED (number)",
    "rpm_limit": "PLACEHOLDER_RPM_LIMIT (integer)",
    "api_keys": "PLACEHOLDER_API_KEYS (array)",
    "avatar_url": "PLACEHOLDER_AVATAR_URL (string)",
    "email_bound": "PLACEHOLDER_EMAIL_BOUND (boolean)"
  }
}

Ιδιαιτερότητες: Όλα τα προσωπικά δεδομένα και αντικείμενα περιορίζονται στο υποκείμενο του JWT.

Ιδιαιτερότητες: Τα όρια δαπανών των κλειδιών (quota, quota_used) επιστρέφονται στην απάντηση των κλειδιών και όχι στο προφίλ. Το frozen_balance είναι δεσμευμένο ποσό και δεν πρέπει να θεωρείται διαθέσιμο υπόλοιπο.

GET /api/v1/user/totp/status — Κατάσταση 2FA (TOTP)

Πρόσβαση: Token πίνακα ελέγχου

GET/api/v1/user/totp/status
Ανάγνωση· το ID προέρχεται από την προηγούμενη απάντησή σας
curl --fail-with-body "https://ailoot.ai/api/v1/user/totp/status" \
  -H "Authorization: Bearer $TOKEN"

Δεν απαιτείται σώμα αιτήματος. Στείλτε τις παραπάνω παραμέτρους στο URL.

Απάντηση

Η απάντηση JSON περιέχει code, message και data. Το περιεχόμενο του data περιγράφεται στα σχήματα παρακάτω.

Σχήματα δεδομένων απάντησης: TotpStatusResponse. Τα πεδία και οι τύποι βρίσκονται στις σελίδες «Σχήματα δεδομένων».

Σχήμα απάντησης, ενδεικτικές τιμές
{
  "code": 0,
  "message": "success",
  "data": {
    "enabled": "PLACEHOLDER_ENABLED (boolean)",
    "enabled_at": "PLACEHOLDER_ENABLED_AT (integer)",
    "feature_enabled": "PLACEHOLDER_FEATURE_ENABLED (boolean)"
  }
}

Ιδιαιτερότητες: Όλα τα προσωπικά δεδομένα και αντικείμενα περιορίζονται στο υποκείμενο του JWT.

Ιδιαιτερότητες: Τα secret και setup_token είναι απόρρητα· η επαλήθευση εξαρτάται από τις ρυθμίσεις TOTP και του χρήστη.

GET /api/v1/user/totp/verification-method — Μέθοδος επαλήθευσης TOTP

Πρόσβαση: Token πίνακα ελέγχου

GET/api/v1/user/totp/verification-method
Ανάγνωση· το ID προέρχεται από την προηγούμενη απάντησή σας
curl --fail-with-body "https://ailoot.ai/api/v1/user/totp/verification-method" \
  -H "Authorization: Bearer $TOKEN"

Δεν απαιτείται σώμα αιτήματος. Στείλτε τις παραπάνω παραμέτρους στο URL.

Απάντηση

Η απάντηση JSON περιέχει code, message και data. Το περιεχόμενο του data περιγράφεται στα σχήματα παρακάτω.

Σχήμα απάντησης, ενδεικτικές τιμές
{
  "code": 0,
  "message": "success",
  "data": {
    "method": "email"
  }
}

Ιδιαιτερότητες: Όλα τα προσωπικά δεδομένα και αντικείμενα περιορίζονται στο υποκείμενο του JWT.

Ιδιαιτερότητες: Τα secret και setup_token είναι απόρρητα· η επαλήθευση εξαρτάται από τις ρυθμίσεις TOTP και του χρήστη.

TotpVerificationMethod

{
  "type": "object",
  "required": [
    "method"
  ],
  "properties": {
    "method": {
      "type": "string",
      "enum": [
        "email",
        "password"
      ]
    }
  }
}
Έχετε ερωτήσεις; Στείλτε μας το Request ID και μια περιγραφή — θα σας βοηθήσουμε να βρείτε την αιτία.Επικοινωνία με την υποστήριξη