Signe Oodrive (préversion)
Connectez-vous et utilisez le service d’un signe Oodrive via vos flux de travail.
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 | Signe Oodrive |
| URL | https://www.oodrive.com/products/oodrive-sign/ |
| Messagerie électronique | support-sign@oodrive.com |
| Métadonnées du connecteur | |
|---|---|
| Éditeur | Signe Oodrive |
| Site internet | https://www.oodrive.com/products/oodrive-sign/ |
| Politique de confidentialité | https://www.oodrive.com/privacy-policy/ |
| Catégories | Opérations informatiques ; Productivité |
Le connecteur oodrive Sign vous permet d’automatiser les tâches et de gérer facilement vos processus sur l’écosystème de signature électronique. Le flux de travail automatisé peut être conçu pour, par exemple, créer un contrat par un modèle, ajouter automatiquement des destinataires et envoyer le contrat pour signature. Vous pouvez également gérer tous vos bundles, destinataires, paramètres clés et bien plus encore. Il offre aux clients la possibilité de réduire le temps utilisé pour effectuer des actions manuelles après tout le processus de signature. Toutes les fonctionnalités disponibles dans l’application web peuvent être reproduites dans Power Automate à l’aide du connecteur.
Prerequisites
Vous avez besoin d’un compte avec un plan payant sur le service Oodrive Sign.
Comment obtenir des informations d’identification
Vous devez également obtenir votre jeton d’API, qui peut être demandé au service de support ou qu’il peut être récupéré dans votre courrier électronique accueillant qui a été envoyé à votre boîte aux lettres lorsque vous avez appliqué au service de connexion.
Note: If you are a employee, you can get the token by contacting your IT service.
Bien démarrer avec votre connecteur
Pour commencer à utiliser le connecteur, vous devez d’abord ouvrir Power Automate avec votre compte Power Platform.
Note: you'll need to be premium on Power Automate in order to use the connector.
Procédez comme suit pour créer un flux de travail et utiliser notre connecteur :
- Dans votre environnement Power Automate, cliquez sur l’onglet « Créer ».
- Choisissez « Flux cloud automatisé » ou « Flux cloud instantané », comme vous en avez besoin.
- Donnez un nom à votre nouveau flux de travail, puis sélectionnez un déclencheur adapté à vos besoins. Vous pouvez utiliser l’un des signs Oodrive.
- Commencez à utiliser le connecteur en ajoutant une action à partir de celle-ci, simplement en recherchant « Oodrive Sign » dans le catalogue.
- La première fois que vous ajoutez une action ou un déclencheur à partir de notre connecteur, Power Automate vous demande de vous connecter à votre environnement : il s’agit de ce que vous allez utiliser le jeton d’API fourni par nous.
- Ensuite, cliquez sur se connecter : tout est fait, vous pouvez utiliser autant d’actions à partir du connecteur souhaité.
Problèmes connus et limitations
Pour les problèmes liés à Oodrive Sign, contactez le service de support.
Erreurs courantes et solutions
ERREUR HTTP 404
En règle générale, lorsque vous recevez une erreur 404 avec oodrive Sign’s, il indique que la ressource que vous essayez de trouver n’existe pas sur votre environnement. En règle générale, il peut s’agir d’une erreur dans l’ID fourni pour un contrat spécifique ou un destinataire spécifique, qui n’existe pas. Pour résoudre le problème, essayez d’utiliser votre action avec un ID connu de la ressource que vous essayez d’obtenir.
ERREUR HTTP 501
L’erreur HTTP 501 indique que le service oodrive Sign n’a pas bien reconnu votre demande ou que vous avez passé un type incorrect de données au service. Essayez d’examiner, en lisant la documentation du signe, sur les données que vous transmettez à votre action ou déclencheur.
Questions fréquentes (FAQ)
1. Comment puis-je charger un document dans un contrat spécifique ?
À l’aide de l’action « Charger un document et l’attacher à un contrat », vous pouvez facilement charger un fichier pdf enregistré à distance.
La première étape nécessite d’obtenir le contenu du fichier que vous souhaitez charger. Vous pouvez l’obtenir à l’aide de nombreux connecteurs. Par exemple, le contenu du fichier peut être récupéré à l’aide de l’action « Obtenir le contenu du fichier » du connecteur SharePoint.
- Obtenez le contenu du fichier que vous souhaitez charger en tant que document pour un contrat spécifique. Dans cet exemple, nous utilisons l’action « Obtenir le contenu du fichier » du connecteur SharePoint Online.
- Ensuite, ajoutez une nouvelle action « compose ». Utilisez le corps de sortie de l’action « Obtenir le contenu du fichier » comme entrée pour la composition 1.
- Ajoutez l’action appelée « Charger un document et l’ajouter à un contrat » à partir du connecteur de signature Oodrive.
- Dans l’entrée « ID de contrat », spécifiez l’ID du contrat pour lequel vous souhaitez que votre document soit attaché.
- Dans l’entrée « Files », insérez la sortie de l’action « Compose » précédente.
- Dans l’entrée « Fichiers (nom de fichier) », insérez un nom pour le document qui sera chargé.
- Vous avez terminé de charger le document !
2. Puis-je voir tous les contrats à l’intérieur de mon environnement ?
Si votre jeton est un jeton « administrateur », oui. Sinon, vous n’afficherez que le contrat auquel vous avez accès normalement.
3. J’ai une suggestion pour le connecteur. Où puis-je le soumettre ?
Vous pouvez envoyer des suggestions sur le connecteur en contactant le service de support. Nous serons vraiment reconnaissants de votre contribution !
Création d’une connexion
Le connecteur prend en charge les types d’authentification suivants :
| Par défaut | Paramètres de création de connexion. | Toutes les régions | Impossible à partager |
Faire défaut
Applicable : Toutes les régions
Paramètres de création de connexion.
Ce n’est pas une connexion partageable. Si l’application Power est partagée avec un autre utilisateur, un autre utilisateur sera invité à créer explicitement une nouvelle connexion.
| Nom | Type | Descriptif | Obligatoire |
|---|---|---|---|
| Clé d’API | securestring | Clé API pour cette API | Vrai |
Limitations
| Nom | Appels | Période de renouvellement |
|---|---|---|
| Appels d’API par connexion | 100 | 60 secondes |
Actions
| Ajouter un contrat à un bundle |
Ajoutez un contrat existant à un bundle existant. |
| Ajouter un destinataire à un contrat |
Attachez un destinataire existant au contrat. |
| Arrêter la transaction d’un contrat |
Arrêtez la transaction du contrat pour pouvoir modifier les documents de contrat et/ou les signataires. |
| Arrêter une transaction groupée |
Arrêtez une transaction groupée. |
| Charger un document et l’attacher à un contrat |
Chargez un document dans l’environnement et attachez-le à un contrat spécifique. |
| Charger une pièce jointe et l’ajouter à un contrat |
Chargez une nouvelle pièce jointe dans l’environnement et attachez-la à un contrat spécifique. |
| Créer un bundle |
Créez un bundle avec au moins un contrat existant. |
| Créer un contrat |
Créez un contrat dans l’environnement. |
| Créer un contrat et l’envoyer pour signature |
Tout en une seule opération. Créez un contrat, ajoutez des destinataires, des documents et envoyez-le pour la signature aux destinataires. |
| Envoyer un bundle pour la signature |
Envoyez un bundle pour la signature. |
| Envoyer un contrat à signer |
Envoyez un contrat spécifique et tous ses documents à signer par les destinataires. |
| Obtenir des signatures d’un contrat |
Répertoriez toutes les informations sur les signatures d’un contrat spécifique. |
| Obtenir la liste de tous les contrats |
Récupérez tous les contrats de la licence associée. |
| Obtenir l’état d’un contrat |
Vérifiez l’état d’un contrat spécifique. |
| Obtenir un contrat spécifique |
Récupérez les métadonnées d’un contrat spécifique. |
| Obtenir un destinataire spécifique |
Récupérez un destinataire spécifique dans la liste enregistrée des destinataires de l’environnement actuel. |
| Renvoyer l’e-mail de notification à tous les destinataires |
Envoyez un e-mail de notification à tous les destinataires d’un contrat spécifique. |
| Renvoyer un e-mail de notification à un destinataire |
Envoyez un e-mail de notification à un destinataire spécifique pour le contrat. |
| Retirer un bundle |
Retirez tout contrat dans un ensemble. |
| Retirer un contrat |
Définissez l’état du contrat sur ABANDON, même si le contrat a été envoyé pour signature. |
| Répertorier les contrats d’un bundle |
Récupérez tous les contrats d’un bundle spécifique. |
| Répertorier les destinataires d’un contrat |
Récupérez tous les destinataires d’un contrat spécifique. |
| Répertorier les documents du contrat |
Récupérez tous les documents liés à un contrat. |
| Répertorier tous les destinataires |
Récupérez tous les destinataires associés à la licence actuelle. |
| Répertorier tous les périmètres |
Récupérez tous les périmètres associés à l’environnement connecté. |
| Supprimer un destinataire pour un contrat |
Supprimez un destinataire d’un contrat, par son destinataire pour l’ID de contrat. Plus d’informations dans la documentation. |
| Télécharger le document signé d’un contrat |
Récupérez un fichier pdf à partir du document signé du contrat. |
| Télécharger le fichier de preuve d’un contrat |
Téléchargez le fichier de preuve du contrat. |
| Télécharger les documents du contrat |
Récupérez un fichier PDF qui contient tous les documents d’un contrat. |
| Valider des contrats dans un bundle |
Contre-signer (valider) tous les contrats d’un bundle. |
| Valider un contrat |
Validez (contre-signature) un contrat. |
Ajouter un contrat à un bundle
Ajoutez un contrat existant à un bundle existant.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de l’offre groupée
|
id | True | string |
ID du bundle à ajouter un contrat. |
|
ID de contrat
|
contract_id | integer |
ID du contrat à ajouter à l’offre groupée. |
Retours
- Corps
- BundleResponse
Ajouter un destinataire à un contrat
Attachez un destinataire existant au contrat.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de contrat
|
id | True | string |
ID du contrat pour joindre le destinataire. |
|
ID du destinataire
|
recipient_id | integer |
ID du destinataire à attacher au contrat. |
|
|
Mode signature
|
signature_mode | integer |
Mode de signature. Pour plus d’informations, consultez la documentation. |
|
|
Titre du message
|
message_title | string |
Titre du message à envoyer par e-mail s’il en existe un. |
|
|
Contenu du message
|
message_body | string |
Corps du message à envoyer par e-mail s’il en existe un. |
|
|
Classement
|
rank | integer |
Place du destinataire dans le processus de signature. Rank et Smartrole s’excluent mutuellement. Choisissez un seul d’entre eux ou pas du tout. |
|
|
Nom du rôle intelligent
|
smartrole | string |
Rôle intelligent à donner au destinataire. Pour plus d’informations, consultez la documentation. |
|
|
Mode de transport
|
transport_mode | integer |
Mode de transport de la signature. Pour plus d’informations, consultez la documentation. |
Retours
- response
- array of ContractRecipient
Arrêter la transaction d’un contrat
Arrêtez la transaction du contrat pour pouvoir modifier les documents de contrat et/ou les signataires.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de contrat
|
id | True | string |
ID du contrat à arrêter. |
|
Force
|
force | boolean |
Forcer la fermeture de la transaction même si les signataires ont déjà signé. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
réussir
|
succeed | boolean |
Spécifiez si le contrat a été annulé. |
Arrêter une transaction groupée
Arrêtez une transaction groupée.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de l’offre groupée
|
id | True | string |
ID de l’offre groupée pour arrêter la transaction. |
|
Forcer la fermeture
|
force | boolean |
Forcer la fermeture de la transaction, même si les signataires ont déjà signé. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
réussir
|
succeed | boolean |
Indique que l’offre groupée a été correctement arrêtée. |
Charger un document et l’attacher à un contrat
Chargez un document dans l’environnement et attachez-le à un contrat spécifique.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de contrat
|
id | True | string |
ID du contrat auquel attacher un nouveau document. |
|
Fichier
|
file | file |
Fichier binaire à charger. |
Retours
- response
- array of DocumentAdded
Charger une pièce jointe et l’ajouter à un contrat
Chargez une nouvelle pièce jointe dans l’environnement et attachez-la à un contrat spécifique.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de contrat
|
id | True | string |
ID du contrat pour ajouter une pièce jointe. |
|
ID de définition de contrat
|
contract_definition_id | integer |
ID de définition de contrat défini dans votre environnement. La valeur par défaut est pdfadhoc. |
|
|
Nom de la définition d’option
|
option_definition_name | string |
Nom de la définition. |
|
|
Fichiers
|
file | array |
Fichiers à ajouter en tant que pièces jointes |
Retours
- Corps
- AppendixAdded
Créer un bundle
Créez un bundle avec au moins un contrat existant.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de contrat
|
contract_id | integer |
ID du premier contrat groupé. |
|
|
Mêmes signataires
|
same_signatories | boolean |
Défini sur false si les contrats dans le bundle n’ont pas le même ensemble de signataires. |
Retours
- Corps
- BundleResponse
Créer un contrat
Créez un contrat dans l’environnement.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Nom du contrat
|
name | string |
Nom du contrat nouvellement créé (obligatoire). |
|
|
ID de définition de contrat
|
contract_definition_id | integer |
ID de la définition du contrat. Reportez-vous à la variable d’API de votre licence. Valeur par défaut du modèle AdHoc PDF. |
|
|
E-mail du fournisseur
|
vendor_email | string |
E-mail du propriétaire de licence. |
|
|
Date de création
|
date | integer |
Date du contrat. Valeur par défaut : Date.Now(). Doit être en millisecondes. |
|
|
Titre du message
|
message_title | string |
Objet de l’e-mail envoyé. Laissez vide pour un titre par défaut. |
|
|
Corps du message
|
message_body | string |
Corps de l’e-mail envoyé. Laissez vide pour un message par défaut. |
|
|
Continuer à bouger
|
keep_on_move | boolean |
Activer ou non la signature hors ligne sur un appareil mobile |
|
|
Fermeture automatique
|
auto_close | integer |
Spécifiez si la contre-signature est effectuée sans intervention humaine. |
|
|
Séquentiel
|
sequential | boolean |
Spécifiez s’il est séquentiel ou non. |
|
|
Numéro de client
|
customer_number | string |
Pour la compatibilité des applications mobiles héritées uniquement. |
|
|
Liste du périmètre
|
perimeters | array of string | ||
|
ID de définition d’élément
|
element_definition_id | integer |
ID de définition de l’élément. |
|
|
Valeur
|
value | string |
Valeur de l’option d’élément. |
|
|
ID de propriété
|
id | integer |
ID de la propriété personnalisée. |
|
|
Clé de propriété
|
key | string |
Clé de la propriété personnalisée. |
|
|
Espace réservé de propriété
|
placeholder | string |
Étiquette affichée au destinataire lorsqu’elle est invitée à renseigner la propriété. |
|
|
Valeur de propriété
|
value | string |
Valeur de la propriété personnalisée. |
|
|
ID du contrat de propriété
|
contract_id | integer |
ID du contrat associé à cette propriété personnalisée. |
|
|
La propriété est requise
|
to_fill_by_user | boolean |
Spécifiez si l’utilisateur doit remplir la propriété ou non. |
|
|
Type de propriété
|
field_type | string |
Spécifiez le type de la propriété personnalisée. Plus d’informations dans la documentation. |
|
|
Options de propriété
|
input_filter | string |
Liste des choix possibles pour la propriété. |
|
|
La propriété est utilisée par le contrat
|
used_by_contract | boolean |
Défini sur true si les informations doivent apparaître sur le document de contrat. |
|
|
La propriété est requise
|
required | boolean |
Spécifiez si la propriété est requise ou non. |
Retours
- Corps
- Contract
Créer un contrat et l’envoyer pour signature
Tout en une seule opération. Créez un contrat, ajoutez des destinataires, des documents et envoyez-le pour la signature aux destinataires.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de contrat
|
contract_id | integer |
ID du contrat. |
|
|
Date de création
|
date | integer |
Date à laquelle le contrat a été créé. |
|
|
Adresse de messagerie du fournisseur
|
vendor_email | string |
Adresse e-mail du propriétaire de la licence Oodrive. |
|
|
ID de définition de contrat
|
contract_definition_id | integer |
ID de la définition de contrat utilisée pour ce contrat. |
|
|
Objet du message
|
message_title | string |
Objet du courrier électronique lorsqu’il est envoyé pour signature. |
|
|
Corps du message
|
message_body | string |
Corps du courrier électronique lorsqu’il est envoyé pour signature. |
|
|
Nom du contrat
|
name | True | string |
Nom du document principal du contrat. |
|
Signature hors connexion activée
|
keep_on_move | boolean |
Déterminez si la signature hors connexion sur l’appareil mobile est activée. |
|
|
Date de fermeture du contrat
|
closed_date | integer |
Date de fermeture du contrat, le cas échéant. |
|
|
Raison annulée du contrat
|
canceled_reason | string |
Raison de l’annulation, le cas échéant. |
|
|
Fermeture automatique activée
|
auto_close | integer |
Spécifiez si le contrat sera contre-signé automatiquement ou si vous avez besoin d’une intervention humaine. |
|
|
Est supprimé
|
deleted | integer |
Spécifiez si le contrat a été supprimé ou non. |
|
|
Clé de périmètre
|
Perimeters | string |
Clé du périmètre. |
|
|
ID d’option
|
id | integer |
ID de l’option du contrat. |
|
|
ID de contrat
|
contract_id | integer |
ID du contrat lié à cette option. |
|
|
ID de définition d’élément
|
element_definition_id | integer |
ID de la définition d’élément de l’option. |
|
|
Minuteur de synchronisation
|
sync_timer | integer |
Minuteur utilisé pour le problème de synchronisation. |
|
|
Valeur d’option
|
value | string |
Valeur de l’option. |
|
|
Dernière modification
|
last_modification_place | string |
Indique où la dernière modification a eu lieu. |
|
|
Contrôle d’option
|
control | string |
Champ de contrôle. |
|
|
ID de propriété
|
id | integer |
ID de la propriété personnalisée. |
|
|
Clé de propriété
|
key | string |
Clé de la propriété personnalisée. |
|
|
Espace réservé de propriété
|
placeholder | string |
Étiquette affichée au destinataire lorsqu’elle est invitée à renseigner la propriété. |
|
|
Valeur de propriété
|
value | string |
Valeur de la propriété personnalisée. |
|
|
ID du contrat de propriété
|
contract_id | integer |
ID du contrat associé à cette propriété personnalisée. |
|
|
La propriété est requise
|
to_fill_by_user | boolean |
Spécifiez si l’utilisateur doit remplir la propriété ou non. |
|
|
Type de propriété
|
field_type | string |
Spécifiez le type de la propriété personnalisée. Plus d’informations dans la documentation. |
|
|
Options de propriété
|
input_filter | string |
Liste des choix possibles pour la propriété. |
|
|
La propriété est utilisée par le contrat
|
used_by_contract | boolean |
Défini sur true si les informations doivent apparaître sur le document de contrat. |
|
|
La propriété est requise
|
required | boolean |
Spécifiez si la propriété est requise ou non. |
|
|
Signature Mode
|
signature_mode | integer | ||
|
prénom
|
firstname | string | ||
|
nom de famille
|
lastname | string | ||
|
Messagerie électronique
|
string | |||
|
cell_phone
|
cell_phone | string | ||
|
pdfparts
|
pdfparts | string | ||
|
annexes
|
appendixparts | string |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
destinataires
|
recipients | array of Recipient | |
|
recipientForcontract
|
recipientForcontract | array of ContractRecipient | |
|
contrat
|
contract | Contract | |
|
PDF
|
pdfparts | array of object |
Tableau de PDF lié au contrat. |
|
PDF ID
|
pdfparts.id | integer |
ID du fichier PDF. |
|
Classement PDF
|
pdfparts.rank | integer |
Classement du fichier PDF. |
|
Has SmartFields
|
pdfparts.has_smart_field | boolean |
Spécifiez s’il existe des champs intelligents dans le contrat. |
|
Taille PDF
|
pdfparts.size | integer |
Taille du document. |
|
Nom de fichier
|
pdfparts.filename | string |
Nom du fichier pdf. |
|
annexes
|
appendixparts | array of object | |
|
pièce d'identité
|
appendixparts.id | integer |
Envoyer un bundle pour la signature
Envoyez un bundle pour la signature.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de l’offre groupée
|
id | True | string |
ID du bundle à envoyer pour signature. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
réussir
|
succeed | boolean |
Indique si la transaction a été envoyée ou non. |
Envoyer un contrat à signer
Envoyez un contrat spécifique et tous ses documents à signer par les destinataires.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de contrat
|
id | True | string |
ID du contrat à envoyer pour signature. |
Retours
- Corps
- Transaction
Obtenir des signatures d’un contrat
Répertoriez toutes les informations sur les signatures d’un contrat spécifique.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de contrat
|
id | True | string |
ID du contrat pour répertorier toutes les signatures. |
Retours
Obtenir la liste de tous les contrats
Récupérez tous les contrats de la licence associée.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Taille du tableau retourné
|
size | integer |
Taille maximale du tableau de contrat retourné. |
|
|
Ignorer les premiers n contrats
|
offset | integer |
Numéro de séquence du contrat qui sera ignoré. |
|
|
Afficher les propriétés du contrat
|
get_properties | boolean |
Si la valeur est true, les propriétés de contrat sont répertoriées dans la réponse. |
|
|
Afficher les périmètres de contrat
|
get_perimeters | boolean |
Si la valeur est true, les périmètres de contrat sont répertoriés dans la réponse. |
|
|
Créé avant
|
before | integer |
Répertorie le contrat créé avant la date donnée. |
|
|
Créé après
|
after | integer |
Répertorie le contrat créé après la date donnée. |
|
|
Uniquement avec le périmètre
|
perimeter | string |
Répertorier les contrats uniquement dans un périmètre donné. |
|
|
Uniquement avec l’état
|
status | array |
Récupérez le contrat uniquement avec l’état spécifié. |
Retours
- Objets
- ArrayOfContract
Obtenir l’état d’un contrat
Vérifiez l’état d’un contrat spécifique.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de contrat
|
id | True | integer |
ID du contrat pour récupérer l’état. |
Retours
- Corps
- Transaction
Obtenir un contrat spécifique
Récupérez les métadonnées d’un contrat spécifique.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de contrat
|
id | True | string |
ID de contrat à récupérer. |
Retours
- Corps
- Contract
Obtenir un destinataire spécifique
Récupérez un destinataire spécifique dans la liste enregistrée des destinataires de l’environnement actuel.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID du destinataire
|
id | True | string |
ID du destinataire à récupérer. |
Retours
- Corps
- Recipient
Renvoyer l’e-mail de notification à tous les destinataires
Envoyez un e-mail de notification à tous les destinataires d’un contrat spécifique.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de contrat
|
id | True | string |
ID du contrat pour renvoyer la notification. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
réussir
|
succeed | boolean |
Spécifiez si la notification a été envoyée à nouveau. |
Renvoyer un e-mail de notification à un destinataire
Envoyez un e-mail de notification à un destinataire spécifique pour le contrat.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de contrat
|
id | True | string |
ID du contrat pour renvoyer la notification. |
|
Destinataire de l’ID de contrat
|
cfc_id | True | string |
ID du destinataire de l’objet de contrat à envoyer une notification. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
réussir
|
succeed | boolean |
Spécifiez si la notification a été envoyée à nouveau. |
Retirer un bundle
Retirez tout contrat dans un ensemble.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de l’offre groupée
|
id | True | string |
ID de l’offre groupée pour retirer tout contrat. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
réussir
|
succeed | boolean |
Indique si l’offre groupée a été retirée. |
Retirer un contrat
Définissez l’état du contrat sur ABANDON, même si le contrat a été envoyé pour signature.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de contrat
|
id | True | string |
ID du contrat à retirer. |
|
Reason
|
reason | string |
La raison du retrait. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
réussir
|
succeed | boolean |
Spécifiez si le contrat a été annulé. |
Répertorier les contrats d’un bundle
Récupérez tous les contrats d’un bundle spécifique.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de l’offre groupée
|
id | True | string |
ID du bundle à partir duquel récupérer des contrats. |
Retours
- response
- array of ContractInBundle
Répertorier les destinataires d’un contrat
Récupérez tous les destinataires d’un contrat spécifique.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de contrat
|
id | True | string |
ID du contrat pour récupérer tous les destinataires. |
Retours
- response
- array of ContractRecipient
Répertorier les documents du contrat
Récupérez tous les documents liés à un contrat.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de contrat
|
id | True | string |
ID du contrat pour récupérer des documents. |
Retours
- response
- array of DocumentAdded
Répertorier tous les destinataires
Récupérez tous les destinataires associés à la licence actuelle.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Taille
|
size | integer |
Taille maximale du tableau retourné. |
|
|
Décalage
|
offset | integer |
Numéro de séquence du premier destinataire répertorié. |
|
|
Périmètre
|
perimeter | string |
Recherchez uniquement dans le périmètre donné. |
|
|
Obtenir des propriétés personnalisées
|
get_custom_props | boolean |
Répertorier les propriétés personnalisées des destinataires (augmente le temps de réponse). |
|
|
Obtenir des périmètres
|
get_perimeters | boolean |
Répertorier les périmètres du destinataire dans les réponses (augmente le temps de réponse). |
|
|
Nom de famille de filtre (contient)
|
name | string |
Filtrez sur le nom de famille. |
|
|
Filtrer l’e-mail (contient)
|
string |
Filtrez sur l’e-mail. |
Retours
- Destinataires
- array of Recipient
Répertorier tous les périmètres
Récupérez tous les périmètres associés à l’environnement connecté.
Retours
- response
- array of Perimeter
Supprimer un destinataire pour un contrat
Supprimez un destinataire d’un contrat, par son destinataire pour l’ID de contrat. Plus d’informations dans la documentation.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Destinataire de l’ID de contrat
|
cfc_id | True | string |
ID du destinataire de l’objet de contrat à supprimer. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
réussir
|
succeed | boolean |
Spécifiez s’il a été supprimé avec succès. |
Télécharger le document signé d’un contrat
Récupérez un fichier pdf à partir du document signé du contrat.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de contrat
|
id | True | integer |
ID du contrat qui contient des documents. |
|
Nom de fichier
|
filename | string |
Nom que vous souhaitez donner au document téléchargé. |
Retours
Contenu binaire du fichier pdf.
- Fichier binaire de document
- file
Télécharger le fichier de preuve d’un contrat
Téléchargez le fichier de preuve du contrat.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de contrat
|
id | True | string |
ID du contrat pour télécharger le fichier de preuve. |
|
Nom du fichier de sortie
|
filename | string |
Nom du fichier qui sera téléchargé. |
Retours
- response
- file
Télécharger les documents du contrat
Récupérez un fichier PDF qui contient tous les documents d’un contrat.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de contrat
|
id | True | string |
ID du contrat pour récupérer le fichier pdf. |
|
Nom du fichier de sortie
|
filename | string |
Nom du fichier qui sera téléchargé. |
Retours
- Fichier binaire de document PDF
- file
Valider des contrats dans un bundle
Contre-signer (valider) tous les contrats d’un bundle.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de l’offre groupée
|
id | True | string |
ID de l’offre groupée pour valider tout le contrat. |
|
Forcer la validation
|
force | boolean |
Forcer la validation des contrats si certains signataires n’ont pas encore signé (ou ont refusé de signer). |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
|
array of object | ||
|
date
|
date | string |
Date de fermeture. |
|
ID de contrat
|
id | string |
ID du contrat arrêté. |
Valider un contrat
Validez (contre-signature) un contrat.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de contrat
|
id | True | string |
ID du contrat à valider. |
|
Force
|
force | boolean |
Spécifiez si la validation du contrat doit être forcée, même si certains signataires n’ont pas encore signé. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Validation Date
|
date | string |
Date de validation. |
|
Transaction ID
|
id | string |
ID de transaction de l’autorité de certification. |
Déclencheurs
| Quand l’état d’un contrat change |
Cette opération est déclenchée chaque fois que l’état d’un contrat a changé. |
Quand l’état d’un contrat change
Cette opération est déclenchée chaque fois que l’état d’un contrat a changé.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
descriptif
|
description | string |
descriptif |
|
|
events
|
events | array of string |
events |
|
|
contractDefinition
|
contractDefinition | array of integer |
contractDefinition |
|
|
périmètre
|
perimeter | array of integer |
périmètre |
|
|
concernedUserEmail
|
concernedUserEmail | string |
concernedUserEmail |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
type
|
type | string |
type |
|
contractId
|
contractId | integer |
contractId |
|
horodatage
|
timestamp | integer |
horodatage |
|
contractStatus
|
contractStatus | string |
contractStatus |
Définitions
ArrayOfContract
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Objets
|
Contract |
Contrat
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID de contrat
|
contract_id | integer |
ID du contrat. |
|
Date de création
|
date | integer |
Date à laquelle le contrat a été créé. |
|
Jeton de document
|
document_token | string |
Jeton du document principal du contrat. |
|
Adresse de messagerie du fournisseur
|
vendor_email | string |
Adresse e-mail du propriétaire de la licence Oodrive. |
|
Est fermé
|
closed | boolean |
Spécifiez si le contrat est fermé ou non. |
|
État du contrat
|
status | string |
État actuel du contrat. |
|
ID de définition de contrat
|
contract_definition_id | integer |
ID de la définition de contrat utilisée pour ce contrat. |
|
Objet du message
|
message_title | string |
Objet du courrier électronique lorsqu’il est envoyé pour signature. |
|
Corps du message
|
message_body | string |
Corps du courrier électronique lorsqu’il est envoyé pour signature. |
|
Nom du contrat
|
name | string |
Nom du document principal du contrat. |
|
Signature hors connexion activée
|
keep_on_move | boolean |
Déterminez si la signature hors connexion sur l’appareil mobile est activée. |
|
Date de fermeture du contrat
|
closed_date | integer |
Date de fermeture du contrat, le cas échéant. |
|
Raison annulée du contrat
|
canceled_reason | string |
Raison de l’annulation, le cas échéant. |
|
Numéro de version du contrat
|
version_number | integer |
Numéro de version du contrat. |
|
Taille du contrat
|
size | integer |
Taille complète du contrat. |
|
Fermeture automatique activée
|
auto_close | integer |
Spécifiez si le contrat sera contre-signé automatiquement ou si vous avez besoin d’une intervention humaine. |
|
Est supprimé
|
deleted | integer |
Spécifiez si le contrat a été supprimé ou non. |
|
Périmètres
|
perimeters | array of ContractPerimeterKey |
Liste de tous les périmètres du contrat (si interrogés). |
|
Options
|
options | array of ContractOption |
Liste de toutes les options spécifiques du contrat (si interrogée). |
|
Propriétés personnalisées
|
contract_properties | array of ContractProperty |
Liste de toutes les propriétés de contrat facultatives (si interrogées). |
ContractOption
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID d’option
|
id | integer |
ID de l’option du contrat. |
|
ID de contrat
|
contract_id | integer |
ID du contrat lié à cette option. |
|
ID de définition d’élément
|
element_definition_id | integer |
ID de la définition d’élément de l’option. |
|
Minuteur de synchronisation
|
sync_timer | integer |
Minuteur utilisé pour le problème de synchronisation. |
|
Valeur d’option
|
value | string |
Valeur de l’option. |
|
Dernière modification
|
last_modification_place | string |
Indique où la dernière modification a eu lieu. |
|
Contrôle d’option
|
control | string |
Champ de contrôle. |
ContractProperty
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID de propriété
|
id | integer |
ID de la propriété personnalisée. |
|
Clé de propriété
|
key | string |
Clé de la propriété personnalisée. |
|
Espace réservé de propriété
|
placeholder | string |
Étiquette affichée au destinataire lorsqu’elle est invitée à renseigner la propriété. |
|
Valeur de propriété
|
value | string |
Valeur de la propriété personnalisée. |
|
ID du contrat de propriété
|
contract_id | integer |
ID du contrat associé à cette propriété personnalisée. |
|
La propriété est requise
|
to_fill_by_user | boolean |
Spécifiez si l’utilisateur doit remplir la propriété ou non. |
|
Type de propriété
|
field_type | string |
Spécifiez le type de la propriété personnalisée. Plus d’informations dans la documentation. |
|
Options de propriété
|
input_filter | string |
Liste des choix possibles pour la propriété. |
|
La propriété est utilisée par le contrat
|
used_by_contract | boolean |
Défini sur true si les informations doivent apparaître sur le document de contrat. |
|
La propriété est requise
|
required | boolean |
Spécifiez si la propriété est requise ou non. |
ContractPerimeterKey
ContractRecipient
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Destinataire de l’ID de contrat
|
recipient_for_contract_id | integer |
Identificateur unique du contrat et du destinataire du couple. |
|
ID du destinataire
|
recipient_id | integer |
ID du destinataire. |
|
ID de contrat
|
contract_id | integer |
ID du contrat. |
|
État de la signature
|
signature_status | string |
État de la marque de signe. |
|
Date de signature
|
signature_date | integer |
Horodatage de la date de la marque de signe. |
|
Mode signature
|
signature_mode | integer |
Mode de marque de signe. |
|
Titre du message
|
message_title | string |
Titre du message. |
|
Contenu du message
|
message_body | string |
Corps du message. |
|
Classement
|
rank | integer |
Classement dans le processus de signature. |
|
Rôle intelligent
|
smartrole | string |
Rôle intelligent associé au destinataire. |
|
Mode de transport
|
transport_mode | integer |
Mode de transport. |
|
ID de signature
|
signature_id | string |
ID de la signature du destinataire. |
DocumentAdded
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Document ID
|
id | integer |
ID du document. |
|
Classement
|
rank | integer |
Placez-vous dans la liste du document. |
|
Has SmartField
|
has_smart_field | boolean |
Spécifiez si le document comporte SmartFields. |
|
Taille du document
|
size | integer |
Taille du document en octets. |
|
Nom du document
|
filename | string |
Nom du document. |
Transaction
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID de transaction de contrat
|
transaction_id | string |
Spécifiez l’ID de transaction lié au contrat. |
|
Est fermé
|
is_closed | boolean |
Spécifiez si le contrat est fermé. |
|
Nom du contrat
|
contract_name | string |
Nom du contrat. |
|
État du contrat
|
status | string |
Spécifiez l’état du contrat. |
Périmètre
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID de périmètre
|
id | integer |
ID du périmètre. |
|
Clé de périmètre
|
key | string |
Clé du périmètre (utilisée par les contrats). |
|
descriptif
|
description | string |
Description du périmètre. |
RecipientForContractWithRefusal
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Destinataire de l’ID de contrat
|
recipient_for_contract_id | integer |
ID de l’objet qui a lié le contrat et le destinataire. |
|
ID du destinataire
|
recipient_id | integer |
ID du destinataire de la signature. |
|
État de la signature
|
signature_status | string |
État de la signature. |
|
Date de signature
|
signature_date | integer |
Date des dernières modifications de la signature. |
|
Mode signature
|
signature_mode | integer |
Mode de la signature. |
|
Titre du message
|
message_title | string |
Titre du message lié à la signature du contrat. |
|
Contenu du message
|
message_body | string |
Corps du message lié à la signature du contrat. |
|
Classement
|
rank | integer |
Classement du destinataire de la signature dans le processus de contrat. |
|
Nom du rôle intelligent
|
smartrole | string |
Rôle du destinataire de la signature dans le contrat. |
|
Mode de transport
|
transport_mode | integer |
Mode de transport du contrat lié à la signature. |
|
ID de signature
|
signature_id | string |
ID de la signature. |
|
Refus
|
has_refusal | boolean |
Spécifiez si le destinataire a refusé le contrat. |
|
Date de dernier refus
|
last_refusal_date | integer |
Spécifiez la date de refus. |
|
Dernier message de refus
|
last_refusal_message | string |
Spécifiez le message de refus. |
ContractInBundle
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID de contrat
|
id | integer |
ID du contrat. |
|
Nom du contrat
|
name | string |
Nom du contrat. |
|
Type de définition de contrat
|
contract_definition_type | string |
Type de définition du contrat. |
|
ID de définition de contrat
|
contract_definition_id | integer |
ID de la définition du contrat. |
|
Nom de la société
|
company_name | string |
Nom de la société liée au contrat. |
Recipient
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID du destinataire
|
id | integer |
ID du destinataire. |
|
Civilité
|
civility | string |
Civilité du destinataire |
|
Prénom
|
firstname | string |
Prénom du destinataire. |
|
Nom de famille
|
lastname | string |
Nom du destinataire. |
|
Adresse principale
|
address_1 | string |
Adresse postale principale du destinataire. |
|
Code postal
|
postal_code | string |
Code postal du destinataire. |
|
Ville
|
city | string |
Ville du destinataire. |
|
Numéro de téléphone mobile
|
cell_phone | string |
Numéro de téléphone mobile du destinataire. |
|
Adresse de messagerie
|
string |
Adresse de messagerie du destinataire. |
|
|
Pays
|
country | string |
Pays du destinataire. |
|
Adresse secondaire
|
address_2 | string |
Adresse postale secondaire du destinataire. |
|
Nom de l’entreprise
|
company_name | string |
Nom de la société du destinataire. |
|
Numéro de téléphone
|
phone | string |
Numéro de téléphone du destinataire. |
|
Poste
|
job_title | string |
Titre du travail du destinataire. |
|
Birthdate
|
birthdate | integer |
Date de naissance (horodatage) du destinataire. |
|
Lieu de naissance
|
birthplace | string |
Lieu de naissance du destinataire. |
|
custom_properties
|
custom_properties | array of RecipientProperty | |
|
Périmètres
|
perimeters | array of string |
RecipientProperty
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID de propriété
|
id | integer |
ID de la propriété. |
|
Clé de propriété
|
key | string |
Clé de la propriété. |
|
Valeur de la propriété
|
value | string |
Valeur de la propriété. |
|
ID de l’entrepreneur
|
contractor_id | integer |
ID de l’entrepreneur. |
|
Minuteur de synchronisation
|
sync_timer | integer |
Minuteur de la dernière synchronisation. |
|
Dernière modification
|
last_modification_place | string |
Emplacement de la dernière modification. |
AnnexeAdded
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID de l’annexe
|
id | integer |
ID de l’annexe. |
|
Nom de l’annexe
|
filename | string |
Nom de l’annexe. |
|
ID de l’option Annexe
|
option_id | integer |
ID d’option de l’annexe |
|
Annexe Content-Type
|
content_type | string |
Type de contenu de l’annexe (image/jpeg, par exemple). |
BundleResponse
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID de l’offre groupée
|
id | integer |
ID de l’offre groupée. |
|
ID d’auteur
|
actor_id | integer |
ID du créateur de l’offre groupée. |
|
Premier ID de contrat
|
contract_id | integer |
ID du premier contrat du bundle créé. |
|
État de l’offre groupée
|
status | integer |
État de l’offre groupée. |
|
Master d’offre groupée
|
master | integer |
Maître de l’offre groupée. |
file
Il s’agit du type de données de base « fichier ».