SignAPI interfaces
Session API
Description
Session API main scope is to manage file processing sessions.
Session API contains two methods:
- Create session
- Close session
| Session API URL |
|---|
| /api-session/v1.0/ |
Operations
| Method | Endpoint | Description |
|---|---|---|
| GET | start | Data processing session creation |
| GET | {sessionId}/close | Closing data processing session |
Storage API
Description
Storage API main scope is to manage files or digests within the session.
Storage API contains following methods:
- Upload file
- Add document digest
- List files
- Download file
- Delete file
| Storage API URL |
|---|
| /api-storage/v1.0/ |
Operations
| Method | Endpoint | Description |
|---|---|---|
| PUT | {sessionId}/upload | Upload file |
| GET | {sessionId}/list | Retrieve file list in specific session |
| GET | {sessionId}/{documentiId} | Download file |
| DELETE | {sessionId}/{documentiId} | Delete file |
| POST | {sessionId}/addDocumentDigest | Add file digest and file name for signing |
Signing API
Description
Signing API main scope is to manage signatures/seals of archive timestamps within the session.
Signing API contains following methods:
- Calculate digest
- Finalize signing
- Add archive timestamp
- Create electronic seal
| Signing API URI |
|---|
| /api-sign/v1.0/ |
Operations
| Method | Endpoint | Description |
|---|---|---|
| POST | calculateDigest | Signable data calculation |
| POST | finalizeSigning | Signed document finalization |
| POST | addArchive | Archive timestamp request |
| POST | eSealCreate | Creates electronic seal with client provided electronic seal key |
Validation API
Description
Validation API main scope is to validate electronic signatures/seals of archive timestamps.
| Validation API URI |
|---|
| /api-validation/v1.0/ |
Operations
| Method | Endpoint | Description |
|---|---|---|
| GET | {sessionId}/{documentiId}/validate | Validation of signed file |
Share API
Description
Share API main scope is to manage session sharing.
Share API contains following methods:
- Start sharing
- Persons in session
- Sessions of a Person
- Remove sharing
| Share API URI |
|---|
| /api-share/v1.0/ |
Operations
| Method | Endpoint | Description |
|---|---|---|
| POST | {sessionId}/persons | Add access rights to a specific session |
| GET | {sessionId}/persons | Find out the persons with whom session is shared |
| GET | {personId}/sessions | Find out the sessions which are shared with the specific person |
| DELETE | {sessionId}/persons/{personId} | Remove access rights from the specific session |
Configuration API
Description
Configuration API main scope is to provide registered information to Service provider.
| Configuration API URI |
|---|
| /api-config/v1.0/ |
Operations
| Method | Endpoint | Description |
|---|---|---|
| GET | Retrieve Service provider's configuration |
Updated about 2 years ago