Μετάβαση στο περιεχόμενο
Επαληθεύτηκε

Ταυτοποίηση

Κλειδιά API λογαριασμού, πλήρης έναντι προσαρμοσμένης πρόσβασης, και πού δημιουργείται ένα.

Κάθε κλήση προς το CPI φέρει ένα κλειδί API. Δεν υπάρχει ξεχωριστό αναγνωριστικό πελάτη, καμία χειραψία OAuth, καμία υπογραφή προς υπολογισμό, ένα κλειδί, που αποστέλλεται με το αίτημα.

Δημιουργία ενός κλειδιού

Τα κλειδιά βρίσκονται στον πίνακα ελέγχου, στην οθόνη Προγραμματιστές του μενού λογαριασμού, στην καρτέλα Κλειδιά API. Ένα project έχει τη δική του καρτέλα API που δημιουργεί το ίδιο είδος κλειδιού ήδη περιορισμένο σε εκείνο το project, ώστε να μην πληκτρολογείτε ποτέ ένα app_id με το χέρι. Το sandbox της διαδραστικής αναφοράς API μπορεί επίσης να δημιουργήσει ένα για εσάς επιτόπου, ώστε να δοκιμάσετε μια μέθοδο πριν συνδέσετε οτιδήποτε στον δικό σας κώδικα.

Επαλήθευση ταυτότητας

Η δημιουργία κλειδιού API απαιτεί επαλήθευση ταυτότητας, τον ίδιο έλεγχο επιπέδου 2 που ζητά το Xuda πριν δώσει έναν αριθμό τηλεφώνου, ένα γραμματοκιβώτιο ή μια φορητή IP. Ένας λογαριασμός χωρίς τίποτα επαληθευμένο βλέπει μια προτροπή επαλήθευσης πριν ανοίξει η φόρμα κλειδιού.

Εύρος: ως ποιος λογαριασμός ενεργεί το κλειδί

Ένα κλειδί δημιουργείται με ένα από τρία εύρη, και ενεργεί πάντα στον λογαριασμό ή την εφαρμογή για την οποία δημιουργήθηκε:

  • Λογαριασμός: ενεργεί απευθείας στον λογαριασμό σας, όπως θα κάνατε από μια συνδεδεμένη συνεδρία πίνακα ελέγχου. Φτάνει σε κάθε μέθοδο που μπορεί να φτάσει ένα απλό κλειδί λογαριασμού.
  • Εφαρμογή: δημιουργείται από τη δική καρτέλα API ενός project, καρφωμένο στο app_id του project.
  • Full Stack VPS: εκδίδεται αυτόματα όταν προετοιμάζετε ένα Full Stack VPS, με εύρος τις ομάδες δυνατοτήτων που επιλέχθηκαν κατά τη δημιουργία. Δείτε το Full Stack VPS για το τι καλύπτει αυτό.

Πρόσβαση: πλήρης ή προσαρμοσμένη

Κάθε κλειδί επιλέγει επίσης πόσο από τη δημόσια επιφάνεια μπορεί να φτάσει:

  • Πλήρης πρόσβαση: ό,τι μπορεί να κάνει ο λογαριασμός μέσω του API, συμπεριλαμβανομένων των μεθόδων που προστέθηκαν μετά τη δημιουργία του κλειδιού. Οι ιδιωτικές μέθοδοι μένουν πάντα εκτός: το private: true είναι σκληρό τείχος, που ελέγχεται σε κάθε κλήση, όχι προεπιλογή που την παρακάμπτει η πλήρης πρόσβαση.
  • Προσαρμοσμένη πρόσβαση: μια ρητή λίστα επιτρεπόμενων που φτιάχνετε επιλέγοντας μεθόδους στη φόρμα κλειδιού, ομαδοποιημένες ανά microservice με τα πεδία κάθε μεθόδου εμφανισμένα ενσωματωμένα. Μια μέθοδος που προστίθεται αργότερα δεν περιλαμβάνεται μέχρι να επιστρέψετε και να την επιτρέψετε. Μια μέθοδος με clearance public είναι πάντα προσβάσιμη, ακόμη και από προσαρμοσμένο κλειδί χωρίς καμία επιλογή, αφού μια δημόσια μέθοδος δεν χρειάζεται συνεδρία ούτε καταχώριση στη λίστα επιτρεπόμενων.
Οι μέθοδοι του api_module είναι μόνο για συνεδρίες

Οι μέθοδοι που δημιουργούν, ενημερώνουν και απαριθμούν κλειδιά API (create_account_api_key, get_app_api_keys, και οι υπόλοιπες του api_module) δεν είναι ποτέ προσβάσιμες με κλειδί API, εκ σχεδιασμού: ένα διαπιστευτήριο δεν μπορεί να δημιουργήσει ή να επεξεργαστεί διαπιστευτήρια για τον λογαριασμό που ταυτοποιεί. Διαχειριστείτε τα κλειδιά από τον πίνακα ελέγχου ή από μια συνδεδεμένη συνεδρία.

Αποστολή του κλειδιού

Μέσω απλού REST, το κλειδί είναι μία ακόμη παράμετρος αιτήματος, με όνομα api_key: πεδίο στο σώμα JSON στο POST, παράμετρος συμβολοσειράς ερωτήματος στο GET. Δείτε την Κλήση μιας μεθόδου και για τις δύο μορφές.

cURL
curl -s https://xuda.ai/cpi/get_account_projects \
  -H 'content-type: application/json' \
  -d '{"api_key":"YOUR_API_KEY"}'

Μέσω MCP το ίδιο κλειδί μπαίνει αντ' αυτού σε μια κεφαλίδα Authorization: Bearer, δεν υπάρχει πεδίο api_key. Δείτε το MCP.

claude mcp add
claude mcp add --transport http xuda https://xuda.ai/mcp \
  --header "Authorization: Bearer YOUR_API_KEY"
Κρατήστε το στον διακομιστή

Ένα κλειδί API είναι διαπιστευτήριο κομιστή: όποιος το κατέχει ενεργεί ως ο λογαριασμός σας. Μην το στέλνετε ποτέ σε κώδικα πλευράς πελάτη, μην το κάνετε commit και μην το επικολλάτε σε κοινόχρηστο στιγμιότυπο οθόνης. Αντικαταστήστε αμέσως ένα κλειδί αν εμφανιστεί ποτέ σε κάποιο από αυτά τα μέρη, η αντικατάσταση κρατά το όνομα και τη λειτουργία πρόσβασης και ανακαλεί την παλιά τιμή στο ίδιο βήμα.

Επόμενα