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.

				
					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.

				
					GET

				
			

Questa API richiede l’autenticazione tramite shopId e header X-Auth-Token.

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.

				
					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
				
			
				
					POST

				
			

Questa API richiede l’autenticazione tramite shopId e header X-Auth-Token.

Per accedere a questo endpoint è necessario aver richiesto il certificato.

ParametroObbligatorioTipoFormatoDescrizione
clausesOggetto Le clausole accettate dall’utente. Vedi esempio.
otpIntero 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.

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.

				
					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
				
			
				
					POST
				
			

Questa API richiede l’autenticazione tramite shopId e header X-Auth-Token.

Per accedere a questo endpoint è necessario aver richiesto la firma del certificato.

L’API non restituisce alcun contenuto in caso di successo.

Ecco un riepilogo dei codici di risposta

CodiceDescrizione
204Richiesta completata con successo
400Errore di sintassi o di dominio
403Impossibile autenticare la richiesta
500Errore di sistema

L’oggetto JSON restituito in caso di errore varia a seconda del codice HTTP di risposta.

La descrizione dell’errore messaggio cambierà a seconda dell’errore generato dalla Certification Authority.

				
					 {
     "errors": {
         "domain": [
             {messaggio}
         ]
      }
 }
				
			

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"
         ]
      }
 }
				
			

Le risposte con questo codice HTTP indicano che si è verificato un errore di sistema.

				
					{
    "errors": {
        "system": [
            {messaggio}
        ]
    }
}
				
			

Ciao!

Siamo on line dal lunedì al venerdì dalle 9.30 alle 12.30 e dalle 14.30 alle 17.30

Scrivici in questi orari, grazie!