Annature (Éditeur indépendant) (préversion)
Annature est la principale solution d’signature électronique appartenant à l’Australie avec un fournisseur de signature numérique intégré. Ce connecteur aide les entreprises à créer des enveloppes et à intégrer un flux de travail de signature de document annature à l’aide de l’API Annature (v1).
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 | Dr Adrian Colquhoun (Strategik) |
| URL | https://www.linkedin.com/in/adriancolquhoun/ |
| Messagerie électronique | adrian@strategik.com.au |
| Métadonnées du connecteur | |
|---|---|
| Éditeur | Dr Adrian Colquhoun (Strategik) |
| Site internet | https://annature.com.au |
| Politique de confidentialité | https://www.annature.com.au/privacy-policy |
| Catégories | Productivité |
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 | Non partageable |
Faire défaut
Applicable : Toutes les régions
Paramètres de création de connexion.
Cette connexion n’est pas partageable. Si l’application power est partagée avec un autre utilisateur, un autre utilisateur est invité à créer une connexion explicitement.
| Nom | Type | Descriptif | Obligatoire |
|---|---|---|---|
| Annature Id | ficelle | Annature Id | Vrai |
| Annature Key | securestring | Annature Key | Vrai |
Limitations
| Nom | Appels | Période de renouvellement |
|---|---|---|
| Appels d’API par connexion | 100 | 60 secondes |
Actions
| Créer une enveloppe |
Créer une enveloppe |
| Créer une enveloppe à partir d’un modèle |
Utiliser un modèle |
| Enveloppe void |
Envoyer une enveloppe |
| Envoyer une enveloppe |
Envoyer une enveloppe |
| Obtenir des champs |
Répertorier tous les champs |
| Obtenir des comptes |
Répertorier tous les comptes |
| Obtenir des documents |
Répertorier tous les documents d’une enveloppe |
| Obtenir des enveloppes |
Répertorier toutes les enveloppes |
| Obtenir des modèles |
Répertorier tous les modèles |
| Obtenir le champ |
Obtenir le champ |
| Obtenir le destinataire |
Obtenir un destinataire unique créé pour une enveloppe à l’aide de la propriété ID retournée dans le corps de réponse de la création d’une enveloppe |
| Obtenir toutes les pièces jointes d’un champ |
Obtenir des pièces jointes de champ |
| Obtenir un modèle |
Obtenir un modèle |
| Obtenir une enveloppe |
Obtenir une enveloppe |
| Obtenir une organisation |
Obtenir une organisation |
| Supprimer l’enveloppe |
Supprimer l’enveloppe |
Créer une enveloppe
Créer une enveloppe
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Nom
|
name | True | string |
Nom de l’enveloppe, affiché dans l’objet des e-mails envoyés aux destinataires et lors de l’affichage de l’enveloppe |
|
Message
|
message | string |
Message |
|
|
Shared
|
shared | boolean |
Shared |
|
|
Brouillon
|
draft | boolean |
Brouillon |
|
|
ID de compte
|
account_id | True | string |
ID de compte |
|
ID de groupe
|
group_id | string |
ID de groupe |
|
|
ID de groupe
|
id | string |
ID de groupe |
|
|
Nom
|
name | string |
Nom |
|
|
Type
|
type | string |
Type |
|
|
Contenu du fichier
|
base | byte |
Contenu du fichier |
|
|
Nom
|
name | string |
Nom |
|
|
ID d’e-mail
|
string |
ID d’e-mail |
||
|
Téléphone mobile
|
mobile | string |
Téléphone mobile |
|
|
Type de destinataire
|
type | string |
Le type de destinataire, par défaut, est signataire lorsqu’il n’est pas fourni |
|
|
Message
|
message | string |
Message |
|
|
mot de passe
|
password | string | ||
|
Assourdi?
|
muted | boolean |
Cela empêchera Annature d’envoyer toute correspondance au destinataire |
|
|
Ordre de signature
|
order | integer |
Ordre de signature |
|
|
Session terminée
|
session_completed | string |
Point de terminaison de destination une fois que le destinataire a terminé l’enveloppe |
|
|
Session refusée
|
session_declined | string |
Point de terminaison de destination après le refus du destinataire de signer l’enveloppe |
|
|
pièce d'identité
|
id | string | ||
|
recipient_id
|
recipient_id | string | ||
|
type
|
type | string |
Type de champ |
|
|
page
|
page | integer | ||
|
x_coordinate
|
x_coordinate | integer | ||
|
y_coordinate
|
y_coordinate | integer | ||
|
Obligatoire
|
required | boolean |
Obligatoire |
|
|
Lecture seule
|
read_only | boolean |
Lecture seule |
|
|
Collaboratif
|
collaborative | boolean |
Collaboratif |
|
|
width
|
width | integer | ||
|
font_size
|
font_size | integer | ||
|
font_type
|
font_type | string |
Les valeurs possibles sont courrier et helvetica |
|
|
créé
|
created | string |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
pièce d'identité
|
id | string |
Id |
|
nom
|
name | string |
Nom |
|
Message
|
message | string |
Message |
|
status
|
status | string |
Statut |
|
Shared
|
shared | boolean |
Shared |
|
Création le
|
created | string |
Création le |
|
Envoyé sur
|
sent | string |
Envoyé sur |
|
Annulée
|
voided | ||
|
décliné
|
declined | ||
|
terminé
|
completed | ||
|
ID de compte
|
account_id | string |
Account_id |
|
ID de groupe
|
group_id | string |
ID de groupe |
|
destinataires
|
recipients | array of object | |
|
pièce d'identité
|
recipients.id | string | |
|
nom
|
recipients.name | string | |
|
Messagerie électronique
|
recipients.email | string | |
|
mobile
|
recipients.mobile | string | |
|
type
|
recipients.type | string | |
|
status
|
recipients.status | string | |
|
Message
|
recipients.message | string | |
|
Mot de passe
|
recipients.password |
Mot de passe |
|
|
Assourdi
|
recipients.muted | boolean |
Assourdi |
|
order
|
recipients.order | integer | |
|
declined_reason
|
recipients.declined_reason | ||
|
créé
|
recipients.created | string | |
|
envoyèrent
|
recipients.sent | string | |
|
décliné
|
recipients.declined | ||
|
terminé
|
recipients.completed | ||
|
session_completed
|
recipients.redirects.session_completed | string | |
|
session_declined
|
recipients.redirects.session_declined | string |
Créer une enveloppe à partir d’un modèle
Utiliser un modèle
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de modèle
|
id | True | string |
ID de modèle |
|
Nom
|
name | string |
Nom de l’enveloppe, affiché dans l’objet des e-mails envoyés aux destinataires et lors de l’affichage de l’enveloppe |
|
|
Brouillon
|
draft | boolean |
Brouillon |
|
|
Message
|
message | string |
Message |
|
|
Shared
|
shared | boolean |
Shared |
|
|
ID de compte
|
account_id | True | string |
ID de compte |
|
ID de groupe
|
group_id | string |
ID de groupe |
|
|
ID de groupe
|
id | string |
ID de groupe |
|
|
Nom
|
name | string |
Nom |
|
|
ID de groupe
|
type | string |
ID de groupe |
|
|
Contenu du fichier
|
base | byte |
Contenu du fichier |
|
|
ID de rôle
|
role_id | string |
ID de rôle |
|
|
Nom
|
name | string |
Nom |
|
|
ID d’e-mail
|
string |
ID d’e-mail |
||
|
Téléphone mobile
|
mobile | string |
Téléphone mobile |
|
|
Authentification SMS
|
sms_auth | string |
Authentification SMS |
|
|
Type de destinataire
|
type | string |
Le type de destinataire, par défaut, est signataire lorsqu’il n’est pas fourni |
|
|
Message
|
message | string |
Message |
|
|
mot de passe
|
password | string | ||
|
Assourdi?
|
muted | boolean |
Cela empêchera Annature d’envoyer toute correspondance au destinataire |
|
|
Ordre de signature
|
order | integer |
Ordre de signature |
|
|
ID de champ (à partir du modèle)
|
id | True | string |
ID du champ de modèle |
|
Valeur
|
value | True | string |
Valeur de ce champ |
|
Point de terminaison de destination une fois que le destinataire a terminé l’enveloppe
|
session_completed | string |
Point de terminaison de destination une fois que le destinataire a terminé l’enveloppe |
|
|
Point de terminaison de destination après le refus du destinataire de signer l’enveloppe
|
session_declined | string |
Point de terminaison de destination après le refus du destinataire de signer l’enveloppe |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
pièce d'identité
|
id | string |
Id |
|
nom
|
name | string |
Nom |
|
Message
|
message | string |
Message |
|
partagé
|
shared | boolean |
Est-ce partagé ? |
|
draft
|
draft | boolean | |
|
account_id
|
account_id | string |
ID de compte |
|
group_id
|
group_id | string |
ID de groupe |
|
documents
|
documents | array of object | |
|
Id
|
documents.id | string |
Id |
|
Nom
|
documents.name | string |
Nom |
|
Pages
|
documents.pages | integer | |
|
Original
|
documents.original | string |
Original |
|
Maître
|
documents.master | string |
Maître |
|
Créé
|
documents.created | string |
Créé |
|
destinataires
|
recipients | array of object | |
|
role_id
|
recipients.role_id | string | |
|
nom
|
recipients.name | string | |
|
Messagerie électronique
|
recipients.email | string | |
|
mobile
|
recipients.mobile | string | |
|
Message
|
recipients.message | string | |
|
mot de passe
|
recipients.password | boolean | |
|
assourdi
|
recipients.muted | boolean | |
|
session_completed
|
recipients.redirects.session_completed | string | |
|
session_declined
|
recipients.redirects.session_declined | string |
Enveloppe void
Envoyer une enveloppe
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’enveloppe
|
id | True | string |
ID d’enveloppe |
Envoyer une enveloppe
Envoyer une enveloppe
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’enveloppe
|
id | True | string |
ID d’enveloppe |
Obtenir des champs
Répertorier tous les champs
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’enveloppe
|
envelope_id | True | string |
ID d’enveloppe |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
|
array of object | ||
|
pièce d'identité
|
id | string | |
|
recipient_id
|
recipient_id | string | |
|
type
|
type | string | |
|
page
|
page | integer | |
|
ancre
|
anchor | string | |
|
x_coordinate
|
x_coordinate | integer | |
|
y_coordinate
|
y_coordinate | integer | |
|
Obligatoire
|
required | boolean |
Obligatoire |
|
Read_only
|
read_only | boolean |
Read_only |
|
Collaboratif
|
collaborative | boolean |
Collaboratif |
|
value
|
value | string | |
|
Vérifié
|
checked | boolean |
Vérifié |
|
height
|
height | integer | |
|
width
|
width | integer | |
|
options
|
options | ||
|
font_size
|
font_size | integer | |
|
font_type
|
font_type | string | |
|
date_format
|
date_format | string | |
|
créé
|
created | string |
Obtenir des comptes
Répertorier tous les comptes
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
|
array of object | ||
|
pièce d'identité
|
id | string | |
|
Nom
|
name | string |
Nom |
|
Messagerie électronique
|
string |
Messagerie électronique |
|
|
nombre
|
number | string | |
|
timezone
|
timezone | string | |
|
role
|
role | string | |
|
active
|
active | boolean | |
|
group_id
|
group_id | string | |
|
créé
|
created | string | |
|
Vérifié
|
verified | string |
Obtenir des documents
Répertorier tous les documents d’une enveloppe
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’enveloppe
|
envelope_id | True | string |
ID d’enveloppe |
|
Durée du point de terminaison
|
endpoint_duration | integer |
Définit le nombre de minutes pendant lesquelles les points de terminaison d’origine et master seront accessibles. Le nombre peut être compris entre 1 et 10080, avec la valeur par défaut 60 |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
|
array of object | ||
|
Id
|
id | string |
Id |
|
Nom
|
name | string |
Nom |
|
Pages
|
pages | integer | |
|
Original
|
original | string |
Original |
|
Maître
|
master | string |
Maître |
|
Créé
|
created | string |
Créé |
Obtenir des enveloppes
Répertorier toutes les enveloppes
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Nom de l’enveloppe
|
name | string |
Filtre de correspondance exacte sur la liste en fonction de la propriété de nom de l’enveloppe |
|
|
État de l’enveloppe
|
status | string |
Filtre de correspondance exacte sur la liste en fonction de l’état de l’enveloppe |
|
|
Nom du destinataire
|
recipient | string |
Filtre de correspondance exacte sur la liste en fonction du nom ou de la propriété de messagerie d’un destinataire |
|
|
Créé avant
|
created_before | date |
Retourne les résultats où la date de création est antérieure à la valeur donnée |
|
|
Créé après
|
created_after | date |
Retourne les résultats où la date de création est postérieure à la valeur donnée |
|
|
Terminé avant
|
completed_before | date |
Retourne les résultats où la date terminée est antérieure à la valeur donnée |
|
|
Terminé après
|
completed_after | date |
Retourne les résultats où la date terminée se trouve après la valeur donnée |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
|
array of object | ||
|
pièce d'identité
|
id | string |
Id |
|
nom
|
name | string |
Nom |
|
Message
|
message | string |
Message |
|
status
|
status | string |
Statut |
|
partagé
|
shared | boolean |
Shared |
|
créé
|
created | string |
Créé |
|
envoyèrent
|
sent | string |
Sent |
|
Annulée
|
voided | string |
Annulée |
|
décliné
|
declined | string |
Refusée |
|
terminé
|
completed | string |
Terminé |
|
combiné
|
combined | string |
Combiné |
|
master
|
master | string |
Maître |
|
certificate
|
certificate | string |
Certificate |
|
account_id
|
account_id | string |
ID de compte |
|
group_id
|
group_id | string |
ID de groupe |
|
Destinataires
|
recipients | array of object | |
|
Nom
|
recipients.name | string |
Nom |
|
ID d’e-mail
|
recipients.email | string |
ID d’e-mail |
|
Téléphone mobile
|
recipients.mobile | string |
Téléphone mobile |
|
Type de destinataire
|
recipients.type | string |
Le type de destinataire, par défaut, est signataire lorsqu’il n’est pas fourni |
|
Message
|
recipients.message | string |
Message |
|
Mot de passe
|
recipients.password | ||
|
Assourdi?
|
recipients.muted | boolean |
Cela empêchera Annature d’envoyer toute correspondance au destinataire |
|
Ordre de signature
|
recipients.order | integer |
Ordre de signature |
|
Point de terminaison de destination une fois que le destinataire a terminé l’enveloppe
|
recipients.redirects.session_completed | string |
Point de terminaison de destination une fois que le destinataire a terminé l’enveloppe |
|
Point de terminaison de destination après le refus du destinataire de signer l’enveloppe
|
recipients.redirects.session_declined | string |
Point de terminaison de destination après le refus du destinataire de signer l’enveloppe |
|
fields
|
recipients.fields | array of object | |
|
pièce d'identité
|
recipients.fields.id | string | |
|
recipient_id
|
recipients.fields.recipient_id | string | |
|
type
|
recipients.fields.type | string | |
|
page
|
recipients.fields.page | integer | |
|
x_coordinate
|
recipients.fields.x_coordinate | integer | |
|
y_coordinate
|
recipients.fields.y_coordinate | integer | |
|
Obligatoire
|
recipients.fields.required | boolean |
Obligatoire |
|
Read_only
|
recipients.fields.read_only | boolean |
Read_only |
|
Collaboratif
|
recipients.fields.collaborative | boolean |
Collaboratif |
|
width
|
recipients.fields.width | integer | |
|
font_size
|
recipients.fields.font_size | integer | |
|
font_type
|
recipients.fields.font_type | string | |
|
créé
|
recipients.fields.created | string |
Obtenir des modèles
Répertorier tous les modèles
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Nom
|
name | string |
Filtre de correspondance exacte sur la liste en fonction des modèles |
|
|
Créé avant
|
created_before | date |
Retourne les résultats où la date de création est antérieure à la valeur donnée |
|
|
Créé après
|
created_after | date |
Retourne les résultats où la date de création est postérieure à la valeur donnée |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
|
array of object | ||
|
pièce d'identité
|
id | string | |
|
nom
|
name | string | |
|
Shared
|
shared | boolean |
Shared |
|
envelope_name
|
envelope_name | string | |
|
envelope_message
|
envelope_message | string | |
|
Envelope_shared
|
envelope_shared | boolean |
Envelope_shared |
|
créé
|
created | string | |
|
account_id
|
account_id | string | |
|
group_id
|
group_id | string | |
|
documents
|
documents | array of object | |
|
Id
|
documents.id | string |
Id |
|
Nom
|
documents.name | string |
Nom |
|
Pages
|
documents.pages | integer | |
|
Original
|
documents.original | string |
Original |
|
Maître
|
documents.master | string |
Maître |
|
Créé
|
documents.created | string |
Créé |
|
roles
|
roles | array of object | |
|
Id
|
roles.id | string |
Id |
|
Nom
|
roles.name | string |
Nom |
|
Nom du destinataire
|
roles.recipient_name | string |
Nom du destinataire |
|
E-mail du destinataire
|
roles.recipient_email | string |
E-mail du destinataire |
|
Recipient Mobile
|
roles.recipient_mobile | string |
Recipient Mobile |
|
Type de destinataire
|
roles.recipient_type | string |
Le type de destinataire, par défaut, est signataire lorsqu’il n’est pas fourni |
|
Mot de passe
|
roles.recipient_password | string |
Mot de passe |
|
Ordre de signature
|
roles.order | integer |
Ordre de signature |
|
Point de terminaison de destination une fois que le destinataire a terminé l’enveloppe
|
roles.recipient_redirects.session_completed | string |
Point de terminaison de destination une fois que le destinataire a terminé l’enveloppe |
|
Point de terminaison de destination après le refus du destinataire de signer l’enveloppe
|
roles.recipient_redirects.session_declined | string |
Point de terminaison de destination après le refus du destinataire de signer l’enveloppe |
Obtenir le champ
Obtenir le champ
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’enveloppe
|
envelope_id | True | string |
ID d’enveloppe |
|
ID de champ
|
id | True | string |
ID de champ |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
pièce d'identité
|
id | string |
Id |
|
recipient_id
|
recipient_id | string |
ID du destinataire |
|
type
|
type | string |
Type |
|
page
|
page | integer | |
|
ancre
|
anchor | string |
Ancre |
|
x_coordinate
|
x_coordinate | integer | |
|
y_coordinate
|
y_coordinate | integer | |
|
Obligatoire
|
required | boolean |
Obligatoire |
|
Read_only
|
read_only | boolean |
Read_only |
|
Collaboratif
|
collaborative | boolean |
Permet à d’autres destinataires de l’enveloppe de modifier les valeurs |
|
value
|
value | string |
Valeur du champ |
|
Vérifié
|
checked | boolean |
Vérifié |
|
height
|
height | integer | |
|
width
|
width | integer | |
|
options
|
options | ||
|
font_size
|
font_size | integer | |
|
font_type
|
font_type | string |
Les valeurs possibles sont courrier et helvetica |
|
date_format
|
date_format | string |
Date Format |
|
créé
|
created | string |
Créé |
Obtenir le destinataire
Obtenir un destinataire unique créé pour une enveloppe à l’aide de la propriété ID retournée dans le corps de réponse de la création d’une enveloppe
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Recipient
|
id | True | string |
ID du destinataire |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Id
|
id | string |
Id |
|
nom
|
name | string |
Nom |
|
Messagerie électronique
|
string |
Messagerie électronique |
|
|
mobile
|
mobile | string |
Téléphone mobile |
|
type
|
type | string |
Type |
|
status
|
status | string |
Statut |
|
Message
|
message | string |
Message |
|
Mot de passe
|
password |
Mot de passe |
|
|
Assourdi
|
muted | boolean |
Assourdi |
|
order
|
order | integer | |
|
declined_reason
|
declined_reason | string |
Declined_reason |
|
créé
|
created | string |
Créé |
|
envoyèrent
|
sent | string |
Sent |
|
décliné
|
declined | string |
Refusée |
|
terminé
|
completed | string |
Terminé |
|
session_completed
|
redirects.session_completed | string |
Session_completed |
|
session_declined
|
redirects.session_declined | string |
Session_declined |
Obtenir toutes les pièces jointes d’un champ
Obtenir des pièces jointes de champ
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’enveloppe
|
envelope_id | True | string |
ID d’enveloppe |
|
ID de champ
|
id | True | string |
ID de champ |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
|
array of object | ||
|
pièce d'identité
|
id | string | |
|
Langue source
|
original | string | |
|
nom
|
name | string | |
|
type
|
type | string | |
|
size
|
size | integer | |
|
créé
|
created | string |
Obtenir un modèle
Obtenir un modèle
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de modèle
|
id | True | string |
ID de modèle |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
pièce d'identité
|
id | string | |
|
nom
|
name | string | |
|
Shared
|
shared | boolean |
Shared |
|
envelope_name
|
envelope_name | string | |
|
envelope_message
|
envelope_message | string | |
|
Envelope_shared
|
envelope_shared | boolean |
Envelope_shared |
|
créé
|
created | string | |
|
account_id
|
account_id | string | |
|
group_id
|
group_id | string | |
|
documents
|
documents | array of object | |
|
Id
|
documents.id | string |
Id |
|
Nom
|
documents.name | string |
Nom |
|
Pages
|
documents.pages | integer | |
|
Original
|
documents.original | string |
Original |
|
Maître
|
documents.master | string |
Maître |
|
Créé
|
documents.created | string |
Créé |
|
roles
|
roles | array of object | |
|
Id
|
roles.id | string |
Id |
|
Nom
|
roles.name | string |
Nom |
|
Nom du destinataire
|
roles.recipient_name | string |
Nom du destinataire |
|
E-mail du destinataire
|
roles.recipient_email | string |
E-mail du destinataire |
|
Recipient Mobile
|
roles.recipient_mobile | string |
Recipient Mobile |
|
Type de destinataire
|
roles.recipient_type | string |
Le type de destinataire, par défaut, est signataire lorsqu’il n’est pas fourni |
|
Mot de passe
|
roles.recipient_password | string |
Mot de passe |
|
Ordre de signature
|
roles.order | integer |
Ordre de signature |
|
Point de terminaison de destination une fois que le destinataire a terminé l’enveloppe
|
roles.recipient_redirects.session_completed | string |
Point de terminaison de destination une fois que le destinataire a terminé l’enveloppe |
|
Point de terminaison de destination après le refus du destinataire de signer l’enveloppe
|
roles.recipient_redirects.session_declined | string |
Point de terminaison de destination après le refus du destinataire de signer l’enveloppe |
Obtenir une enveloppe
Obtenir une enveloppe
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’enveloppe
|
id | True | string |
ID d’enveloppe |
|
Durée du point de terminaison
|
endpoint_duration | integer |
Définit le nombre de minutes pendant lesquelles les points de terminaison d’origine et master seront accessibles. Le nombre peut être compris entre 1 et 10080, avec la valeur par défaut 60 |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
pièce d'identité
|
id | string |
Id |
|
nom
|
name | string |
Nom |
|
Message
|
message | string |
Message |
|
status
|
status | string |
Statut |
|
partagé
|
shared | boolean |
Shared |
|
créé
|
created | string |
Créé |
|
envoyèrent
|
sent | string |
Sent |
|
Annulée
|
voided | string |
Annulée |
|
décliné
|
declined | string |
Refusée |
|
terminé
|
completed | string |
Terminé |
|
master
|
master | string |
Maître |
|
combiné
|
combined | string |
Combiné |
|
certificate
|
certificate | string |
Certificate |
|
account_id
|
account_id | string |
ID de compte |
|
group_id
|
group_id | string |
ID de groupe |
|
Destinataires
|
recipients | array of object | |
|
Nom
|
recipients.name | string |
Nom |
|
ID d’e-mail
|
recipients.email | string |
ID d’e-mail |
|
Téléphone mobile
|
recipients.mobile | string |
Téléphone mobile |
|
Type de destinataire
|
recipients.type | string |
Le type de destinataire, par défaut, est signataire lorsqu’il n’est pas fourni |
|
Message
|
recipients.message | string |
Message |
|
Mot de passe
|
recipients.password | ||
|
Assourdi?
|
recipients.muted | boolean |
Cela empêchera Annature d’envoyer toute correspondance au destinataire |
|
Ordre de signature
|
recipients.order | integer |
Ordre de signature |
|
Point de terminaison de destination une fois que le destinataire a terminé l’enveloppe
|
recipients.redirects.session_completed | string |
Point de terminaison de destination une fois que le destinataire a terminé l’enveloppe |
|
Point de terminaison de destination après le refus du destinataire de signer l’enveloppe
|
recipients.redirects.session_declined | string |
Point de terminaison de destination après le refus du destinataire de signer l’enveloppe |
|
fields
|
recipients.fields | array of object | |
|
pièce d'identité
|
recipients.fields.id | string | |
|
recipient_id
|
recipients.fields.recipient_id | string | |
|
type
|
recipients.fields.type | string | |
|
page
|
recipients.fields.page | integer | |
|
x_coordinate
|
recipients.fields.x_coordinate | integer | |
|
y_coordinate
|
recipients.fields.y_coordinate | integer | |
|
Obligatoire
|
recipients.fields.required | boolean |
Obligatoire |
|
Read_only
|
recipients.fields.read_only | boolean |
Read_only |
|
Collaboratif
|
recipients.fields.collaborative | boolean |
Collaboratif |
|
width
|
recipients.fields.width | integer | |
|
font_size
|
recipients.fields.font_size | integer | |
|
font_type
|
recipients.fields.font_type | string | |
|
créé
|
recipients.fields.created | string |
Obtenir une organisation
Obtenir une organisation
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
pièce d'identité
|
id | string |
Id |
|
nom
|
name | string |
Nom |
|
affaire
|
business | string |
Métier |
|
Messagerie électronique
|
string |
Messagerie électronique |
|
|
nombre
|
number | string |
Number |
|
address
|
address | string |
Adresse |
|
site web
|
website | string |
Site internet |
|
logo
|
logo | string |
Logo |
|
couleur
|
colour | string |
Couleur |
|
créé
|
created | string |
Créé |
Supprimer l’enveloppe
Supprimer l’enveloppe
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’enveloppe
|
id | True | string |
ID d’enveloppe |
Déclencheurs
| Déclencheur d’événement - Enveloppe et destinataire |
Se déclenche lorsqu’un événement se produit lorsque des enveloppes sont terminées ou des vues de destinataires |
Déclencheur d’événement - Enveloppe et destinataire
Se déclenche lorsqu’un événement se produit lorsque des enveloppes sont terminées ou des vues de destinataires
Retours
- Corps
- WebhookEventContent
Définitions
WebhookEventContent
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
événement
|
event | string | |
|
envelope_id
|
envelope_id | string | |
|
Annulée
|
voided | string | |
|
terminé
|
completed | string | |
|
master
|
master | string | |
|
certificate
|
certificate | string | |
|
envoyèrent
|
sent | string | |
|
method
|
method | string | |
|
recipient_id
|
recipient_id | string | |
|
Vu
|
viewed | string | |
|
décliné
|
declined | string | |
|
declined_reason
|
declined_reason | string | |
|
a échoué
|
failed | string | |
|
Diagnostic
|
diagnosis | string |