SignAPI saskarnes
Sesijas API
Apraksts
Sesijas API galvenā darbības joma ir failu apstrādes sesiju pārvaldība.
Sesijas API ietver divas metodes:
-
Izveidot sesiju
-
Aizvērt sesiju
| Sesijas API URL |
|---|
/api-session/v1.0/ |
Darbības
| Metode | Galapunkts (Endpoint) | Apraksts |
|---|---|---|
GET | start | Datu apstrādes sesijas izveide |
GET | \{sessionId}/close | Datu apstrādes sesijas aizvēršana |
Krātuves API
Apraksts
Krātuves API (Storage API) galvenā darbības joma ir pārvaldīt failus vai īssavilkumus sesijas ietvaros.
Krātuves API (Storage API) ietver šādas metodes:
-
Faila augšuplāde
-
Dokumenta īssavilkuma (digest) pievienošana
-
Failu saraksts
-
Faila lejupielāde
-
Faila džēšana
| Krātuves API URL |
|---|
/api-storage/v1.0/ |
Darbības
| Metode | Galapunkts (Endpoint) | Apraksts |
|---|---|---|
PUT | \{sessionId}/upload | Faila augšuplāde |
GET | \{sessionId}/list | Failu sarakstu izgūšananoteiktā sesijā |
GET | \{sessionId}/\{documentiId} | Faila lejupielāde |
DELETE | \{sessionId}/\{documentiId} | Faila džēšana |
POST | \{sessionId}/addDocumentDigest | Faila īssavilkumua (digest) un faila nosaukuma pievienošana parakstīšanai |
Parakstīšanas API
Apraksts
Parakstīšanas API (Signing API) galvenais mērķis ir pārvaldīt parakstus un zīmogus, kā arī arhīva laika zīmogus sesijas ietvaros.
Parakstīšanas API ietver šādas metodes:
-
Aprēķināt īssavilkumu
(digest) -
Pabeigt parakstīšanu
-
Pievienojiet arhīva laika zīmogu
-
Pievienojiet elektronisko zīmogu
| Parakstīšanas API URI |
|---|
/api-sign/v1.0/ |
Darbības
| Metode | Galapunkts(Endpoint) | Apraksts |
|---|---|---|
POST | calculateDigest | Parakstāmo datu aprēķins |
POST | finalizeSigning | Parakstīta dokumenta noformēšana |
POST | addArchive | Arhīva laika zīmoga pieprasījums |
POST | eSealCreate | Izveido elektronisko zīmogu ar klienta nodrošināto elektroniskā zīmoga atslēgu |
Validācijas API
Apraksts
Validācijas API (Validation API) galvenais mērķis ir validēt elektroniskos parakstus un zīmogus, kā arī arhīva laika zīmogus.
| Validācijas API URI |
|---|
/api-validation/v1.0/ |
Darbības
| Metode | Galapunkts (Endpoint) | Apraksts |
|---|---|---|
GET | \{sessionId}/\{documentiId}/validate | Parakstīta faila validācija |
Koplietošanas API
Apraksts
Koplietošanas API (Share API) galvenā darbības joma ir pārvaldīt sesiju koplietošanu.
Koplietošanas API ietver šādas metodes:
-
Sākt koplietošanu
-
Personas sesijā
-
Personas sesijas
-
Pārtraukt koplietošanu
| Koplietošanas API URI |
|---|
/api-share/v1.0/ |
Darbības
| Metode | Galapunkts (Endpoint) | Apraksts |
|---|---|---|
POST | \{sessionId}/persons | Pievienojiet piekļuves tiesības noteiktai sesijai |
GET | \{sessionId}/persons | Uzziniet personas, ar kurām tiek kopīgota sesija |
GET | \{personId}/sessions | Uzziniet sesijas, kas tiek kopīgotas ar konkrēto personu |
DELETE | \{sessionId}/persons/\{personId} | Noņemiet piekļuves tiesības no konkrētās sesijas |
Konfigurācijas API
Apraksts
Konfigurācijas API (Configuration API) galvenā darbības joma ir nodrošināt pakalpojuma sniedzējam reģistrēto informāciju.
| Konfigurācijas API URI |
|---|
/api-config/v1.0/ |
Darbības
| Metode | Galapunkts (Endpoint) | Apraksts |
|---|---|---|
GET | Izgūt pakalpojumu sniedzēja konfigurāciju |