Το API ηλεκτρονικής υπογραφής Certyneo στο Postman
Εισάγετε τη δημόσια συλλογή Certyneo στο Postman και δοκιμάστε κάθε endpoint του REST API v1 — δημιουργία φακέλων, αποστολή, παρακολούθηση κατάστασης, webhooks — με παραδείγματα αιτημάτων που είναι ήδη συμπληρωμένα.
Δωρεάν και δημόσια συλλογή. Ένα κλειδί API Certyneo απαιτείται για την εκτέλεση των αιτημάτων.
Γιατί να χρησιμοποιήσετε τη συλλογή Postman Certyneo
Η συλλογή είναι σχεδιασμένη για τους προγραμματιστές που θέλουν να εξερευνήσουν το API Certyneo χωρίς να διαβάσουν όλη την τεκμηρίωση πριν ξεκινήσουν το πρώτο τους αίτημα.
Αιτήματα έτοιμα για χρήση
Κάθε endpoint του REST API v1 τεκμηριώνεται με ένα παράδειγμα αιτήματος και απόκρισης, έτοιμο προς εκτέλεση αφού συμπληρώσετε το κλειδί API σας.
Περιβάλλοντα δοκιμής
Μια μεταβλητή περιβάλλοντος Postman περιέχει το κλειδί API σας και τη βασική διεύθυνση URL, για να εναλλάσσεστε εύκολα μεταξύ των λογαριασμών ή των περιβαλλόντων σας.
Αυτόματα δημιουργημένη τεκμηρίωση
Η τεκμηρίωση Postman της συλλογής παραμένει συγχρονισμένη με τις προδιαγραφές OpenAPI του API Certyneo — χωρίς ασυμφωνία μεταξύ αυτού που δοκιμάζετε και αυτού που βρίσκεται σε παραγωγή.
Δοκιμή χωρίς να γράψετε κώδικα
Δημιουργήστε έναν φάκελο, στείλτε τον και παρακολουθήστε την κατάστασή του απευθείας από τη διεπαφή Postman, ακόμη και πριν ενσωματώσετε το API στην εφαρμογή σας.
Τι καλύπτει η συλλογή
Μια επισκόπηση των ομάδων endpoints που είναι διαθέσιμες στη δημόσια συλλογή.
| Ομάδα | Τι περιέχει |
|---|---|
| Φάκελοι | Δημιουργήστε, στείλτε, καταγράψτε, συμβουλευτείτε και ακυρώστε έναν φάκελο υπογραφής. |
| Έγγραφα | Ανεβάστε ένα έγγραφο ή εισάγετέ το από μια διεύθυνση URL (sourceUrl), συμβουλευτείτε την κατάστασή του. |
| Υπογράφοντες | Προσθέστε αποδέκτες, ορίστε τη σειρά υπογραφής τους και το επίπεδό τους (SES/AES). |
| Webhooks | Δημιουργήστε και διαχειριστείτε τις συνδρομές σε γεγονότα υπογραφής. |
| Μαζική αποστολή | Στείλτε πολλούς φακέλους σε ένα μόνο αίτημα για εκστρατείες υπογραφής μεγάλου όγκου. |
Η συλλογή είναι δημόσια για ανάγνωση: μπορείτε να την συμβουλευτείτε χωρίς λογαριασμό, αλλά η εκτέλεση των ερωτημάτων απαιτεί ένα έγκυρο κλειδί API Certyneo.
Ξεκινήστε με τη συλλογή σε 4 βήματα
Χρειάζεστε λιγότερο από 5 λεπτά για να κάνετε το πρώτο ερώτημά σας.
- 1
Εισαγάγετε τη δημόσια συλλογή
Από το Postman, ανοίξτε τη δημόσια συλλογή Certyneo και κάντε κλικ στο « Fork » ή « Import » για να την αντιγράψετε στον δικό σας χώρο.
- 2
Δημιουργήστε ένα κλειδί API Certyneo
Στο ταμπλό ελέγχου Certyneo, ανοίξτε Ρυθμίσεις → Κλειδιά API και δημιουργήστε ένα κλειδί αποκλειστικά για το Postman.
- 3
Συμπληρώστε τη μεταβλητή περιβάλλοντος
Επικολλήστε το κλειδί API σας στη μεταβλητή περιβάλλοντος της συλλογής Postman, καθώς και στη βασική διεύθυνση URL του API.
- 4
Στείλτε ένα πρώτο ερώτημα
Εκτελέστε το ερώτημα « Δημιουργία φακέλου » και παρακολουθήστε το αποτέλεσμα απευθείας στο Postman.
Ασφάλεια και καλές πρακτικές
Τα ερωτήματα της συλλογής διέρχονται από το ίδιο API με την εφαρμογή σας στην παραγωγή: ισχύουν οι ίδιοι κανόνες ασφάλειας.
- Όλα τα ερωτήματα μεταδίδονται μέσω HTTPS/TLS 1.2 ή νεότερης έκδοσης.
- Κάθε κλειδί API περιορίζεται στα δικαιώματα που του παρέχετε κατά τη δημιουργία του.
- Χρησιμοποιήστε ένα αποκλειστικό κλειδί δοκιμής για τις δοκιμές Postman, διαφορετικό από το κλειδί παραγωγής σας.
- Ένα κλειδί API που έχει διακυβευθεί ή δεν χρησιμοποιείται μπορεί να ανακληθεί με ένα κλικ από το ταμπλό ελέγχου Certyneo.
Επικαιρότερα ερωτήματα
Είναι απαραίτητο ένα πληρωμένο πακέτο για τη χρήση της συλλογής Postman;
Όχι. Η συλλογή είναι δημόσια και δωρεάν. Τα όρια του σχεδίου Certyneo (αριθμός φακέλων, λειτουργίες) ισχύουν για τα εκτελούμενα αιτήματα, όπως για κάθε χρήση του API.
Πού μπορώ να βρω το κλειδί API μου;
Στον πίνακα ελέγχου Certyneo, στις Ρυθμίσεις → Κλειδιά API. Δημιουργήστε ένα αποκλειστικό κλειδί για τις δοκιμές Postman.
Είναι η συλλογή ενημερωμένη με την τελευταία έκδοση του API;
Ναι, η συλλογή αναδημιουργείται από την επίσημη προδιαγραφή OpenAPI του Certyneo API σε κάθε εξέλιξη του REST API v1.
Μπορώ να δοκιμάσω τα webhooks από το Postman;
Ναι, η συλλογή περιέχει τα endpoints για τη δημιουργία και την αναφορά των συνδρομών webhooks. Για να λάβετε τα γεγονότα τοπικά, χρησιμοποιήστε μια υπηρεσία σήραγγας HTTP κατά τη διάρκεια των δοκιμών.
Έχει κόστος η χρήση της συλλογής Postman;
Όχι, μόνο η κατανάλωση του ίδιου του API (δημιουργία φακέλων) αφαιρείται από το σχέδιό σας, ακριβώς όπως μια κλασική κλήση API.
Για να πάμε πιο πέρα
Δοκιμάστε το Certyneo API στο Postman
Δημόσια συλλογή, δωρεάν, συγχρονισμένη με την τεκμηρίωση των προγραμματιστών μας.