RSign (préversion)
RSign® est une plateforme de signature électronique sécurisée et juridiquement contraignante qui simplifie les flux de travail de documents. Ce connecteur permet aux utilisateurs d’automatiser l’envoi de demandes de signature, de suivre l’état de l’enveloppe en temps réel et de récupérer des documents signés et des certificats de signature terminés. Elle améliore l’efficacité de l’entreprise en digitalisant l’exécution des documents et en garantissant des transactions numériques sécurisées et pouvant être suivies.
Ce connecteur est disponible dans les produits et régions suivants :
| Service | classe | Régions |
|---|---|---|
| Copilot Studio | Premium | Toutes les régions Power Automate , à l’exception des éléments suivants : - Us Government (GCC) - Us Government (GCC High) - China Cloud géré par 21Vianet - Us Department of Defense (DoD) |
| Applications logiques | Norme | Toutes les régions Logic Apps , à l’exception des suivantes : - Régions Azure Government - Régions Azure Chine - Us Department of Defense (DoD) |
| Power Apps | Premium | Toutes les régions Power Apps , à l’exception des suivantes : - Us Government (GCC) - Us Government (GCC High) - China Cloud géré par 21Vianet - Us Department of Defense (DoD) |
| Power Automate | Premium | Toutes les régions Power Automate , à l’exception des éléments suivants : - Us Government (GCC) - Us Government (GCC High) - China Cloud géré par 21Vianet - Us Department of Defense (DoD) |
| Contact | |
|---|---|
| Nom | Prise en charge de RSign |
| URL | https://rsign.com/contact/questions |
| Messagerie électronique | support@rpost.com |
| Métadonnées du connecteur | |
|---|---|
| Éditeur | RPost US Inc |
| Éditeur | RPost US Inc |
| Site web | https://rpost.com/ |
| Politique de confidentialité | https://rpost.com/legal-notices/privacy-notice |
| Catégories | Contenu et fichiers ; Productivité |
Vue d’ensemble du connecteur personnalisé RSign
Nom du connecteur : Description de RSign : RSign® est une plateforme de gestion des transactions numériques et de signature électronique pour des flux de travail de documents sécurisés, légalement contraignants et rationalisés. Éditeur: RPost
1. Fonctionnalités du connecteur
Le connecteur RSign fournit l’accès aux fonctions de gestion des documents et de signature électronique, ce qui permet aux utilisateurs d’intégrer des flux de travail RSign® directement dans leurs solutions Power Platform (Power Automate, Power Apps et Logic Apps).
Actions clés
Le connecteur prend actuellement en charge les opérations principales suivantes :
-
Obtenir AuthToken : Authentifie l’utilisateur en fonction des informations d’identification RSign® et récupère un jeton nécessaire (
AuthToken) requis pour tous les appels d’API suivants. - Envoyer une enveloppe à l’aide d’un modèle : Envoie un document pour la signature électronique à l’aide d’un modèle RSign® préconfiguré, en mappant des rôles de modèle à des destinataires spécifiques.
- Envoyer une enveloppe à l’aide d’une règle : Envoie un document pour la signature électronique à l’aide d’une règle RSign® préconfigurée, ce qui permet aux documents d’être fournis en tant que données Base64 dans le corps de la requête.
-
Récupérer les informations du modèle : Récupère des détails sur un modèle ou une règle RSign® spécifique, y compris les documents définis et les rôles de destinataire (
RoleID). - Récupérer l’état de l’enveloppe : Récupère l’état d’une demande de signature électronique à l’aide du code d’enveloppe.
- Récupérer des documents d’enveloppe : Télécharge les documents associés à un code d’enveloppe (documents signés originaux et/ou finaux).
2. Configuration de l’authentification
Le connecteur RSign® utilise un schéma d’authentification personnalisé qui nécessite un appel réussi à l’action Get AuthToken avant d’exécuter une autre action.
Action d’authentification (Get AuthToken)
Cette action nécessite les informations d’identification suivantes, qui doivent être obtenues à partir de la plateforme RSign® :
| Nom du paramètre | Type | Descriptif | Visibilité |
|---|---|---|---|
ReferenceKey |
ficelle | Clé de référence associée à votre compte RPost®. | Important |
EmailId |
ficelle | Adresse e-mail de votre compte RSign®. | Important |
Password |
mot de passe | Mot de passe de votre compte RSign®. | Important |
Utilisation du AuthToken
L’action Get AuthToken retourne une AuthToken valeur dans le corps de la réponse. Ce jeton doit ensuite être transmis dans les appels d’API suivants à toutes les autres actions prises en charge.
Note: Le AuthToken délai d’expiration (AuthTokenExpires) doit être géré dans le flux ou la logique d’application pour vous assurer qu’un nouveau jeton est utilisé lorsque celui-ci expire.
3. Conditions préalables
Pour utiliser correctement ce connecteur personnalisé RSign®, les utilisateurs doivent répondre aux exigences suivantes :
- Licence RSign® valide : Les utilisateurs doivent disposer d’une licence utilisateur RSign® active et valide.
-
Accès à l’API : Le compte RSign® associé aux informations d’identification fournies doit avoir la fonctionnalité d’accès à l’API activée et payante. Cette fonctionnalité est nécessaire pour générer le
ReferenceKeyconnecteur RSign® et l’utiliser correctement.
Si vous ne répondez pas actuellement à ces exigences ou si vous n’êtes pas sûr de la configuration de votre compte RSign® actuel, contactez votre représentant RPost®.
4. Remarques importantes pour l’intégration
Utilisation des modèles et des règles
-
Code de modèle / Code de règle : Les deux
Send Envelopeactions nécessitent unTemplateCode(ou code de règle) qui identifie le document préconfiguré et les champs de signature dans RSign®. -
Mappage de rôles : Lors de l’envoi d’une enveloppe, le
TemplateRoleRecipientMappingtableau doit être rempli. LeRoleIDdestinataire doit d’abord être récupéré à l’aide de l’actionRetrieve Template Information. Cela garantit que les destinataires sont correctement mappés aux champs de signature définis dans le modèle.
Gestion des documents
-
Envoyer une enveloppe à l’aide d’une règle : Cette action nécessite que le contenu du document soit transmis sous forme de chaîne codée en base64 (
DocumentBase64Data). -
Récupérer des documents d’enveloppe : Les documents sont retournés dans le corps de la réponse sous forme de chaînes Base64 (
ByteArray). Le flux consommateur doit décoder cette chaîne pour enregistrer le fichier.
Gestion des erreurs
Toutes les actions retournent des informations d’état dans le corps de la réponse, notamment :
-
StatusCode(entier) -
StatusMessage(chaîne) -
Message(chaîne)
Les utilisateurs doivent implémenter la vérification des erreurs en fonction de la réussite de l’exécution StatusCode de l’opération.
Limitations
| Nom | Appels | Période de renouvellement |
|---|---|---|
| Appels d’API par connexion | 100 | 60 secondes |
Actions
| Envoyer une enveloppe à l’aide d’un modèle |
Envoie une demande eSign aux destinataires sélectionnés à l’aide du modèle RSign indiqué. |
| Envoyer une enveloppe à l’aide d’une règle |
Envoie une demande eSign aux destinataires sélectionnés à l’aide de la règle RSign indiquée. |
|
Obtenir Auth |
Retourne un authToken à utiliser dans toutes les autres actions prises en charge par RSign. |
| Récupérer des documents d’enveloppe |
Récupère la partie documents d’une enveloppe en fonction de son code d’enveloppe. Il récupère les documents d’origine et/ou les documents signés finals en fonction de l’état de l’enveloppe. |
| Récupérer des informations de modèle |
Récupère les informations sur un modèle ou une règle en fonction de son code. Parmi les informations retournées, citons le nom du modèle, les documents et les rôles définis. |
| Récupérer l’état de l’enveloppe |
Récupère l’état d’une enveloppe en fonction de son code d’enveloppe. Vous pouvez sélectionner un rapport détaillé ou résumé. |
Envoyer une enveloppe à l’aide d’un modèle
Envoie une demande eSign aux destinataires sélectionnés à l’aide du modèle RSign indiqué.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Jeton d’authentification
|
AuthToken | True | string |
AuthToken récupéré à partir de l’action « Get AuthToken ». |
|
TemplateCode
|
TemplateCode | True | string |
ID du modèle à utiliser. |
|
Clé d’application
|
AppKey | string |
Identificateur unique d’un système à l’aide du connecteur. Veuillez le demander au support RPost®. |
|
|
RoleID
|
RoleID | True | string |
ID de rôle pour le destinataire. Récupéré à partir de l’action « Récupérer les informations du modèle ». |
|
RecipientEmail
|
RecipientEmail | True | string |
Adresse e-mail du destinataire. |
|
RecipientName
|
RecipientName | True | string |
Nom du destinataire. |
|
Téléphone mobile
|
Mobile | string |
Numéro mobile du destinataire. Si votre modèle ne le nécessite pas, laissez vide. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Code d’enveloppe
|
EnvelopeCode | string |
ID de l’enveloppe. |
|
Message de transparence modifié
|
TransparencyChangedMessage | string |
Message de transparence modifié. |
|
Message d’API basée sur la langue
|
LanguageBasedApiMessge | string |
Message d’API basé sur la langue. |
|
ID du destinataire prérempli
|
PrefillRecipientId | string |
Id du destinataire prérempli. |
|
Page de navigation post-envoi
|
PostSendingNavigationPage | string |
Site web vers lequel le destinataire sera redirigé vers une fois qu’il a terminé de signer l’enveloppe. |
|
Nouvelle interface utilisateur du signataire activée
|
IsNewSignerUIEnabled | boolean |
Nouvelle interface utilisateur du signataire activée. |
|
Code de statut
|
StatusCode | integer |
Code d’état de la réponse. |
|
Message d’état
|
StatusMessage | string |
Message d’état de réponse. |
|
Message
|
Message | string |
Description de l’état de la réponse. |
|
ID d’enveloppe
|
EnvelopeId | string |
ID interne de l’enveloppe générée. |
|
SIGNER L’URL du document
|
SignDoumentUrl | string |
URL globale pour la signature de l’enveloppe. |
|
Liste des destinataires
|
RecipientList | array of object |
Détails des destinataires |
|
Nom destinataire
|
RecipientList.RecipientName | string |
Nom de la partie destinataire de l’enveloppe actuelle. |
|
E-mail du destinataire
|
RecipientList.RecipientEmail | string |
Adresse e-mail de la partie destinataire de l’enveloppe actuelle. |
|
Commande
|
RecipientList.Order | integer |
Ordre dans lequel le destinataire doit accéder pour compléter l’enveloppe. |
|
Type
|
RecipientList.Type | string |
Type de partie destinataire de l’enveloppe actuelle. Les valeurs possibles sont les suivantes : Signer et Préremplir. |
|
Mode de remise
|
RecipientList.DeliveryMode | integer |
Indique le canal par lequel le code de demande de signature et le code d’accès ont été envoyés au destinataire. |
|
Code de numérotation
|
RecipientList.DialCode | string |
Code de numérotation du pays où la demande de signature et le code d’accès ont été envoyés. |
|
Code de pays
|
RecipientList.CountryCode | string |
Code du pays où la demande de signature et le code d’accès ont été envoyés. |
|
Numéro de portable
|
RecipientList.Mobile | string |
Numéro mobile du destinataire. |
|
Mobile Mode
|
RecipientList.MobileMode | integer |
Indique le canal mobile via lequel le code de demande de signature et le code d’accès ont été envoyés au destinataire. |
|
URL de signature
|
RecipientList.SigningUrl | string |
URL à utiliser par le destinataire pour accéder à l’enveloppe et la signer. |
|
Liste déroulante du code de numérotation
|
DialCodeDropdownList | string |
Liste déroulante du code de numérotation. |
|
Activer le message sur mobile
|
EnableMessageToMobile | string |
Activez message sur mobile. |
Envoyer une enveloppe à l’aide d’une règle
Envoie une demande eSign aux destinataires sélectionnés à l’aide de la règle RSign indiquée.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Jeton d’authentification
|
AuthToken | True | string |
AuthToken récupéré à partir de l’action « Get AuthToken ». |
|
TemplateCode
|
TemplateCode | True | string |
ID de la règle à utiliser. |
|
Nom
|
Name | True | string |
Nom du document. Incluez l’extension (exemple : Agreement.docx). |
|
DocumentBase64Data
|
DocumentBase64Data | True | string |
Document à envoyer au format Base64. |
|
Clé d’application
|
AppKey | string |
Identificateur unique d’un système à l’aide du connecteur. Veuillez le demander au support RPost®. |
|
|
RoleID
|
RoleID | True | string |
ID de rôle pour le destinataire. Récupéré à partir de l’action « Récupérer les informations du modèle ». |
|
RecipientEmail
|
RecipientEmail | True | string |
Adresse e-mail du destinataire. |
|
RecipientName
|
RecipientName | True | string |
Nom du destinataire. |
|
Téléphone mobile
|
Mobile | string |
Numéro mobile du destinataire. Si votre règle ne l’exige pas, laissez vide. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Code d’enveloppe
|
EnvelopeCode | string |
ID de l’enveloppe. |
|
Message de transparence modifié
|
TransparencyChangedMessage | string |
Message de transparence modifié. |
|
Message d’API basée sur la langue
|
LanguageBasedApiMessge | string |
Message d’API basé sur la langue. |
|
ID du destinataire prérempli
|
PrefillRecipientId | string |
Id du destinataire prérempli. |
|
Page de navigation post-envoi
|
PostSendingNavigationPage | string |
Site web vers lequel le destinataire sera redirigé vers une fois qu’il a terminé de signer l’enveloppe. |
|
Nouvelle interface utilisateur du signataire activée
|
IsNewSignerUIEnabled | boolean |
Nouvelle interface utilisateur du signataire activée. |
|
Code de statut
|
StatusCode | integer |
Code d’état de la réponse. |
|
Message d’état
|
StatusMessage | string |
Message d’état de réponse. |
|
Message
|
Message | string |
Description de l’état de la réponse. |
|
ID d’enveloppe
|
EnvelopeId | string |
ID interne de l’enveloppe générée. |
|
SIGNER L’URL du document
|
SignDoumentUrl | string |
URL globale pour la signature de l’enveloppe. |
|
Liste des destinataires
|
RecipientList | array of object |
Détails des destinataires |
|
Nom destinataire
|
RecipientList.RecipientName | string |
Nom du destinataire. |
|
E-mail du destinataire
|
RecipientList.RecipientEmail | string |
Adresse e-mail du destinataire. |
|
Commande
|
RecipientList.Order | integer |
Ordre dans lequel le destinataire doit accéder pour compléter l’enveloppe. |
|
Type
|
RecipientList.Type | string |
Type de partie destinataire de l’enveloppe actuelle. Les valeurs possibles sont les suivantes : Signer et Préremplir. |
|
Mode de remise
|
RecipientList.DeliveryMode | integer |
Indique le canal par lequel le code de demande de signature et le code d’accès ont été envoyés au destinataire. |
|
Code de numérotation
|
RecipientList.DialCode | string |
Code de numérotation du pays où la demande de signature et le code d’accès ont été envoyés. |
|
Code de pays
|
RecipientList.CountryCode | string |
Code du pays où la demande de signature et le code d’accès ont été envoyés. |
|
Numéro de portable
|
RecipientList.Mobile | string |
Numéro mobile du destinataire. |
|
Mobile Mode
|
RecipientList.MobileMode | integer |
Indique le canal mobile via lequel le code de demande de signature et le code d’accès ont été envoyés au destinataire. |
|
URL de signature
|
RecipientList.SigningUrl | string |
URL à utiliser par le destinataire pour accéder à l’enveloppe et la signer. |
|
Liste déroulante du code de numérotation
|
DialCodeDropdownList | string |
Liste déroulante du code de numérotation. |
|
Activer le message sur mobile
|
EnableMessageToMobile | string |
Activez message sur mobile. |
Obtenir AuthToken
Retourne un authToken à utiliser dans toutes les autres actions prises en charge par RSign.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ReferenceKey
|
ReferenceKey | True | string |
Identificateur unique de votre compte d’entreprise. |
|
EmailId
|
EmailId | True | string |
Adresse e-mail de votre compte RSign. |
|
Mot de passe
|
Password | True | password |
Mot de passe de votre compte RSign. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Message d’authentification
|
AuthMessage | string |
Message d’état de réponse. |
|
Jeton d’authentification
|
AuthToken | string |
Jeton d’authentification à utiliser dans d’autres actions RSign. |
|
Jeton d’actualisation
|
RefreshToken | string |
Jeton d’actualisation. |
|
Le jeton d’actualisation expire
|
RefreshTokenExpires | string |
Date d’expiration du jeton d’actualisation actuel. |
|
Le jeton d’authentification expire
|
AuthTokenExpires | string |
Date d’expiration du jeton d’authentification actuel. |
|
ID d’e-mail
|
EmailId | string |
E-mail de l’utilisateur authentifié. |
|
ID d’API
|
ApiId | string |
ID d’API. |
Récupérer des documents d’enveloppe
Récupère la partie documents d’une enveloppe en fonction de son code d’enveloppe. Il récupère les documents d’origine et/ou les documents signés finals en fonction de l’état de l’enveloppe.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Code d’enveloppe
|
EnvelopeCode | True | string |
Code de l’enveloppe à récupérer. |
|
Jeton d’authentification
|
AuthToken | True | string |
AuthToken récupéré à partir de l’action « Get AuthToken ». |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Statut
|
Status | boolean |
Indicateur de réussite de l’état. |
|
Code de statut
|
StatusCode | integer |
Code d’état de la réponse. |
|
Message
|
Message | string |
Description de l’état de la réponse. |
|
Message d’état
|
StatusMessage | string |
Message d’état de réponse. |
|
Code d’enveloppe
|
Data.EnvelopeCode | string |
Code d’enveloppe passé en tant que paramètre. |
|
Liste des documents
|
Data.DocumentList | array of object |
Liste des documents. |
|
Type de document
|
Data.DocumentList.DocumentType | string |
Type de la pièce jointe. |
|
Nom de fichier
|
Data.DocumentList.FileName | string |
Nom du fichier. |
|
Descriptif
|
Data.DocumentList.Description | string |
Description du document. |
|
Tableau d’octets
|
Data.DocumentList.ByteArray | string |
Fichier au format Base64. |
|
Informations supplémentaires
|
Data.DocumentList.AdditionalInfo | string |
Informations supplémentaires. |
|
Description de la pièce jointe
|
Data.DocumentList.AttachmentDescription | string |
Description informative du contenu du fichier. |
|
Lire moi
|
Data.ReadMe | string |
Fichier texte au format Base64 qui indique le nom du document signé et le fichier d’origine. |
|
Zip combiné
|
Data.CombinedZip | string |
Fichier zip contenant tous les documents de l’enveloppe. |
|
Nombre total
|
TotalCount | integer |
Nombre total. |
|
Téléchargements de pièces jointes existent
|
IsAttachmentUploadsExist | string |
Téléchargements de pièces jointes existent. |
Récupérer des informations de modèle
Récupère les informations sur un modèle ou une règle en fonction de son code. Parmi les informations retournées, citons le nom du modèle, les documents et les rôles définis.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Code de modèle
|
TemplateCode | True | string |
Code du modèle à récupérer. |
|
Jeton d’authentification
|
AuthToken | True | string |
AuthToken récupéré à partir de l’action « Get AuthToken ». |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Code de statut
|
StatusCode | integer |
Code d’état de la réponse. |
|
Message d’état
|
StatusMessage | string |
Message d’état de réponse. |
|
Message
|
Message | string |
Description de l’état de la réponse. |
|
ID de modèle
|
TemplateId | string |
ID de modèle. |
|
ID de modèle
|
TemplateBasicInfo.TemplateId | string |
ID de modèle. |
|
Code de modèle
|
TemplateBasicInfo.TemplateCode | integer |
Code de modèle à utiliser dans d’autres actions. |
|
E-mail utilisateur
|
TemplateBasicInfo.UserEmail | string |
E-mail du propriétaire de l’utilisateur du modèle. |
|
Nom du modèle
|
TemplateBasicInfo.TemplateName | string |
Nom du modèle. |
|
Description du modèle
|
TemplateBasicInfo.TemplateDescription | string |
Description du modèle. |
|
Est statique
|
TemplateBasicInfo.IsStatic | string |
Indique si le modèle peut être modifié ou non. |
|
Date d’expiration
|
TemplateBasicInfo.ExpiryDate | string |
Date d’expiration du modèle. |
|
Date de création
|
TemplateBasicInfo.CreatedDate | string |
Date de création du modèle. |
|
Date de dernière modification
|
TemplateBasicInfo.LastModifiedDate | string |
Date à laquelle le modèle a été modifié pour la dernière fois. |
|
Sujet
|
TemplateBasicInfo.Subject | string |
Objet du modèle d’e-mail. |
|
Corps
|
TemplateBasicInfo.Body | string |
Corps du modèle d’e-mail. Codé au format HTML. |
|
Nom du type
|
TemplateBasicInfo.TypeName | string |
Type de modèle (valeurs possibles : modèle, règle). |
|
Liste des documents
|
TemplateBasicInfo.DocumentList | array of object |
Liste des documents. |
|
Document Id
|
TemplateBasicInfo.DocumentList.DocumentId | string |
ID de la partie de document du modèle. |
|
Nom du document
|
TemplateBasicInfo.DocumentList.DocumentName | string |
Nom de la partie de document du modèle. |
|
Commande
|
TemplateBasicInfo.DocumentList.Order | integer |
Ordre de la partie document du modèle dans sa liste de documents. |
|
Détails du contenu du document
|
TemplateBasicInfo.DocumentList.documentContentDetails | array of object |
Détails du contenu du document. |
|
Identifiant de contrôle
|
TemplateBasicInfo.DocumentList.documentContentDetails.ControlID | string |
ID interne du contrôle utilisé dans le document. |
|
Nom du contrôle
|
TemplateBasicInfo.DocumentList.documentContentDetails.ControlName | string |
Nom du contrôle utilisé dans le document. |
|
Id html de contrôle
|
TemplateBasicInfo.DocumentList.documentContentDetails.ControlHtmlID | string |
ID HTML du contrôle utilisé dans le document. |
|
Nom du groupe
|
TemplateBasicInfo.DocumentList.documentContentDetails.GroupName | string |
Nom du groupe qui contient le contrôle. |
|
Étiquette
|
TemplateBasicInfo.DocumentList.documentContentDetails.Label | string |
Nom du contrôle à afficher dans le document. |
|
Page Non
|
TemplateBasicInfo.DocumentList.documentContentDetails.PageNo | integer |
Page du document dans lequel se trouve le contrôle. |
|
Obligatoire
|
TemplateBasicInfo.DocumentList.documentContentDetails.Required | boolean |
Indique si le contrôle est requis ou non. |
|
Valeur de contrôle
|
TemplateBasicInfo.DocumentList.documentContentDetails.ControlValue | string |
Valeur préremplie du contrôle. |
|
ID de rôle
|
TemplateBasicInfo.DocumentList.documentContentDetails.RoleId | string |
ID du rôle qui doit remplir le contrôle. |
|
Nom du rôle
|
TemplateBasicInfo.DocumentList.documentContentDetails.RoleName | string |
Nom du rôle qui doit remplir le contrôle. |
|
Sélectionner les options de contrôle
|
TemplateBasicInfo.DocumentList.documentContentDetails.SelectControlOptions | array of string |
Sélectionnez Options de contrôle. |
|
Liste des rôles de modèle
|
TemplateBasicInfo.TemplateRoleList | array of object |
Liste des destinataires. |
|
ID de rôle
|
TemplateBasicInfo.TemplateRoleList.RoleID | string |
ID de la partie rôle de ce modèle. |
|
Nom du rôle
|
TemplateBasicInfo.TemplateRoleList.RoleName | string |
Nom de la partie de rôle de ce modèle. |
|
Commande
|
TemplateBasicInfo.TemplateRoleList.Order | integer |
Ordre dans lequel le rôle (destinataire) doit terminer le modèle. |
|
E-mail du destinataire
|
TemplateBasicInfo.TemplateRoleList.RecipientEmail | string |
E-mail prérempli de la partie destinataire de ce modèle. |
|
Nom destinataire
|
TemplateBasicInfo.TemplateRoleList.RecipientName | string |
Nom prérempli de la partie destinataire de ce modèle. |
|
ID de type de destinataire
|
TemplateBasicInfo.TemplateRoleList.RecipientTypeID | string |
ID interne du type de destinataire. |
|
ID destinataire
|
TemplateBasicInfo.TemplateRoleList.RecipientID | string |
ID de la partie destinataire de ce modèle. |
|
Type de destinataire
|
TemplateBasicInfo.TemplateRoleList.RecipientType | string |
Type de destinataire. |
|
Type de signataire Cc
|
TemplateBasicInfo.TemplateRoleList.CcSignerType | string |
Type de destinataire CC. |
|
Informations sur la culture
|
TemplateBasicInfo.TemplateRoleList.CultureInfo | string |
Il s’agit du langage de service de l’utilisateur au moment de la création du modèle/de la règle. |
|
Mode de remise
|
TemplateBasicInfo.TemplateRoleList.DeliveryMode | integer |
Indique le canal par lequel le code de demande de signature et le code d’accès ont été envoyés au destinataire. |
|
Code de numérotation
|
TemplateBasicInfo.TemplateRoleList.DialCode | string |
Code de numérotation du pays où la demande de signature et le code d’accès ont été envoyés. |
|
Code de pays
|
TemplateBasicInfo.TemplateRoleList.CountryCode | string |
Code du pays où la demande de signature et le code d’accès ont été envoyés. |
|
Numéro de portable
|
TemplateBasicInfo.TemplateRoleList.Mobile | string |
Numéro mobile du destinataire. |
|
Mobile Mode
|
TemplateBasicInfo.TemplateRoleList.MobileMode | integer |
Indique le canal mobile via lequel le code de demande de signature et le code d’accès ont été envoyés au destinataire. |
|
Adresse électronique
|
TemplateBasicInfo.TemplateRoleList.EmailAddress | string |
Adresse e-mail du destinataire. |
|
Activer le message sur mobile
|
TemplateBasicInfo.EnableMessageToMobile | boolean |
Activez message sur mobile. |
|
Date d’expiration du lien statique
|
TemplateBasicInfo.StaticLinkExpiryDate | string |
Date d’expiration de la liaison statique. |
|
Liste de modèles
|
TemplateList | string |
Liste de modèles. |
Récupérer l’état de l’enveloppe
Récupère l’état d’une enveloppe en fonction de son code d’enveloppe. Vous pouvez sélectionner un rapport détaillé ou résumé.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Jeton d’authentification
|
AuthToken | True | string |
AuthToken récupéré à partir de l’action « Get AuthToken ». |
|
EnvelopeCode
|
EnvelopeCode | True | string |
Code d’enveloppe. |
|
DetailOrSummary
|
DetailOrSummary | True | string |
Sélectionnez le type de rapport souhaité. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Statut
|
Status | boolean |
État de la demande. |
|
Code de statut
|
StatusCode | integer |
Code d’état de la réponse. |
|
Message
|
Message | string |
Description de l’état de la réponse. |
|
Message d’état
|
StatusMessage | string |
Message d’état de réponse. |
|
Liste des données d’enveloppe
|
Data | array of object | |
|
Code d’enveloppe
|
Data.EnvelopeCode | string |
ID de l’enveloppe. |
|
ID d’enveloppe
|
Data.EnvelopeID | string |
ID interne de l’enveloppe. |
|
Sujet
|
Data.Subject | string |
Objet de l’e-mail de l’enveloppe. |
|
État de l’enveloppe
|
Data.Status | string |
État de l’enveloppe demandée. |
|
IsEnvelopeComplete
|
Data.IsEnvelopeComplete | boolean |
Indique si l’enveloppe est terminée. |
|
Date d’envoi
|
Data.SentDate | string |
Date à laquelle l’enveloppe a été envoyée. |
|
DateDernièreModification
|
Data.LastModifiedDate | string |
Date de dernière modification. |
|
SenderName
|
Data.SenderName | string |
Nom de l’expéditeur. |
|
SenderEmail
|
Data.SenderEmail | string |
E-mail de l’expéditeur. |
|
Détails du destinataire
|
Data.RecipientDetails | array of object | |
|
ID destinataire
|
Data.RecipientDetails.RecipientID | string |
ID de la partie destinataire de l’enveloppe actuelle. |
|
ID de type de destinataire
|
Data.RecipientDetails.RecipientTypeID | string |
ID de type de la partie destinataire de l’enveloppe actuelle. |
|
Type de destinataire
|
Data.RecipientDetails.RecipientType | string |
Type de partie destinataire de l’enveloppe actuelle. Les valeurs possibles sont les suivantes : Signer et Préremplir. |
|
Nom destinataire
|
Data.RecipientDetails.RecipientName | string |
Nom du destinataire. |
|
Messagerie électronique
|
Data.RecipientDetails.Email | string |
Adresse e-mail du destinataire. |
|
Commande
|
Data.RecipientDetails.Order | integer |
Ordre dans lequel le destinataire doit accéder pour compléter l’enveloppe. |
|
StatusID
|
Data.RecipientDetails.StatusId | string |
ID d’état. |
|
État de signature
|
Data.RecipientDetails.SigningStatus | string |
État de la signature pour le destinataire de l’enveloppe. |
|
Date de dernière modification
|
Data.RecipientDetails.LastModifiedDate | string |
Date de dernière modification. |
|
Code de référence
|
Data.ReferenceCode | string |
Partie de code de référence de l’enveloppe actuelle. |
|
Adresse e-mail de référence
|
Data.ReferenceEmail | string |
Référencez la partie e-mail de l’enveloppe actuelle. |
|
TotalCount
|
TotalCount | integer |
Quantité totale d’enveloppes correspondant aux critères demandés. |
|
IsAttachmentUploadsExist
|
IsAttachmentUploadsExist | string |
Téléchargements de pièces jointes existent. |