| Table of Contents | ||
|---|---|---|
|
Sign’Stash Proxy Client provides a REST API to enable your client services a full integration.
| Note |
|---|
Please make sure that you have executed the steps in the “Getting Started (On-Premise)” section in order to have a valid client service credential to consume Sign’Stash services. |
Authentication
Sign’Stash API is protected with an OAuth2 authentication scheme with client_credentials flow.
For more information on this standard, please consult OAuth Client Credentials Flow.
The following diagram depict the typical flow that your client service needs to ensure to retrieve an access token to invoke Sign’Stash API (einvoice-integration-ws) through the Proxy Client API (einvoice-integration-client-ws).
| Info |
|---|
Both the clientID and the client secret refer to the configurations of the Sign’Stash client service that you wish to connect to. Thus, clientID is the client service alias and client secret is the defined credentials to it. |
Step | Alternative Scenario | Behaviour |
|---|---|---|
1 | OAuth authentication error | Basic credentials presented are invalid. New Basic Authentication must be requested by the client with the proper credentials. Please make sure that clientID is the service alias known in Sign’Stash, and client secret is the password that you have defined in Sign’Stash backoffice. |
6 | Sign’Stash authentication error | OAuth token is invalid. New OAuth token must be retrieved from OAuth server. |
Authentication example request:
| Code Block |
|---|
curl -v -X POST https://staging.must.digital/oauth2/authorization-server/oauth/token -d "grant_type=client_credentials" -H "Authorization: Basic <base64 of client_id:client_secret>" |
Authentication example response:
| Code Block |
|---|
{"access_token":"eyJhbG....cian84R9Q","token_type":"bearer","expires_in":86399,"scope":"read write","jti":"0e33b...a99a9d"} |
API Definition and Examples
The complete definition of the Sign’Stash Proxy Client API is available in:
Business API (Swagger):
Start the Sign’Stash Proxy service, whether in a docker image or fat jar version, and access the following endpoint with the necessary adaptations:
Authentication API (Swagger):
Service Endpoints
The following REST service endpoints are available for your integration:
Staging (for sandboxing and testing purposes) | Business API: https://your_proxy_client_service_location/signstash/einvoice-integration-client-ws Authentication API: https://staging.must.digital/oauth2/authorization-server |
Production | Business API: https://your_proxy_client_service_location/signstash/einvoice-integration-client-ws Authentication API: https://msignstash.multicert.com/oauth2/authorization-server |
Requirements
Hardware
This section describes the minimum and recommended hardware requirements for running the service based on a common and an extreme scenario in three different integration use cases: API synchronous mode, API asynchronous mode, Hot folder mode.
This information is applied to an unique instance of the service and should be extrapolated according to the specific environment and architecture.
API in synchronous mode
Useful in situations where API integration is preferred, the number of files/request signing is low (<100) considering an average size of 200KB and with a synchronous response of the signed documents.
A minimum of disk space (container volume) equal to 5x the total payload size must be guaranteed but it is recommended 10x.
This value is applicable to a single request and must be extrapolated according to the total number of requests being processed.
Scenario | 1 to 2 simultaneous requests (container memory) | Several simultaneous requests (container memory) |
|---|---|---|
Common use case of ~10MB of payload (e.q. list of 50 files of 200KB each) |
|
|
Extreme use case of ~500MB of payload (e.q. list of 25 files of 20MB each) |
|
|
API in asynchronous mode
Useful in situations where integration by API is preferred, the number of files to be signed has an acceptable range (100 - 2500) considering an average size of 200KB and where the asynchronous response of the signed documents is feasible.
This mode requires the following specifications in terms of disk space consumption (container volume):
Internal database: ~2MB/request with 1000 files (a significant percentage is reclaimed monthly by applying database housekeeping strategies automatically).
Temporary files: Extrapolated according the rule Double(Maximum load in number of files x Average File average size of each file). E.g., 2x(20.000 files x 200KB) = 8GB.
Scenario | 1 to 2 simultaneous requests (container memory) | Multiple simultaneous requests (container memory) |
|---|---|---|
Common use case of ~20MB of payload (e.q. list of 100 files of 200KB each) |
|
|
Extreme use case of ~500MB of payload (e.q. list of 2500 files of 200KB each) |
|
|
Hot folder mode
Useful in situations where the number of files is large (>2500) and a strategy of input/output folders processing is suitable.
This mode requires the following specifications in terms of disk space consumption (container volume):
Internal database: ~2MB/request with 1000 files (a significant percentage is reclaimed monthly by applying database housekeeping strategies automatically).
Temporary files: Extrapolated according the rule Double(Maximum load in number of files x Average File average size of each file). E.g., 2x(20.000 files x 200KB) = 8GB.
Throughput: >30files/s
Scenario | Page size of 1000 (container memory) |
|---|---|
Input folder with ~10.000 files |
|
Input folder with ~2.000.000 files |
|
Ideally, the processor used by this service must have intensive processing capacities such as the following models:
Intel Xeon Skylake
Intel Xeon Broadwell
Software
This section describes the software requirements for running the service.
As the official distribution format is through docker images, this service requires the installation of Docker Engine 19+.
| Info |
|---|
Based on internal stress tests, there are significant improvements in the metrics related to signature time when a request aggregates multiple documents. It means that it is significantly worse to create 50 requests with just one document each than to create a single request with 50 documents. This aspect must be considered in order to optimize the performance and the load of the systems involved. |
Integration Flows
This section describes the main flows that your implementation needs to guarantee for a successful integration.
| Info |
|---|
While using the Sign’Stash Proxy Client component, it is only possible to execute digital signatures on a set of supplied documents, unlike the Integration Service, where it is also possible to consult documents details. |
Document Signing
The following diagram illustrates the actions that a client service needs to execute to request the application of digital signatures on a set of documents.
Each document(s) signature request will produce a new operation in the system that could later be consulted on the backoffice.
| Note |
|---|
Only the operation details can be consulted since the document is not stored either preserved in the system. |
Step | Alternative Scenario | Behaviour |
|---|---|---|
5 | Client service not active | Client service or issuer is in not in active status, thus not allowing service usage. Issuer operator should access Sign’Stash backoffice and check its configurations. |
6 | Digital certificate not provisioned | If client service has no valid digital certificate set, the Sign’Stash service will not be able to sign the document. Issuer operator should access Sign’Stash backoffice and configure a proper certificate for the client service. |