Modifier un processus

POST/{resource}/editclé privéeprk_

Ce service vous permet de placer un processus en état de modification afin de pouvoir le renvoyer avec des changements : remplacer le PDF, corriger les données d’un contrat, ou ajouter et supprimer des documents d’un lot.

La modification se déroule en deux étapes. Vous marquez d’abord le processus avec ce service, puis vous l’écrasez en renvoyant la charge utile complète au service de création correspondant. Le processus conserve son identifiant.

{resource} indique ce que vous modifiez et accepte deux valeurs :

Ressource	Ce qu’elle modifie	Identifiant
document	Un document ou un contrat	code, 9 ou 10 caractères
package	Un lot et tous ses documents	package, 24 caractères

attention

Placer un processus en modification réinitialise les signatures. Les signatures recueillies, les validations d’identité et les liens déjà envoyés aux participants sont supprimés. Lorsque vous le renvoyez, chacun est de nouveau notifié avec de nouveaux liens.

Il n’est pas possible d’annuler une modification : un processus marqué reste en attente jusqu’à ce que vous le renvoyiez.

---

Authentification

Incluez votre clé privée dans l'en-tête Authorization.

Authorization: prk_xxx...

---

Marquer le processus

Paramètres

Nom	Type	Description
code	String conditionnel	Code du document ou du contrat. Uniquement pour /document/edit.
package	String conditionnel	Identifiant du lot, 24 caractères. Uniquement pour /package/edit.

Conditions requises du processus

Vous ne pouvez modifier qu’un processus qui n’est pas signé, rejeté, expiré ou déjà en modification. Un contrat doit en outre avoir le statut approuvé.

Un document appartenant à un lot ne se modifie pas isolément : modifiez le lot entier.

curl

curl --location 'https://api.auco.ai/v1.5/ext/package/edit' \
--header 'Authorization: prk_private_key_company' \
--header 'Content-Type: application/json' \
--data-raw '{
    "package": "6a95b55966dd1c779500b962"
}'

Python

import requests
import json

url = "https://api.auco.ai/v1.5/ext/package/edit"

payload = json.dumps({
  "package": "6a95b55966dd1c779500b962"
})
headers = {
  'Authorization': 'prk_private_key_company',
  'Content-Type': 'application/json'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

Node.js

const axios = require('axios');
let data = JSON.stringify({
  package: '6a95b55966dd1c779500b962',
});

let config = {
  method: 'post',
  maxBodyLength: Infinity,
  url: 'https://api.auco.ai/v1.5/ext/package/edit',
  headers: {
    Authorization: 'prk_private_key_company',
    'Content-Type': 'application/json',
  },
  data: data,
};

axios
  .request(config)
  .then((response) => {
    console.log(JSON.stringify(response.data));
  })
  .catch((error) => {
    console.log(error);
  });

Réponse

{
  "message": "PACKAGE_MODIFIED"
}

Pour un document, la réponse est DOCUMENT_MODIFIED.

---

Lire le processus en modification

GET/{resource}/editclé privéeprk_

Renvoie le processus marqué, avec des liens de téléchargement de ses PDF valables 5 minutes. Utilisez-le pour consulter ce qui est en modification ; la charge utile que vous renvoyez reste la vôtre.

Nom	Type	Description
code	String conditionnel	Code du document ou du contrat. Uniquement pour /document/edit.
package	String conditionnel	Identifiant du lot. Uniquement pour /package/edit.

curl --location 'https://api.auco.ai/v1.5/ext/package/edit?package=6a95b55966dd1c779500b962' \
--header 'Authorization: prk_private_key_company'

Un lot renvoie ses données et le détail de chaque document dans documents :

{
  "name": "Lease agreements",
  "subject": "Sign the agreements",
  "message": "Please sign the attached documents",
  "signers": [{ "name": "Luz Marina López", "email": "luz@example.com", "status": "pending" }],
  "documents": [
    {
      "code": "CRSD8I9AJ1",
      "name": "Lease agreement",
      "url": "https://documents.auco.ai/...",
      "signProfile": [{ "name": "Luz Marina López", "email": "luz@example.com" }]
    }
  ]
}

---

Écraser le processus

Une fois le processus marqué, renvoyez-le à son service de création avec son identifiant. La charge utile est la même que pour une création classique, avec un champ supplémentaire :

Processus	Service	Champ d’identifiant
Document ou contrat	Téléverser un PDF ou Créer à partir d’un modèle	code
Lot	Créer un lot	package

Le renvoi remplace tout

Tout ce que vous omettez est supprimé. Si vous omettez folder, le processus passe à la racine ; si vous omettez tags, il n’en aura aucune. Renvoyez la charge utile complète, et pas seulement ce qui a changé.

L’identifiant et la date de création sont conservés.

Dans un lot, les documents de l’envoi précédent sont supprimés et de nouveaux codes sont générés, ce qui vous permet d’ajouter et de retirer des fichiers librement. Les crédits du lot précédent sont remboursés et les nouveaux sont débités ; vous ne payez donc que le nombre final de documents.

L’id des signataires qu’Auco ne notifie pas est lui aussi régénéré lors de l’écrasement, pour les documents comme pour les lots. Tout accès que vous aviez fourni avec les précédents cesse de fonctionner : récupérez les nouveaux dans la réponse ou consultez-les avec GET /document.

curl --location 'https://api.auco.ai/v1.5/ext/document/many' \
--header 'Authorization: prk_private_key_company' \
--header 'Content-Type: application/json' \
--data-raw '{
    "package": "6a95b55966dd1c779500b962",
    "email": "manager@auco.ai",
    "name": "Lease agreements",
    "documents": [
        {
            "name": "Lease agreement",
            "signProfile": [
                { "name": "Luz Marina López", "email": "luz@example.com", "type": "signature" }
            ]
        }
    ]
}'

---

Erreurs

Message	Cause
DOCUMENT_NOT_FOUND	Le document n’existe pas, ne vous appartient pas ou n’est pas dans un état modifiable
PACKAGE_NOT_FOUND	Idem pour un lot. Lors de l’écrasement, également lorsque le lot n’est pas marqué en modification
PACKAGE_ID_INVALID	L’identifiant du lot ne comporte pas 24 caractères hexadécimaux
INVALID_RESOURCE	Le {resource} du chemin n’est ni document ni package