Mετάβαση στο κύριο περιεχόμενο

API προγραμματιστών και webhooks

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

Συντάχθηκε από: Sarah Chen

Το Κέντρο προγραμματιστών είναι το σημείο όπου συνδέετε το Exayard με τον δικό σας κώδικα και τα εργαλεία σας. Ανοίξτε το από τις Ρυθμίσεις και μετά Προγραμματιστής. Από εδώ δημιουργείτε κλειδιά API, καταχωρίζετε σημεία webhook και ελέγχετε ένα ζωντανό αρχείο καταγραφής κάθε αιτήματος API. Μόνο οι διαχειριστές του οργανισμού μπορούν να φτάσουν σε αυτή τη σελίδα.

Κλειδιά API

Ένα κλειδί API πραγματοποιεί έλεγχο ταυτότητας για αιτήματα προς το API του Exayard. Τα κλειδιά ανήκουν στον οργανισμό σας, οπότε ο σωστός λογαριασμός επιλέγεται αυτόματα και δεν χρειάζεται να περάσετε αναγνωριστικό οργανισμού.

Ανοίξτε την καρτέλα Κλειδιά API στην κάρτα Διαπιστευτήρια και κάντε κλικ στο κουμπί +. Δώστε στο κλειδί ένα Όνομα, και έπειτα επιλέξτε τα Πεδία εφαρμογής του. Επιλέξτε Όλα για να εκχωρήσετε κάθε πεδίο εφαρμογής ή Συγκεκριμένα για να επιλέξετε μεμονωμένα δικαιώματα. Τα πεδία εφαρμογής ακολουθούν έναν διαχωρισμό ανάγνωσης και εγγραφής ανά πόρο, όπως read:projects και write:estimates. Το πεδίο εφαρμογής admin:org είναι μια εκχώρηση πλήρους πρόσβασης. Επιλέξτε τα ελάχιστα πεδία εφαρμογής που χρειάζεται η ενσωμάτωσή σας.

Το Exayard εμφανίζει το πλήρες κλειδί μία φορά, αμέσως μετά τη δημιουργία του. Αντιγράψτε το τότε, επειδή δεν εμφανίζεται ποτέ ξανά. Στη συνέχεια, κάθε κλειδί εμφανίζεται με το όνομά του, μια μασκαρισμένη προεπισκόπηση όπως ak_••••1234, και την ημερομηνία της τελευταίας του χρήσης.

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

Το ίδιο κλειδί πραγματοποιεί έλεγχο ταυτότητας για τις ενσωματώσεις χωρίς κώδικα. Δείτε τη Σύνδεση του Exayard με το Zapier, τη Σύνδεση του Exayard με το Make και τη Σύνδεση του Exayard με το n8n. Για πρόσβαση πρακτόρων και επεξεργαστών AI, δείτε τη Σύνδεση με το Claude και άλλα εργαλεία AI.

Webhooks

Ένα webhook λέει στο Exayard να ειδοποιήσει τον διακομιστή σας όταν συμβαίνει κάτι. Ανοίξτε την καρτέλα Webhooks και κάντε κλικ στο + για να προσθέσετε ένα σημείο. Καταχωρίστε τη διεύθυνση URL που θα λαμβάνει τις παραδόσεις και μια προαιρετική Περιγραφή.

Επιλέξτε σε ποια Συμβάντα θα εγγραφείτε. Επιλέξτε Όλα για να λαμβάνετε κάθε συμβάν ή Συγκεκριμένα για να επιλέξετε από τη λίστα:

Συμβάν

Ενεργοποιείται όταν

project.created

Δημιουργείται ένα έργο

project.updated

Αλλάζει ένα έργο

project.archived

Αρχειοθετείται ένα έργο

assessment.started

Ξεκινά μια αξιολόγηση επιμέτρησης

assessment.completed

Ολοκληρώνεται μια αξιολόγηση

assessment.approved

Εγκρίνεται μια αξιολόγηση

assessment.cancelled

Ακυρώνεται μια αξιολόγηση

estimate.generated

Δημιουργείται ένας προϋπολογισμός

bid.generated

Δημιουργείται μια προσφορά

file.processed

Ολοκληρώνεται η επεξεργασία ενός μεταφορτωμένου αρχείου

Όταν δημιουργείτε ένα σημείο, το Exayard εμφανίζει μία φορά ένα μυστικό υπογραφής. Αντιγράψτε το τότε, επειδή δεν εμφανίζεται ξανά.

Ασφάλιση των παραδόσεων webhook

Κάθε παράδοση φέρει μια κεφαλίδα Exayard-Signature στη μορφή t=<unix>,v1=<digest>. Το Exayard δημιουργεί την υπογραφή ενώνοντας τη χρονοσφραγίδα και το σώμα του αιτήματος, και έπειτα υπογράφοντάς τα με HMAC-SHA256 χρησιμοποιώντας το μυστικό του σημείου σας.

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

Για να επεξεργαστείτε ένα σημείο, κάντε κλικ στο εικονίδιο μολυβιού. Μπορείτε να αλλάξετε τη διεύθυνση URL, την περιγραφή και τα συμβάντα, και να ορίσετε την Κατάστασή του σε Ενεργό ή Σε παύση. Τα σημεία σε παύση σταματούν να λαμβάνουν παραδόσεις. Ο ίδιος διάλογος έχει ένα κουμπί Εναλλαγή μυστικού. Η εναλλαγή εκδίδει ένα νέο μυστικό και το παλιό σταματά να λειτουργεί αμέσως, οπότε ενημερώστε τον διακομιστή σας πριν κάνετε εναλλαγή. Το εικονίδιο κάδου διαγράφει ένα σημείο και τερματίζει όλες τις παραδόσεις προς αυτό.

Γρήγορη εκκίνηση

Η κάρτα Γρήγορη εκκίνηση περιέχει μια έτοιμη προτροπή για έναν επεξεργαστή AI όπως το Claude ή το Cursor. Κάντε κλικ στο Αντιγραφή προτροπής και επικολλήστε την στον επεξεργαστή σας. Η προτροπή περιλαμβάνει τη βασική διεύθυνση URL του API, τη μορφή ελέγχου ταυτότητας, το λεξιλόγιο πεδίων εφαρμογής και το σχήμα υπογραφής webhook, ώστε η τεχνητή νοημοσύνη να μπορεί να στήσει μια λειτουργική ενσωμάτωση και να σας ζητήσει τις λεπτομέρειες που χρειάζεται.

Τεκμηρίωση

Η κάρτα Τεκμηρίωση συνδέει στην πλήρη τεκμηρίωση προγραμματιστών και στην προδιαγραφή OpenAPI, η οποία περιγράφει κάθε διαδρομή και σχήμα. Το Σύνδεση MCP ανοίγει τη ρύθμιση για τη σύνδεση πρακτόρων AI απευθείας με το Exayard.

Αρχεία καταγραφής

Η ενότητα Αρχεία καταγραφής καταγράφει τα πιο πρόσφατα αιτήματα API σας τόσο στο REST API όσο και στο MCP. Κάθε γραμμή δείχνει τη μέθοδο, τη διαδρομή, την κατάσταση απόκρισης και την καθυστέρηση. Επιλέξτε μια γραμμή για να δείτε την πλήρη λεπτομέρειά της, συμπεριλαμβανομένου του αναγνωριστικού αιτήματος και των σωμάτων αιτήματος και απόκρισης. Χρησιμοποιήστε τα αρχεία καταγραφής για να επιβεβαιώσετε ότι μια κλήση λειτούργησε ή για να αποσφαλματώσετε μια ενσωμάτωση που αποτυγχάνει.

Απαντήθηκε η ερώτησή σας;