Ignisign v3 à v4 - Guide de Migration de l'API
Ce guide décrit les changements significatifs apportés dans la version 4 de la plateforme Ignisign, avec une comparaison détaillée des modifications de l'API par rapport à la version 3. Il vous aidera à passer en douceur à la nouvelle version en comprenant les modifications dans les principaux domaines d'Ignisign tels que Documents, Applications, Demandes de Signature, Signataires, et Profils de Signataire.
Principaux Changements
- Gestion des Documents : Suppression du principe
IgnisignDocumentRequest et introduction du type de document DATA_XML.
- Paramètres de l'Application : Ajout des champs
appType et isDefaultApplication, et migration de signatureProfile à signerProfile.
- Demandes de Signature : Déplacement de
templateDisplayerId et templateDisplayerVersion vers les documents et diverses nouveautés.
- Signataires : Migration de signatureProfile à signerProfile avec de nouveaux champs pour Seal, LogCapsule, M2M, et BareSignature.
- Nouvelles Fonctionnalités : Support pour Seal, LogCapsule, M2M, et BareSignature.
1. Mises à Jour Relatives aux Documents
Résumé :
Les changements liés aux documents impliquent un déplacement de l'accent de Signature Profiles vers Documents, avec l'ajout d'un nouveau type de document, DATA_XML, et la suppression de plusieurs classes liées aux demandes de documents.
Principaux Changements :
- Suppression du principe
IgnisignDocumentRequest.
- Modèles déplacés des profils de signature.
- Nouveau type de document :
DATA_XML.
Changements dans les Classes :
| Classe | Champs Ajoutés | Champs Supprimés |
|---|
IgnisignDocument | templateDisplayerId, templateDisplayerVersion | documentRequestId |
IgnisignDocument_Context | - | documentRequest |
IgnisignDocument_InitializationDto | templateDisplayerId, templateDisplayerVersion | - |
IgnisignDocument_UpdateDto | templateDisplayerId, templateDisplayerVersion | - |
Changements dans les Enums :
| Enum | Champs Ajoutés | Champs Supprimés |
|---|
IGNISIGN_DOCUMENT_TYPE | DATA_XML | - |
IGNISIGN_DOCUMENT_STATUS | - | DOCUMENT_REQUEST |
IGNISIGN_WEBHOOK_TOPICS | - | DOCUMENT_REQUEST |
Changements dans les Constantes :
| Constante Ajoutée |
|---|
IMAGE_MIMETYPE_INSERABLE_IN_PDF |
2. Mises à Jour Relatives aux Applications
Résumé :
Les changements dans les applications incluent l'ajout de nouveaux champs à IgnisignApplication, la restructuration de EnvSettings, et l'ajout de nouvelles classes liées à des fonctionnalités comme SSO et les Clés API.
Principaux Changements :
- Nouveaux champs :
appType, isDefaultApplication.
- Migration : Les champs de profil de signature remplacés par des champs de profil de signataire.
- Nouvelles structures :
EnvSettings mis à jour avec de nouveaux champs.
Changements dans les Classes :
| Classe | Champs Ajoutés | Champs Supprimés |
|---|
IgnisignApplication | appType, isDefaultApplication | - |
IgnisignApplication_Context | signerProfiles | - |
IgnisignApplication_EnvSettings | Nouveaux champs API, langue, session, et rétention | appRootUrl, authorizedRedirectionUrls, defaultSignatureProfileId, oAuth2, saml |
Changements dans les Enums :
| Enum Ajouté |
|---|
IGNISIGN_APPLICATION_TYPE |
IGNISIGN_APPLICATION_ENV_API_KEYS_STATUS |
IGNISIGN_SSO_CONFIG_TYPES |
IGNISIGN_SSO_CONFIG_STATUS |
Changements dans les Constantes :
| Constantes Ajoutées |
|---|
IGNISIGN_SIGNATURE_LANGUAGES_AVAILABLE |
IGNISIGN_APPLICATION_TYPES_ACTIVATED |
IGNISIGN_APPLICATION_TYPES_HIDDEN |
3. Mises à Jour Relatives aux Demandes de Signature
Résumé :
Dans les demandes de signature, les champs liés aux modèles ont été retirés de l'objet de demande de signature et déplacés vers les documents. Plusieurs nouveaux champs ont été ajoutés pour supporter de nouvelles fonctionnalités comme Seal, M2M, et BareSignature. Les profils de signature ont été remplacés par des profils de signataire.
Principaux Changements :
- Relocalisation des champs :
templateDisplayerId et templateDisplayerVersion déplacés vers les documents.
- Migration : De
signatureProfile à signerProfile.
- Nouveaux champs : Ajout de champs pour
Seal, M2M, et BareSignature.
Changements dans les Classes :
Classes Renommées :
| Classe Renommée | Nouveau Nom |
|---|
IgnisignSignatureRequest_PublishBySide | IgnisignWebhookDto_SignatureRequestSignerBySide |
IgnisignSignatureRequest_PublishEmbedded | IgnisignWebhookDto_SignatureRequestSignerEmbedded |
IgnisignWebhookDto_SignatureRequestSigner | IgnisignWebhookDto_SignatureRequestSigners |
Classes Ajoutées :
Principalement liées à la migration de signatureProfile à signerProfile.
| Classe Ajoutée | Description |
|---|
IgnisignSignatureRequest_SignerProfile | - |
IgnisignSignatureRequest_Publish_ResponseDTO | - |
IgnisignSignatureRequest_SignerProfile | - |
Changements dans les Classes Existantes :
| Classe | Champs Ajoutés | Champs Supprimés | Champs Renommés |
|---|
IgnisignSignatureRequest | appEnvSettingVersion, defaultSignatureMethod, signerProfilesUsed, individualizeRequests, m2mId | signatureProfileId, templateDisplayerId, templateDisplayerVersion | signersAsApprover -> signerIdsAsApprover |
IgnisignSignatureRequest_UpdateDto | defaultSignatureMethod, signerProfilesSignatureMethod, individualizeRequests | - | signersAsApprover -> signerIdsAsApprover |
IgnisignSignatureRequest_Context | signerProfiles | signersAsApprover, signatureProfile | - |
IgnisignApplication_SignatureMetadata | appType | rootUrl | - |
Nouveaux Enums :
| Enum Ajouté |
|---|
IGNISIGN_SIGNATURE_PROOF_TYPE |
Changements dans les Enums :
| Enum | Champs Ajoutés | Champs Supprimés |
|---|
IGNISIGN_SIGNATURE_LANGUAGES | Nouvelles langues ajoutées | - |
IGNISIGN_ID_PROOFING_METHOD_REF | ORG_SSO_AES, ORG_SSO_QES | ORG_SSO, AUTOMATE_ONBOARDING |
IGNISIGN_AUTH_FULL_MECHANISM_REF | - | AUTOMATE |
IGNISIGN_SIGNATURE_METHOD_REF | - | AUTOMATE_AVANCED |
IGNISIGN_SIGNATURE_REQUEST_STATUS | - | WAITING_DOCUMENTS |
IGNISIGN_SIGNATURE_REQUEST_TYPE | SEAL, SEAL_M2M, BARE_SIGNATURE | - |
4. Mises à Jour Relatives aux Signataires
Résumé :
La migration vers signerProfile est une mise à jour majeure ici, avec de nouveaux champs ajoutés pour supporter les fonctionnalités Seal, LogCapsule, M2M, et BareSignature.
Principaux Changements :
- Migration : De
signatureProfile à signerProfile.
- Nouveaux champs : Support pour les fonctionnalités Seal, LogCapsule, et M2M.
Changements dans les Classes :
| Classe | Champs Ajoutés | Champs Supprimés |
|---|
IgnisignSigner | signerProfileId | signatureProfileId |
IgnisignSigner_CreationRequestDto | signerProfileId | signatureProfileId, isRecurrent |
IgnisignSigner_UpdateRequestDto | signerProfileId | signatureProfileId, isRecurrent |
IgnisignSigner_CreationResponseDto | success, alreadyExists | - |
IgnisignSigner_Summary | signerProfileId, sealClaims, fromUserId | - |
Changements dans les Enums :
| Enum | Champs Ajoutés | Champs Supprimés |
|---|
IGNISIGN_SIGNER_CLAIM_REF | CAN_APPROVE_SEAL_SES, CAN_APPROVE_SEAL_AES, CAN_APPROVE_SEAL_QES | AUTOMATE_SECRET_POSSESSION |
IGNISIGN_SIGNER_ENTITY_TYPE | SEAL | LEGAL, VIRTUAL |
IGNISIGN_SIGNER_STATUS | CORRUPTED | - |
5. Mises à Jour Relatives aux Profils de Signataire
Résumé :
La migration vers signerProfile a entraîné plusieurs nouvelles classes et enums liés à la gestion des méthodes de signature et des profils.
Principaux Changements :
- Nouvelles classes : Classes de profil de signataire ajoutées.
Changements dans les Classes :
| Classe ajoutée |
|---|
IgnisignSignerProfileSignatureMethod |
IgnisignSignerProfile |
IgnisignSignerProfileDto |
IgnisignSigner_To_SignerProfile |
IgnisignSignerProfile_SignatureAuthMethods |
SignerProfileBulkDto |
| Classe supprimée |
|---|
IgnisignSignatureProfile_IdContainerDto |
Enums Ajoutés :
| Enum Ajouté |
|---|
IGNISIGN_SIGNER_PROFILE_STATUS |