API - signature retrieves the contract, signature and OTP
API - signature retrieves the contract, signature and OTP
Retrieve the contract
This call, optional, allows you to get the preview of the contract before signing, in Pdf.
Endpoint
Sandbox: https://api.sandbox.soisy.it/api/shops/{shopId}/requests/{fiscalCode}/contracts/{contractId}
Produzione: https://api.soisy.it/api/shops/{shopId}/requests/{fiscalCode}/contracts/{contractId}
The parameter{contractId} it was returned to you when you requested the certificate.
Accepted methods
GET
Authentication
This API requires authentication viashopId and headerX-Auth-Token .
Prerequisites
To access this endpoint, you must have requested the terms of the customer agreement.
Sign the contract
With this call the user accepts the contract. To validate the acceptance, you will need to send us the OTP, sent to the user via SMS at the end of the previous API call, and the explicit acceptance by the user of the clauses that we have returned to you in the previous API.
Endpoint
Sandbox: https://api.sandbox.soisy.it/api/shops/{shopId}/requests/{fiscalCode}/sign-contracts
Produzione: https://api.soisy.it/api/shops/{shopId}/requests/{fiscalCode}/sign-contracts
Accepted methods
POST
Authentication
This API requires authentication viashopId and headerX-Auth-Token .
Prerequisites
To access this endpoint you need to have requested the certificate.
Parameters
| Parameter | Mandatory | Type | Format | Description |
|---|---|---|---|---|
| clauses | Yes | Subject | The clauses accepted by the user. See example. | |
| otp | Yes | Integer | OTP code sent via SMS to the user in the previous API call. |
You will have to transmit all the clauses received in the previous call with all the conditions set totrue .
Answer
The API returns a PDF file.
{
"otp": 12345,
"clauses": {
"termsAndConditions": true,
"privacyPolicy": true,
"sddStatement": true,
}
}
Request a new OTP
In case the user has not received the OTP as a result of the contract signing call, a new one can be requested with this API.
Endpoint
Sandbox: https://api.sandbox.soisy.it/api/shops/{shopId}/requests/{fiscalCode}/send-new-otp
Produzione: https://api.soisy.it/api/shops/{shopId}/requests/{fiscalCode}/send-new-otp
Accepted methods
POST
Authentication
This API requires authentication viashopId and headerX-Auth-Token .
Prerequisites
To access this endpoint you must have requested a certificate signing.
Answer
The API does not return any content on success.
Here is a summary of the response codes
HTTP response codes
| Code | Description |
|---|---|
| 204 | Request completed successfully |
| 400 | Syntax or domain error |
| 403 | Failed to authenticate the request |
| 500 | System error |
Error response
The JSON object returned in the event of an error varies depending on the HTTP response code.
Error 400
The description of the errormessaggio it will change according to the error generated by the Certification Authority.
{
"errors": {
"domain": [
{messaggio}
]
}
}
Error 403
The sent request contains invalid credentials. Check the shopId and headerX-Auth-Token . Find more info on credentials in the authentication paragraph.
{
"errors": {
"domain": [
"The user has no access to this resource"
]
}
}
Error 500
Responses with this HTTP code indicate that a system error has occurred.
{
"errors": {
"system": [
{messaggio}
]
}
}
