API podpisu elektronicznego Certyneo w Postman
Zaimportuj publiczną kolekcję Certyneo do Postman i testuj każdy endpoint REST API v1 — tworzenie kopert, wysyłanie, śledzenie statusu, webhooki — z już wypełnionymi przykładami żądań.
Darmowa i publiczna kolekcja. Do wykonania żądań wymagany jest klucz API Certyneo.
Dlaczego warto używać kolekcji Postman Certyneo
Kolekcja została zaprojektowana dla deweloperów, którzy chcą zbadać API Certyneo bez czytania całej dokumentacji przed wysłaniem pierwszego żądania.
Gotowe do użycia żądania
Każdy endpoint REST API v1 jest udokumentowany z przykładem żądania i odpowiedzi, gotowy do wykonania po wpisaniu klucza API.
Środowiska testowe
Zmienna środowiskowa Postman zawiera twój klucz API i bazowy adres URL, aby łatwo przełączać się między kontami lub środowiskami.
Dokumentacja generowana automatycznie
Dokumentacja Postman kolekcji pozostaje zsynchronizowana ze specyfikacją OpenAPI interfejsu API Certyneo — brak przesunięcia między tym, co testujesz, a tym, co znajduje się w środowisku produkcyjnym.
Testowanie bez pisania kodu
Utwórz kopertę, wyślij ją i śledź jej status bezpośrednio z interfejsu Postman, zanim jeszcze zintegrujesz interfejs API w swojej aplikacji.
Co obejmuje kolekcja
Przegląd grup punktów końcowych dostępnych w kolekcji publicznej.
| Grupa | Co zawiera |
|---|---|
| Koperty | Tworzenie, wysyłanie, wyświetlanie listy, przeglądanie i anulowanie koperty podpisu. |
| Dokumenty | Przesyłanie dokumentu lub importowanie go z adresu URL (sourceUrl), przeglądanie jego statusu. |
| Sygnatariusze | Dodawanie odbiorców, określanie ich kolejności podpisywania i poziomu (SES/AES). |
| Webhooks | Tworzenie i zarządzanie subskrypcjami zdarzeń podpisu. |
| Wysyłka masowa | Wysyłanie wielu kopert w jednym żądaniu dla kampanii podpisywania na dużą skalę. |
Kolekcja jest publiczna do odczytu: możesz ją przeglądać bez konta, ale wykonanie żądań wymaga ważnego klucza API Certyneo.
Rozpoczęcie pracy z kolekcją w 4 krokach
Wysłanie pierwszego zapytania zajmie Ci mniej niż 5 minut.
- 1
Importuj publiczną kolekcję
Z poziomu Postmana otwórz publiczną kolekcję Certyneo i kliknij « Fork » lub « Import », aby skopiować ją do własnej przestrzeni.
- 2
Wygeneruj klucz API Certyneo
W pulpicie Certyneo otwórz Ustawienia → Klucze API i utwórz klucz dedykowany dla Postmana.
- 3
Wypełnij zmienną środowiskową
Wklej klucz API do zmiennej środowiskowej kolekcji Postman, wraz z podstawowym adresem URL API.
- 4
Wyślij pierwsze żądanie
Uruchom żądanie « Utwórz kopertę » i śledź wynik bezpośrednio w Postmanie.
Bezpieczeństwo i dobre praktyki
Żądania z kolekcji przechodzą przez ten sam API, co aplikacja w produkcji: obowiązują te same zasady bezpieczeństwa.
- Wszystkie zapytania przechodzą przez HTTPS/TLS 1.2 minimum.
- Każdy klucz API jest ograniczony do uprawnień, które mu przydzielisz podczas tworzenia.
- Użyj dedykowanego klucza testowego do testów w Postmanie, oddzielnego od klucza produkcyjnego.
- Skompromitowany lub nieużywany klucz API można odwołać jednym kliknięciem z pulpitu Certyneo.
Często zadawane pytania
Czy do korzystania z kolekcji Postman wymagany jest plan płatny?
Nie. Kolekcja jest publiczna i bezpłatna. Limity twojego planu Certyneo (liczba kopert, funkcjonalności) dotyczą wykonywanych żądań, tak jak w przypadku każdego innego użycia API.
Gdzie znaleźć mój klucz API?
W pulpicie Certyneo, w Ustawienia → Klucze API. Utwórz klucz dedykowany do testów w Postmanie.
Czy kolekcja jest aktualna z najnowszą wersją API?
Tak, kolekcja jest regenerowana ze specyfikacji OpenAPI API REST v1 Certyneo przy każdej ewolucji API.
Czy mogę testować webhooki z Postmana?
Tak, kolekcja zawiera endpointy do tworzenia i wyświetlania listy subskrypcji webhooków. Aby odbierać zdarzenia lokalnie, użyj usługi tunelu HTTP na czas testów.
Czy korzystanie z kolekcji Postman wiąże się z kosztami?
Nie, tylko zużycie samego API (tworzenie kopert) jest naliczane z Twojego planu, dokładnie jak zwykłe wywołanie API.
Do dalszego rozwoju
Testuj API Certyneo w Postmanie
Kolekcja publiczna, bezpłatna, zsynchronizowana z naszą dokumentacją dla deweloperów.