Κλειδιά API και το API

Ένα API key είναι ένας κωδικός πρόσβασης που ανήκει σε ένα πρόγραμμα αντί για ένα άτομο. Αντιμετωπίστε το με τον ίδιο τρόπο: εκδώστε ένα ανά σύστημα και αντικαταστήστε το όταν αλλάζει το σύστημα.

Δημιουργήστε ένα κλειδί

1. Ανοιχτό API → Διαχείριση API και πατήστε Νέο κλειδί.
2. Δώστε του ένα όνομα που δηλώνει ποιο σύστημα το χρησιμοποιεί.
3. Επιλέξτε το Δικαιώματα: Πλήρης πρόσβαση, ή μόνο τις περιοχές που χρειάζεται το σύστημα. Οι περισσότερες περιοχές διακρίνουν ανάγνωση, δημιουργία και αλλαγή.
4. Επιλέξτε ημερομηνία λήξης ή καμία.
5. Χρησιμοποιήστε Εμφάνιση και Αντιγραφή στην κάρτα κλειδιού για να παραδώσετε το κλειδί στο σύστημα κλήσης. Το σύστημα το στέλνει στο authtoken επικεφαλίδα.

Κάθε κάρτα κλειδί δείχνει τα δικαιώματα, την ημερομηνία δημιουργίας, Τελευταία χρήση και ένα σήμα όπως «ενεργό» ή «λήγει σε 5 ημέρες».

Ανανέωση κλειδιού πριν λήξει

Δεκατέσσερις ημέρες πριν λήξει ένα κλειδί, λαμβάνετε μία ειδοποίηση στο κουδούνι. Πατήστε Ανανέωση στην κάρτα κλειδιού και επιλέξτε τη νέα ημερομηνία λήξης. Το IDup δημιουργεί ένα νέο κλειδί με τις ίδιες άδειες. Αντιγράψτε το αμέσως, γιατί αυτή η οθόνη εμφανίζεται μόνο μία φορά. Το παλιό κλειδί παραμένει έγκυρο μέχρι τη δική του λήξη, ώστε να μπορείτε να αλλάξετε το σύστημα χωρίς κενό.

Οι περιοχές που μπορείτε να φτάσετε

Το API καλύπτει τα δεδομένα των πελατών σας και, ανάλογα με το πρόγραμμά σας, ακίνητα και ενοικιάσεις, προφίλ αναζήτησης, φορολογικά αρχεία, αρχεία εμπιστευτικών, λογιστική, εκτελέσεις μισθοδοσίας και σάρωση αποδείξεων. Το AI Studio και το γραμματοκιβώτιο έχουν τις δικές τους περιοχές. Ο οδηγός API παραθέτει μόνο τις περιοχές που περιλαμβάνει το πρόγραμμά σας.

Ο οδηγός API

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

Webhooks και άλλες διεπαφές

• Το Webhooks καρτέλα στέλνει γεγονότα στο σύστημά σας καθώς συμβαίνουν — δείτε Αποστολή γεγονότων στο δικό σας σύστημα με webhooks.
• Εάν το Customer API είναι ενεργοποιημένο, ένας Ρυθμίσεις API πελατών καρτέλα ανοίγει τις ρυθμίσεις της, για παράδειγμα αν οι πελάτες μπορούν να εγγραφούν μέσω του API.
• Αυτοματοποίηση / Ροές εργασίας → Τεχνική διεπαφή εκδίδει ένα διακριτικό για τη διεπαφή GraphQL.
• AI Studio → Προσωπικά κλειδιά API είναι ένα ξεχωριστό σύνολο κλειδιών.

Διατηρώντας το ασφαλές

1. Ένα κλειδί ανά σύστημα, ποτέ κοινόχρηστο.
2. Δώστε σε ένα κλειδί μόνο τις άδειες που χρειάζεται το σύστημα.
3. Ορίστε μια ημερομηνία λήξης και ανανεώστε σύμφωνα με ένα πρόγραμμα.
4. Διαγράψτε ένα κλειδί μόλις κάποιος που το γνώριζε αποχωρήσει, ή το σύστημα απενεργοποιηθεί.