API - Documentation techniquev1.3

Environnements

Production

Endpoint
https://www.contrat-prive.com/webService/
WSDL
https://www.contrat-prive.com/webService/api.wsdl

Plateforme de test

Endpoint
https://sandbox.contrat-prive.com/webService/
WSDL
https://sandbox.contrat-prive.com/webService/api.wsdl

Apis

Vérification des paramètres de connexion

Operation
checkConnexion
Input
checkConnexionRequest
Output
checkConnexionResponse
˄ Remonter ˄

Création d'un contrat

Operation
contractCreate
Input
contractCreateRequest
Output
contractCreateResponse
˄ Remonter ˄

Détail d'un contrat

Operation
contractDetail
Input
contractDetailRequest
Output
contractDetailResponse
˄ Remonter ˄

Liste des contrats

Operation
contractList
Input
contractListRequest
Output
contractListResponse
˄ Remonter ˄

Suppression d'un contrat

Operation
contractDelete
Input
contractDeleteRequest
Output
contractDeleteResponse
˄ Remonter ˄

Annulation d'un contrat

Operation
contractCancel
Input
contractCancelRequest
Output
contractCancelResponse
˄ Remonter ˄

Finalisation d'un contrat

Operation
contractFinalize
Input
contractFinalizeRequest
Output
contractFinalizeResponse
˄ Remonter ˄

Envoi du code SMS à un signataire

Operation
signatorySendSms
Input
signatorySendSmsRequest
Output
signatorySendSmsResponse
˄ Remonter ˄

Envoi du code SMS à tous les signataires

Operation
signatorySendAllSms
Input
signatorySendAllSmsRequest
Output
signatorySendAllSmsResponse
˄ Remonter ˄

Envoi du code SMS à un signataire pour plusieurs contrats

Operation
signatorySendOneSms
Input
signatorySendOneSmsRequest
Output
signatorySendOneSmsResponse
˄ Remonter ˄

Signature du contrat par un signataire

Operation
signatorySign
Input
signatorySignRequest
Output
signatorySignResponse
˄ Remonter ˄

Codes d'erreur

Erreurs génériques
ResultCode ResultMessage Message
001 UNEXPECTED Erreur interne
002 WRONG_API_KEY Informations de connexion incorrectes
003 OPERATION_NOT_ALLOWED Opération non autorisée

Erreurs sur les contrats
ResultCode ResultMessage Message
101 CONTRACT_NOT_FOUND Contrat non trouvé
102 CONTRACT_NOT_SUBMITTED Contrat non soumis, annulé ou validé
103 CONTRACT_SIGNED Le contrat est signé
104 CONTRACT_CLOSED Le contrat à un statut clôturant
105 CONTRACT_NOT_SIGNED Le contrat n'est pas signé
106 CONTRACT_SUBMIT_RULES Les conditions pour soumettre le contrat ne sont pas respectées : dates limites dans le passé, crédits insuffisants, informations bancaires non renseignées pour le déposant (cas des acomptes)

Erreurs sur les signataires
ResultCode ResultMessage Message
201 SIGNATORY_NOT_FOUND Signataire non trouvé
202 SIGNATORY_WRONG_SMS_CODE Mauvais code SMS
203 SIGNATORY_ALREADY_SIGNED Le signataire à déjà signé le contrat
204 SIGNATORY_PAIMENT_REQUIRED Paiement requis
205 SIGNATORY_TOO_MUCH_SMS Quota de SMS atteint pour ce signataire
206 SIGNATORY_MISMATCH_PHONE_NUMBER Les signataires n'ont pas tous le même numéro de téléphone

Erreurs sur les fichiers
ResultCode ResultMessage Message
301 FILE_MIMETYPE_NOT_ALLOWED Type de fichier non autorisé
302 FILE_CONVERSION_ERROR Impossible de convertir le document
303 FILE_READONLY Le fichier est protégé ou en lecture seule
304 FILE_SIZE_TOO_LARGE La taille du fichier est trop grande
˄ Remonter ˄