API - firma recupera il contratto, firma ed OTP
API - firma recupera il contratto, firma ed OTP
Recupera il contratto
Questa chiamata, opzionale, ti consente di ottenere l’anteprima del contratto prima della firma, 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}
Il parametro {contractId} ti è stato restituito alla richiesta del certificato.
Metodi accettati
GET
Autenticazione
Questa API richiede l’autenticazione tramite shopId e header X-Auth-Token.
Prerequisiti
Per accedere a questo endpoint è necessario aver richiesto i termini del contratto del cliente.
Firma il contratto
Con questa chiamata l’utente accetta il contratto. Per convalidare l’accettazione, dovrai trasmetterci l’OTP, inviato all’utente via SMS al termine della chiamata API precedente, e l’esplicita accettazione da parte dell’utente delle clausole che ti abbiamo restituito nella precedente 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
Metodi accettati
POST
Autenticazione
Questa API richiede l’autenticazione tramite shopId e header X-Auth-Token.
Prerequisiti
Per accedere a questo endpoint è necessario aver richiesto il certificato.
Parametri
| Parametro | Obbligatorio | Tipo | Formato | Descrizione |
|---|---|---|---|---|
| clauses | Sì | Oggetto | Le clausole accettate dall’utente. Vedi esempio. | |
| otp | Sì | Intero | Codice OTP inviato via SMS all’utente nella chiamata API precedente. |
Dovrai trasmettere tutte le clausole ricevute nella chiamata precendente con tutte le condizioni settate a true.
Risposta
L’API restituisce un file PDF.
{
"otp": 12345,
"clauses": {
"termsAndConditions": true,
"privacyPolicy": true,
"sddStatement": true,
}
}
Richiedi un nuovo OTP
In caso l’utente non abbia ricevuto l’OTP a seguito della chiamata di firma del contratto, è possibile richiederne uno nuovo con questa 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
Metodi accettati
POST
Autenticazione
Questa API richiede l’autenticazione tramite shopId e header X-Auth-Token.
Prerequisiti
Per accedere a questo endpoint è necessario aver richiesto la firma del certificato.
Risposta
L’API non restituisce alcun contenuto in caso di successo.
Ecco un riepilogo dei codici di risposta
Codici HTTP di risposta
| Codice | Descrizione |
|---|---|
| 204 | Richiesta completata con successo |
| 400 | Errore di sintassi o di dominio |
| 403 | Impossibile autenticare la richiesta |
| 500 | Errore di sistema |
Risposta di errore
L’oggetto JSON restituito in caso di errore varia a seconda del codice HTTP di risposta.
Errore 400
La descrizione dell’errore messaggio cambierà a seconda dell’errore generato dalla Certification Authority.
{
"errors": {
"domain": [
{messaggio}
]
}
}
Errore 403
La richiesta inviata contiene delle credenziali non valide. Controlla lo shopId e l’header X-Auth-Token. Trovi maggiori info sulle credenziali nel paragrafo dell’autenticazione.
{
"errors": {
"domain": [
"The user has no access to this resource"
]
}
}
Errore 500
Le risposte con questo codice HTTP indicano che si è verificato un errore di sistema.
{
"errors": {
"system": [
{messaggio}
]
}
}
