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