Docage API
French
  • French
  • Spanish
  1. Docage Sign
Docage API
French
  • French
  • Spanish
  • Requêtes communes
    • Créer un objet
      • Créer un objet
    • Modifier un objet
      • Modifier un objet
    • Suppression des objets
      • Supprimer un objet
      • Supprimer plusieurs objets
    • Récupération des objets
      • Récupérer tous les objets
        • Récupérer une liste d'objets
          • Récupérer tous les contacts
          • Récupérer tous les parcours
          • Récupérer tous les classeurs
        • Récupérer les modèles de parcours
        • Requêter certaines propriétés uniquement
      • Récupérer un seul objet
        • Récupérer un objet par son Id
        • Récupérer un contact par son email
        • Récupérer un utilisateur par son email
      • Récupérer une liste filtrée
        • Filtrer les transactions en cours
        • Filtrer les transactions supérieure à une date
        • Filtrer les transactions signées ET dont le nom contient "Facture"
        • Filtrer les contacts qui s'appellent Léo ou Paul ET dont l'email se termine par gmail.com
        • Filtrer les contacts en fonction des champs personnalisés
      • Récupérer les objets d'un classeur
        • Récupérer les contacts d'un classeur
      • Récupérer une liste triée
        • Trier les contacts par leur prénom
        • Trier les contacts par leur prénom en ordre décroissant
        • Trier les contacts par leur prénom, puis par leur nom en ordre décroissant
      • Récupérer une liste paginée
        • Trier les contacts par leur prénom
        • Trier les contacts par leur prénom en ordre décroissant
        • Trier les contacts par leur prénom, puis par leur nom en ordre décroissant
  • Docage Sign
    • Créer un parcours en une requête
      • Sans modèle de parcours
        • Avec contact existant
        • Avec création d'un contact
        • Avec plusieurs signatures pour un contact
        • Avec modification d'un contact existant
        • Créer un brouillon (sans lancement)
        • Avec fourniture des Ids par le développeur
      • Avec un modèle de parcours
        • Sans modification
          • Sans modification
        • Remplacement d'un membre
          • Par un contact existant
          • Par un nouveau contact
        • Remplacement d'un document
          • Avec un nouveau fichier
          • Avec un modèle de document Docage
        • Ajout d'un membre (à venir)
          • Avec un nouveau contact (à venir)
          • Avec un contact existant (à venir)
        • Ajout d'un document (à venir)
          • Avec un nouveau fichier (à venir)
        • Autres exemples
          • Créer un brouillon (sans lancement)
          • Avec modification des propriétés héritées du modèle
          • Avec modification du mode de signature
    • Création pas à pas
      • Créer une transaction
      • Ajouter un document à la transaction
      • Ajouter un membre à la transaction
      • Ajouter une signature visuelle
      • Lancer une transaction
    • Téléchargement des documents
      • Télécharger un document précis d'une transaction
      • Télécharger tous les documents d'une transaction
      • Télécharger le fichier de preuve
      • Télécharger tous les documents et le fichier de preuve d'une transaction
    • Signer plusieurs transactions en une fois
      • Vérifier la signabilité des transactions
      • Envoyer un code de signature pour signer plusieurs transactions en une fois
      • Signer plusieurs transactions avec un code unique
    • Autres requêtes pour les transactions
      • Récupérer le statut d'une transaction
      • Annuler une transaction
      • Envoyer un rappel
      • Supprimer un/des membres d'une/plusieurs transactions
      • Supprimer un/des fichiers d'une/plusieurs transactions
    • Gestion des signatures visuelles
  • Docage Mail
  • Webhook
    • Etre notifié lorsqu'un objet change d'état
      • Etre notifié lorsqu'une Transaction est supprimée
      • Etre notifié lorsqu'un Utilisateur est bloqué
      • Etre notifié lorsqu'un Utilisateur est débloqué
    • Etre notifié lorsqu'un objet est modifié
      POST
    • Etre notifié lorsqu'une Transaction change de statut
      POST
    • Etre notifié lorsque le contenu d'un classeur est modifié
      POST
    • Etre notifié lorsqu'un formulaire Web est rempli
      POST
    • Etre notifié de l'état de Docage
      POST
    • Supprimer un Webhook par son Id
      DELETE
    • Supprimer plusieurs Webhooks par leur Url
      DELETE
    • Créer un Webhook
      POST
  • Redirections
  • Marque blanche
  • Champs personnalisés
    • Créer une entité avec ses champs personnalisés
      POST
    • Modifier les champs personnalisés d'une entité
      PUT
    • Créer une transaction en renseignant ses champs personnalisés
      POST
  • Organisations
    • Créer une organisation cliente
    • Créer un utilsateur
  • Classeurs
    • Requêtes spécifiques aux classeurs
      • Ajouter des entités à un classeur
      • Supprimer des entités d'un classeur
      • Suppression d'un/plusieurs classeurs avec leur contenu
    • Récupérer les objets d'un classeur
      • Récupérer les transactions d'un classeur
    • Liaisons lors de la création d'un objet
      • Ajouter un objet à un ou plusieurs classeurs à la création
    • Modification des liaisons lors de la modification d'un objet
      • Ajouter un objet à un ou plusieurs classeurs à la modification
      • Supprimer un objet d'un ou plusieurs classeurs à la modification
    • Modification des liaisons entre un objet et les classeurs
      • Ajouter un objet à un/des classeurs
      • Supprimer un objet d'un ou plusieurs classeurs
    • Créer un classeur
    • Modifier un classeur
    • Supprimer un classeur
    • Supprimer plusieurs classeurs
  • Etat des services Docage
  • Créer un Webhook
    POST
  1. Docage Sign

Créer un parcours en une requête

La route https://api.docage.com/Transactions/CreateFullTransaction vous permet de créer (et envoyer) une transaction avec une seule requête via un FormData dans lequel vous renseigner différentes paires de clé/valeur en fonction de la façon dont vous souhaitez construire votre transaction. Voici les clés/valeurs nécessaires pour construire votre transaction :
{
    "Name": "Contrat avec client", 
    "TransactionFiles": 
    [ 
        { 
            "FileName": "Contrat client.pdf", 
            "FriendlyName": "Contrat" 
        } 
    ], 
    "TransactionMembers": 
    [ 
        { 
            "FriendlyName": "Client" 
        } 
    ] 
}
TemplateId -> Copie d'un modèle de transaction : la valeur doit être l'Id de votre modèle de transaction. Lorsque cette clé/valeur est renseignée la transaction générée sera une copie du modèle.
Exemple de valeur pour TemplateId :
          88608c50-1adc-4300-a305-608b983edd79
FriendlyName d'un TransactionMember -> Coordonnées d'un membre : la clé, par exemple Client doit correspondre au FriendlyName d'un des TransactionMembers présent dans la structure de la transaction ou dans le modèle de transaction. La valeur fournie déterminera la provenance du membre :
Un Id -> Utilisation d'un Contact ou DocageUser existant dans ce cas le membre aura les coordonnées du contact ou du DocageUser correspond à cet Id.
Exemple de valeur avec un Id :
          b951514f-1adc-4300-a305-608b983edd79
Un objet Contact -> Création d'un nouveau contact : dans ce cas un nouveau contact sera créé et le membre aura les coordonnées de ce contact. Les propriétés LastName et Email sont obligatoires pour créer un nouveau contact. N'oubliez pas le numéro de mobile si le membre doit signer par SMS.
Exemple de valeur pour un objet Contact :
{
      "LastName": "LEPETIT",
      "FirstName": "Pierre",
      "Email": "plepetit@clientheureux.com",
      "Mobile": "0780885009"
}
FriendlyName d'un TransactionFile -> Contenu d'un document : la clé, par exemple Contrat doit correspondre au FriendlyName d'un des TransactionFiles présent dans la structure de la transaction ou dans le modèle de transaction. La valeur fournie déterminera la génération du TransactionFile :
Un File -> PDF envoyé.
Un Id -> Document Docage : dans ce cas un PDF sera généré à partir du Document Docage correspondant à l'ID.
Exemple de valeur avec un Id de Document Docage :
          a851514f-1adc-4300-a305-608b983edd79
FriendlyName d'un TransactionMember ET FriendlyName d'un TransactionFile -> Signature visuelle séparés par une virgule : la clé, par exemple Client, Contrat doit correspondre aux FriendlyNames d'un TransactionMember et d'un TransactionFile présents dans la structure de la transaction ou dans le modèle de transaction. La valeur doit être un objet TransactionMemberSignatureLocation allégé contenant les propriétés Pages et Coordinates.
Exemple :
{
      "Pages": "1",
      "Coordinates": "0, 0, 100, 100"
}
Modified at 2025-10-24 06:21:01
Previous
Docage Sign
Next
Avec contact existant
Built with