API elektronického podpisu Certyneo v Postmanu
Importujte veřejnou kolekci Certyneo do Postmanu a testujte každý endpoint REST API v1 — vytváření obálek, odesílání, sledování stavu, webhooky — s již vyplněnými příklady požadavků.
Bezplatná a veřejná kolekce. K provedení požadavků je vyžadován klíč API Certyneo.
Proč používat kolekci Postman Certyneo
Kolekce je navržena pro vývojáře, kteří chtějí prozkoumat API Certyneo, aniž by si přečetli celou dokumentaci, než spustí svůj první požadavek.
Požadavky připravené k použití
Každý endpoint REST API v1 je dokumentován s příkladem požadavku a odpovědi, připravený k provedení po zadání vašeho klíče API.
Testovací prostředí
Proměnná prostředí Postman obsahuje váš klíč API a základní URL, abyste mohli snadno přepínat mezi vašimi účty nebo prostředími.
Automaticky generovaná dokumentace
Dokumentace Postman kolekce zůstává synchronizovaná se specifikací OpenAPI API Certyneo — žádné rozdíly mezi tím, co testujete a co je v produkci.
Testování bez psaní kódu
Vytvořte obálku, odešlete ji a sledujte její stav přímo z rozhraní Postman, ještě předtím, než integrujete API do své aplikace.
Co kolekce pokrývá
Přehled skupin endpointů dostupných ve veřejné kolekci.
| Skupina | Co obsahuje |
|---|---|
| Obálky | Vytvářet, odesílat, uvádět, prohlížet a zrušovat obálky podpisu. |
| Dokumenty | Nahrát dokument nebo jej importovat z adresy URL (sourceUrl), zkontrolovat jeho stav. |
| Podepisující | Přidat příjemce, určit jejich pořadí podpisu a úroveň (SES/AES). |
| Webhooks | Vytvářet a spravovat odběry na události podpisu. |
| Hromadné odesílání | Odesílat více obálek v jedné žádosti pro kampáně podpisu ve velkém objemu. |
Kolekce je veřejně čitelná: můžete ji prohlížet bez účtu, ale spouštění požadavků vyžaduje platný klíč API Certyneo.
Začněte s kolekcí ve 4 krocích
Trvá to méně než 5 minut na spuštění vaší první žádosti.
- 1
Importovat veřejnou kolekci
V Postmanu otevřete veřejnou kolekci Certyneo a klikněte na «Fork» nebo «Import» pro její zkopírování do vlastního prostoru.
- 2
Vygenerovat klíč API Certyneo
V panelu Certyneo otevřete Nastavení → Klíče API a vytvořte klíč určený pro Postman.
- 3
Vyplnit proměnnou prostředí
Vložte svůj klíč API do proměnné prostředí kolekce Postman spolu se základní URL API.
- 4
Poslat první požadavek
Spusťte požadavek « Vytvořit obálku » a sledujte výsledek přímo v Postmanu.
Bezpečnost a osvědčené postupy
Požadavky ze sbírky procházejí stejným API jako vaše aplikace v produkci: platí stejná pravidla bezpečnosti.
- Všechny požadavky procházejí minimálně přes HTTPS/TLS 1.2.
- Každý klíč API je omezen na oprávnění, která mu přidělíte při jeho vytváření.
- Použijte vyhrazený testovací klíč pro vaše testy Postman, odlišný od vašeho produkčního klíče.
- Kompromitovaný nebo nepoužívaný klíč API se odvolá jedním kliknutím z vašeho ovládacího panelu Certyneo.
Často se ptáte
Je potřeba placený plán na používání sbírky Postman?
Ne. Sbírka je veřejná a bezplatná. Omezení vašeho plánu Certyneo (počet obálek, funkce) se vztahují na provedené požadavky, stejně jako na jakékoli používání API.
Kde najdu svůj klíč API?
Ve vašem ovládacím panelu Certyneo v sekci Nastavení → Klíče API. Vytvořte klíč určený pro vaše testy Postman.
Je sbírka aktuální s nejnovější verzí API?
Ano, sbírka je regenerována z oficiální specifikace OpenAPI rozhraní Certyneo API při každé aktualizaci REST API v1.
Mohu testovat webhooks z Postmanu?
Ano, sbírka obsahuje koncové body pro vytváření a výpis vašich odběrů webhooks. Chcete-li přijímat události lokálně, během testování použijte službu HTTP tunelu.
Má používání sbírky Postman nějaké náklady?
Ne, pouze spotřeba samotného API (vytváření obálek) se odpočítává z vašeho plánu, přesně jako klasické volání API.
Pro další krok.
Vyzkoušejte Certyneo API v Postmanu
Veřejná kolekce, bezplatná, synchronizovaná s naší vývojářskou dokumentací.