Πύλη Προγραμματιστή
Η Πύλη Προγραμματιστών Legalesign είναι όπου μπορείτε να διαχειριστείτε την πρόσβασή σας στο API και να εποπτεύετε τον οργανισμό σας.
Χρησιμοποιήστε την για να δημιουργήσετε και να ανακαλέσετε κλειδιά API, να αντιγράψετε τους αναγνωριστικούς που χρειάζεται η ενσωμάτωσή σας, να διαχειριστείτε τα webhook endpoints, να επανεξετάσετε πρόσφατες παραδόσεις webhook και να ελέγξετε τη χρήση του API για τον οργανισμό σας.
Η πύλη αντικαθιστά τον παλαιότερο πίνακα ελέγχου API για νέες ροές εργασίας διαχείρισης κλειδιών API. Τα υπάρχοντα παλαιά REST API κλειδιά συνεχίζουν να λειτουργούν για υπάρχουσες ενσωματώσεις, αλλά οι νέες ενσωματώσεις θα πρέπει να χρησιμοποιούν την πύλη και τη νέα μορφή κλειδιού API.
Πρόσβαση
Μεταβείτε στο developer.legalesign.com. Συνδεθείτε με το λογαριασμό σας στο Legalesign. Μπορεί να συνδεθείτε αυτόματα αν έχετε ενεργή συνεδρία στην εφαρμογή ιστού.
Ο λογαριασμός σας πρέπει να είναι εγκεκριμένος για ανάπτυξη API. Εάν η πύλη αναφέρει ότι η διαχείριση κλειδιών API δεν είναι ενεργοποιημένη για τον χρήστη σας, δημιουργήστε ένα αίτημα υποστήριξης και ζητήστε επιβεβαίωση πρόσβασης API.
Κλειδιά API
Η ενότητα Κλειδιά API σας επιτρέπει να δημιουργήσετε και να ανακαλέσετε κλειδιά API για έναν οργανισμό.
Όταν δημιουργείτε ένα κλειδί, επιλέξτε:
- Ένα όνομα κλειδιού, συνήθως την ενσωμάτωση ή το περιβάλλον που θα το χρησιμοποιήσει.
- Το API interface: REST, GraphQL, ή και τα δύο.
- Προαιρετική περίοδο λήξης.
Το απλό κείμενο του κλειδιού API εμφανίζεται μία φορά, αμέσως μετά τη δημιουργία. Αντιγράψτε το πριν φύγετε από τη σελίδα γιατί δεν μπορεί να εμφανιστεί ξανά.
Τα νέα κλειδιά χρησιμοποιούν τη μορφή κλειδιού API για επιχειρήσεις και αποστέλλονται ως bearer token:
Authorization: Bearer ak_<environment>_<key-id>.<secret>
Τα παλαιά REST κλειδιά εμφανίζονται ξεχωριστά όταν υπάρχουν. Υποστηρίζονται μόνο για υπάρχουσες REST ενσωματώσεις. Μεταφέρετε νέες ενσωματώσεις στα νέα κλειδιά API και ανακαλέστε τα παλαιά κλειδιά όταν δεν χρησιμοποιούνται πλέον.
Περιβάλλον
Η ενότητα Περιβάλλον δείχνει τους αναγνωριστικούς οργανισμού και ομάδας που είναι διαθέσιμοι για το λογαριασμό σας.
Χρησιμοποιήστε αυτή την ενότητα όταν ένα αίτημα API χρειάζεται συμφραζόμενα οργανισμού ή ομάδας. Συγκεκριμένα, τα REST API αιτήματα που δρουν εντός οργανισμού πρέπει να περιλαμβάνουν την κεφαλίδα οργανισμού:
X-Organisation: <organisation-id>
Η πύλη εμφανίζει τους αναγνωριστικούς GraphQL και REST δίπλα-δίπλα όπου και οι δύο είναι διαθέσιμοι.
Εάν ο χρήστης του REST API είναι σε sandbox mode, η ενότητα Περιβάλλον δείχνει επίσης τις εγκεκριμένες διευθύνσεις email παραληπτών sandbox. Το sandbox mode περιορίζει τις αποστολές REST εγγράφων σε αυτές τις διευθύνσεις.
Webhooks
Η ενότητα Webhooks σας επιτρέπει να δημιουργήσετε, επεξεργαστείτε, απενεργοποιήσετε και διαγράψετε τα webhook endpoints.
Για κάθε webhook, επιλέξτε:
- Το URL του endpoint.
- Τον τύπο συμβάντος.
- Το πεδίο ομάδας, ή όλες τις ομάδες.
- Εάν το webhook είναι ενεργοποιημένο.
Η πύλη επίσης δείχνει πρόσφατες προσπάθειες παράδοσης webhook. Χρησιμοποιήστε την προβολή καταγραφής για να ελέγξετε τα περιεχόμενα των συμβάντων, την κατάσταση παράδοσης και πρόσφατες αποτυχίες.
Για τη διευκόλυνση της ανάπτυξης webhook, μπορείτε επίσης να στείλετε χειροκίνητα γεγονότα webhook σε αυτή τη σελίδα.
Για αυτόματη ρύθμιση, η διαχείριση του webhook configuration μπορεί να γίνει επίσης μέσω του API. Δείτε τον οδηγό webhooks για λεπτομέρειες ενσωμάτωσης.
Χρήση
Η ενότητα Χρήση συνοψίζει τη πρόσφατη δραστηριότητα API για τον επιλεγμένο οργανισμό.
Χρησιμοποιήστε την για να ελέγξετε:
- Τον συνολικό όγκο αιτημάτων.
- Ποια κλειδιά χρησιμοποιήθηκαν.
- Κορυφαίες λειτουργίες.
- Μετρήσεις εξουσιοδοτημένων και απορριφθέντων αιτημάτων.
- Δραστηριότητα αιτημάτων με την πάροδο του χρόνου.
Αυτός είναι ο πρώτος χώρος ελέγχου μετά τη δημιουργία ενός κλειδιού και την αποστολή δοκιμαστικού αιτήματος. Βοηθά να επιβεβαιώσετε ότι το κλειδί χρησιμοποιείται και εάν τα αιτήματα γίνονται αποδεκτά ή απορρίπτονται.
Διαχείριση Οργανισμού
Οι διαχειριστές οργανισμού μπορούν να δουν μια ευρύτερη εικόνα διαχείρισης για τον οργανισμό τους.
Ανάλογα με τα δικαιώματά σας, αυτή η ενότητα μπορεί να περιλαμβάνει:
- Κλειδιά API σε επίπεδο οργανισμού.
- Ενεργά και ανακληθέντα κλειδιά.
- Χρήση των κλειδιών οργανισμού.
- Δραστηριότητες ελέγχου για τα κλειδιά API.
- Webhooks οργανισμού.
Χρησιμοποιήστε αυτήν την προβολή για να ελέγξετε την πρόσβαση, να ανακαλέσετε κλειδιά που ανήκουν σε χρήστες του οργανισμού και να επιθεωρήσετε τις πρόσφατες αλλαγές κύκλου ζωής των κλειδιών API.
