API elektronického podpisu Certyneo v Postmane
Importujte verejnú kolekciu Certyneo do Postmana a otestujte každý koncový bod REST API v1 — vytvorenie obálok, odoslanie, sledovanie stavu, webhooks — s už vyplnenými príkladmi žiadostí.
Bezplatná a verejná kolekcia. Na spustenie požiadaviek je potrebný kľúč API Certyneo.
Prečo používať kolekciu Postman Certyneo
Kolekcia je určená pre vývojárov, ktorí chcú preskúmať API Certyneo bez toho, aby si prečítali celú dokumentáciu pred spustením svojej prvej žiadosti.
Žiadosti pripravené na použitie
Každý koncový bod REST API v1 je dokumentovaný s príkladom žiadosti a odpovede, pripravený na spustenie po zadaní vášho kľúča API.
Testovací prostredia
Premenná prostredia Postman obsahuje váš kľúč API a základnú adresu URL, aby ste mohli ľahko prepínať medzi svojimi účtami alebo prostrediami.
Automaticky generovaná dokumentácia
Dokumentácia Postman kolekcie zostáva synchronizovaná so špecifikáciou OpenAPI API Certyneo — bez odstupu medzi tým, čo testujete a čo je v produkcii.
Testovanie bez písania kódu
Vytvorte obálku, pošlite ju a sledujte jej stav priamo z rozhrania Postman, ešte predtým, ako integrujete API do svojej aplikácie.
Čo kolekcia pokrýva
Prehľad skupín koncových bodov dostupných vo verejnej kolekcii.
| Skupina | Čo obsahuje |
|---|---|
| Obálky | Vytvorte, odošlite, zoraďte, skontrolujte a zrušte obálku podpisu. |
| Dokumenty | Nahrajte dokument alebo ho importujte z URL adresy (sourceUrl), skontrolujte jeho stav. |
| Signatári | Pridajte príjemcov, určite poradie ich podpisu a úroveň (SES/AES). |
| Webhooks | Vytvárajte a spravujte predplatné na udalosti podpisu. |
| Hromadné odoslanie | Odošlite niekoľko obálok v jednej požiadavke na kampane podpisu vo veľkom rozsahu. |
Kolekcia je verejná na čítanie: môžete ju prezerať bez účtu, ale vykonávanie požiadaviek vyžaduje platný API kľúč Certyneo.
Začnite s kolekciou v 4 krokoch
Počítajte s menej ako 5 minútami na spustenie vašej prvej požiadavky.
- 1
Importujte verejnú kolekciu
V Postman otvorte verejnú kolekciu Certyneo a kliknite na "Fork" alebo "Import" a skopírujte ju do vlastného priestoru.
- 2
Vygenerujte API kľúč Certyneo
Na svojom ovládacom paneli Certyneo otvorte Nastavenia → API kľúče a vytvorte kľúč určený pre Postman.
- 3
Vyplňte premennú prostredia
Vložte svoj API kľúč do premennej prostredia kolekcie Postman spolu so základnou URL adresou API.
- 4
Odošlite prvú požiadavku
Spustite požiadavku "Vytvorte obálku" a sledujte výsledok priamo v Postman.
Bezpečnosť a osvedčené postupy
Požiadavky z kolekcie prechádzajú cez rovnaké API ako vaša aplikácia v produkcii: platia rovnaké pravidlá bezpečnosti.
- Všetky požiadavky sú prenášané cez HTTPS/TLS 1.2 minimálne.
- Každý kľúč API je obmedzený na oprávnenia, ktoré mu udelíte pri jeho vytvorení.
- Používajte špecializovaný testovací kľúč na vaše pokusy s Postmanom, oddelený od vášho produkčného kľúča.
- Kompromitovaný alebo nepoužívaný kľúč API sa dá odvolať jedným kliknutím z vášho panela Certyneo.
Často sa pýtajúce otázky
Je potrebný platený plán na používanie kolekcie Postman?
Nie. Kolekcia je verejná a bezplatná. Limity vášho plánu Certyneo (počet obálok, funkcie) sa vzťahujú na vykonané požiadavky, rovnako ako pri akomkoľvek použití API.
Kde nájdem svoj kľúč API?
Na vašom paneli Certyneo v časti Nastavenia → Kľúče API. Vytvorte kľúč určený na vaše testy Postman.
Je kolekcia aktuálna s najnovšou verziou API?
Áno, kolekcia sa regeneruje z oficiálnej špecifikácie OpenAPI rozhrania API Certyneo pri každej evolúcii REST API v1.
Môžem testovať webhooks z aplikácie Postman?
Áno, kolekcia obsahuje koncové body na vytvorenie a zoznam vašich odberov webhookov. Na prijímanie udalostí lokálne použite službu tunela HTTP počas vašich testov.
Má používanie kolekcie Postman nejaké náklady?
Nie, iba spotreba samotného API (vytvorenie obálok) sa odpočítava z vášho plánu, presne ako pri klasickom volaní API.
Na ďalší krok
Testujte API Certyneo v aplikácii Postman
Verejná kolekcia, bezplatná, synchronizovaná s našou dokumentáciou pre vývojárov.