Sign’Stash Proxy Client provides a REST API to enable your client services a full integration.
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 Proxy Client 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 Proxy Client API (einvoice-integration-client-ws).
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 | ||
5 |
Authentication example request:
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:
{"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:
Download the following JSON file and import it in a Swagger client (such as Swagger.io) to get access to the API:
Authentication API
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-ws Authentication API: https://staging.must.digital/oauth2/authorization-server |
Production | Business API: https://your_proxy_client_service_location/signstash/einvoice-integration-ws Authentication API: https://msignstash.multicert.com/oauth2/authorization-server |
Integration Flows
This section describes the main flows that your implementation needs to guarantee for a successful integration.
While using the Integration 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.
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.
Only the operation details can be consulted since the document is not stored either preserved in the system.
TODO > colocar novo diagrama (imagem) aqui
TODO > prrencher tabela abaixo com fluxos possiveis do novo diagrama
Step | Alternative Scenario | Behaviour |
|---|---|---|