Docage API
French
  • French
  • Spanish
    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

    Docage Sign

    Docage Sign permet de créer des parcours de signature et/ou de validation. Un parcours est représenté par un objet Transaction. En complément de cette documentation, toutes les propriétés et routes des Transactions sont sur notre page Swagger Docage.
    En plus de ses propriétés, une transaction possède des collections indispensables.
    TransactionFiles : Ce sont les fichiers de la transaction qui peuvent être des documents PDF ou des documents Docage (créé avec Docage Doc)
    TransactionMembers : Ce sont les membres de la transaction à qui vous demandez de réaliser une ou plusieurs actions. Lorsqu'il est signataire un membre peut avoir une collection de signatures visuelles (TransactionMemberSignatureLocations), elles sont facultatives mais utilisées dans pratiquement tous les cas pour faciliter la visualisation des signatures sans consulter les certificats.
    TransactionActions : Ce sont les actions de la transaction. Une action peut être de 3 types :
    Form : pour remplir un formulaire
    Exemple : faire remplir à un client ses coordonnées complètes qui seront ensuite reprises dans le contrat
    Validation : pour valider les documents de la transaction
    Exemple : faire valider un contrat pour le service juridique avant signature du client
    Signature : pour signer les documents de la transaction
    TransactionObservers : Ce sont les observateur de la transaction, c'est à dire des personnes qui n'agiront pas mais qui seront notifiées par email de l'avancement de la transaction.
    Nous avons simplifié au maximum la création d'un parcours dans notre route CreateFullTransaction (Création en une requête), celle-ci vous évite d'avoir à créer les collections intermédiaires, vous ne fournissez que les informations minimales et l'API fera le reste.
    La propriété Status permet de suivre l'avancement de la transaction. Le statut évolue en fonction des actions des membres de la transaction et en fonction des actions de utilisateurs Docage qui ont le droit de modifier la transaction.

    Enumération de Status de Transaction:#

    ValeurDescription
    -100All : utilisé uniquement dans les Webhooks
    0Draft : transaction créée mais non envoyée
    1Scheduled : transaction créée et sera envoyée à la date indiquée
    2FormToFill : transaction envoyée et au moins un formulaire n'a pas été rempli
    3Active : transaction envoyée
    4Validated : transaction validée par tous les validateurs
    5Signed : transaction signée par tous les signataires
    6Expired : transaction expirée
    7Refused : transaction refusée par au moins un membre
    8Aborted : transaction annulée
    Modified at 2025-10-24 06:21:01
    Previous
    Trier les contacts par leur prénom, puis par leur nom en ordre décroissant
    Next
    Créer un parcours en une requête
    Built with