API-ul de semnătură electronică Certyneo în Postman
Importați colecția publică Certyneo în Postman și testați fiecare punct final al API REST v1 — crearea plicurilor, trimiterea, urmărirea stării, webhooks — cu exemple de cereri deja completate.
Colecție gratuită și publică. O cheie API Certyneo este necesară pentru a executa cererile.
De ce să utilizați colecția Postman Certyneo
Colecția este concepută pentru dezvoltatorii care doresc să exploreze API-ul Certyneo fără a citi întreaga documentație înainte de a-și lansa prima cerere.
Cereri gata de utilizare
Fiecare endpoint al API REST v1 este documentat cu un exemplu de cerere și răspuns, gata de executat după ce ați completat cheia API.
Medii de testare
O variabilă de mediu Postman conține cheia API și URL-ul de bază, pentru a comuta ușor între conturi sau medii.
Documentație generată automat
Documentația Postman a colecției rămâne sincronizată cu specificația OpenAPI a API-ului Certyneo — fără decalaj între ceea ce testați și ceea ce este în producție.
Testare fără a scrie cod
Creați o învelitoare, trimiteți-o și urmăriți starea acesteia direct din interfața Postman, înainte chiar de a integra API-ul în aplicația dumneavoastră.
Ce acoperă colecția
O prezentare generală a grupurilor de endpoint-uri disponibile în colecția publică.
| Grup | Ce conține |
|---|---|
| Învelitoare | Creați, trimiteți, enumerați, consultați și anulați o învelitoare de semnare. |
| Documente | Încărcați un document sau importați-l dintr-o adresă URL (sourceUrl), consultați starea acestuia. |
| Semnatari | Adăugați destinatari, definiți ordinea semnării și nivelul acestora (SES/AES). |
| Webhooks | Creați și gestionați abonamentele la evenimente de semnare. |
| Trimitere în masă | Trimiteți mai multe plicuri într-o singură cerere pentru campaniile de semnare în volum mare. |
Colecția este publică în citire: o puteți consulta fără cont, dar executarea cererilor necesită o cheie API Certyneo valabilă.
Începeți cu colecția în 4 etape
Sunt necesare mai puțin de 5 minute pentru a lansa prima dumneavoastră cerere.
- 1
Importați colecția publică
Din Postman, deschideți colecția publică Certyneo și faceți clic pe « Fork » sau « Import » pentru a o copia în propriul dvs. spațiu.
- 2
Generați o cheie API Certyneo
În tabloul de bord Certyneo, deschideți Setări → Chei API și creați o cheie dedicată Postman.
- 3
Completați variabila de mediu
Lipiți cheia API în variabila de mediu a colecției Postman, împreună cu URL-ul de bază al API-ului.
- 4
Trimiteți o primă cerere
Lansați cererea « Creați un plic » și urmăriți rezultatul direct în Postman.
Securitate și bune practici
Cererile din colecție trec prin același API ca aplicația dvs. în producție: se aplică aceleași reguli de securitate.
- Toate cererile tranzitează în HTTPS/TLS 1.2 minim.
- Fiecare cheie API este limitată la permisiunile pe care i le acordați la crearea sa.
- Utilizați o cheie de test dedicată pentru testele Postman, distinctă de cheia de producție.
- O cheie API compromisă sau neutilizată se revocă cu un singur clic din tabloul dumneavoastră de bord Certyneo.
Întrebări frecvente
Este necesar un plan plătit pentru a utiliza colecția Postman?
Nu. Colecția este publică și gratuită. Limitările planului dumneavoastră Certyneo (numărul de plicuri, funcționalități) se aplică solicitărilor executate, ca și pentru orice utilizare a API-ului.
Unde pot găsi cheia mea API?
În tabloul dumneavoastră de bord Certyneo, sub Setări → Chei API. Creați o cheie dedicată testelor dumneavoastră Postman.
Este colecția actualizată cu cea mai recentă versiune a API-ului?
Da, colecția este regenerată din specificația OpenAPI oficială a API-ului Certyneo la fiecare evoluție a API-ului REST v1.
Pot testa webhook-urile din Postman?
Da, colecția conține punctele finale pentru a crea și lista abonamentele dumneavoastră la webhook-uri. Pentru a primi evenimente în local, utilizați un serviciu de tunel HTTP în perioada testelor dumneavoastră.
Utilizarea colecției Postman are un cost?
Nu, doar consumarea API-ului în sine (crearea plicurilor) este dedusă din planul dumneavoastră, exact ca un apel API clasic.
Pentru a merge mai departe
Testați API-ul Certyneo în Postman
Colecție publică, gratuită, sincronizată cu documentația noastră pentru dezvoltatori.