Publiczne API

Autosignly ma REST API, które wywołasz z własnego kodu: wgrasz PDF, dołączysz do niego pliki, wyślesz do podpisujących i pobierzesz zapieczętowany dokument, gdy wszyscy podpiszą.

Adres bazowy:

https://app.autosignly.eu/api/publics/v1

Klucze i środowiska

Każde żądanie niesie dwa nagłówki:

X-API-KEY:    api_key_...
X-API-SECRET: ...

Klucze tworzysz w Autosignly w sekcji API w menu — znajdziesz tam również swoje webhooki i log wykonanych żądań.

Każde środowisko ma własną parę: klucze produkcyjne zaczynają się od api_key_, sandboxowe od sbx_key_. To sam klucz decyduje, jakich danych dotykasz, więc kluczem sandboxowym nie sięgniesz do dokumentów produkcyjnych. Nie wiesz, który trzymasz w ręku? Zapytaj API:

curl https://app.autosignly.eu/api/publics/v1/credentials \
  -H "X-API-KEY: $AUTOSIGNLY_API_KEY" \
  -H "X-API-SECRET: $AUTOSIGNLY_API_SECRET"

Co możesz zrobić

• Dokumenty — wgraj PDF, wylistuj i przefiltruj dokumenty, odczytaj jeden razem z podpisującymi, pobierz jego plik w dowolnym momencie (dokument w trakcie podpisywania niesie podpisy zebrane do tej pory)
• Załączniki — dołącz pliki PDF, JPEG i PNG, zanim dokument pójdzie do podpisu; zostaną przekonwertowane do PDF i scalone za stroną indeksu, na której widnieje suma kontrolna każdego z nich, więc jeden podpis pokrywa dokument razem ze wszystkim, co do niego dołączono
• Podpisywanie — wyślij dokument do podpisujących w trybie SES, AES lub QES; pierwszy podpisujący dostaje link od razu, kolejni dostają swój mailem, gdy przyjdzie ich kolej
• Tagi — grupuj dokumenty i filtruj listę po jednym lub kilku tagach
• Kontrahenci — prowadź listę firm i osób, z którymi podpisujesz: dodaj, wylistuj i przefiltruj po nazwie albo typie, odczytaj jednego, zastąp go, usuń
• Webhooki — każde zdarzenie asynchroniczne (podpis, ukończony dokument, anulowanie albo przywrócenie) trafia na Twój endpoint, podpisane, żebyś mógł zweryfikować, że przyszło od nas. Payloady i nagłówki HMAC są na tamtej stronie oraz w sekcji webhooks specyfikacji OpenAPI.

Klienty

Możesz wołać API zwykłym HTTP albo skorzystać z oficjalnego klienta — wszystkie na licencji Apache-2.0, rozwijane otwarcie na github.com/16it-pl/autosignly-sdk.

	Paczka	Strona
Java	eu.autosignly:autosignly-client	Klient Java
Node.js	@16it/autosignly	Klient Node
Python	autosignly	Klient Python
CLI	autosignly	Narzędzie wiersza poleceń

Wersje: wspierana linia to 1.0.*. Najnowsze wydanie każdej paczki znajdziesz wśród tagów w repozytorium.

Wolisz czytać samo API? Swagger UI wymienia każdy endpoint z parametrami i odpowiedziami i pozwala wywołać metodę własnym kluczem, a serwowaną przez niego specyfikację OpenAPI pobierzesz, jeśli wolisz wygenerować własnego klienta.