Editar processo

POST/{resource}/editchave privadaprk_

Este serviço permite colocar um processo em estado de edição para reenviá-lo com alterações: substituir o PDF, corrigir os dados de um contrato ou adicionar e remover documentos de um pacote.

A edição tem duas etapas. Primeiro você marca o processo com este serviço e depois o sobrescreve reenviando o payload completo ao serviço de criação correspondente. O processo mantém seu identificador.

{resource} indica o que você está editando e aceita dois valores:

Recurso	O que edita	Identificador
`document`	Um documento ou um contrato	`code`, 9 ou 10 caracteres
`package`	Um pacote e todos os seus documentos	`package`, 24 caracteres

atenção

Colocar um processo em edição reinicia as assinaturas. As assinaturas coletadas, as validações de identidade e os links já enviados aos participantes são descartados. Ao reenviá-lo, todos são notificados novamente com novos links.

Não há como cancelar uma edição: um processo marcado fica aguardando até que você o reenvie.

Autenticação

Inclua sua chave privada no cabeçalho Authorization.

Authorization: prk_xxx...

Marcar o processo

Parâmetros

Nome	Tipo	Descrição
`code`	String condicional	Código do documento ou do contrato. Somente para `/document/edit`.
`package`	String condicional	Identificador do pacote, 24 caracteres. Somente para `/package/edit`.

Requisitos do processo

Você só pode editar um processo que não esteja assinado, rejeitado, expirado ou já em edição. Um contrato também deve estar com status aprovado.

Um documento que pertence a um pacote não é editado isoladamente: edite o pacote inteiro.

curl
Python
Node.js

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"
}'

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)

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);
  });

Resposta

{
  "message": "PACKAGE_MODIFIED"
}

Para um documento, a resposta é DOCUMENT_MODIFIED.

Ler o processo em edição

GET/{resource}/editchave privadaprk_

Retorna o processo marcado, com links de download de seus PDFs válidos por 5 minutos. Use-o para inspecionar o que está em edição; o payload que você reenvia é o seu.

Nome	Tipo	Descrição
`code`	String condicional	Código do documento ou do contrato. Somente para `/document/edit`.
`package`	String condicional	Identificador do pacote. Somente para `/package/edit`.

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

Um pacote retorna seus dados e o detalhe de cada documento em 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" }]
    }
  ]
}

Sobrescrever o processo

Depois de marcado, reenvie o processo ao seu serviço de criação junto com o identificador. O payload é o mesmo de uma criação normal, com um campo a mais:

Processo	Serviço	Campo identificador
Documento ou contrato	Enviar PDF ou Criar a partir de um modelo	`code`
Pacote	Criar pacote	`package`

O reenvio substitui tudo

Tudo o que você omitir é removido. Se omitir folder, o processo vai para a raiz; se omitir tags, ele ficará sem nenhuma. Reenvie o payload completo, e não apenas o que mudou.

O identificador e a data de criação são preservados.

Em um pacote, os documentos do envio anterior são excluídos e novos códigos são gerados — é isso que permite adicionar e remover arquivos livremente. Os créditos do pacote anterior são devolvidos e os novos são cobrados, de modo que você acaba pagando pelo número final de documentos.

O id dos signatários que a Auco não notifica também é regenerado na sobrescrita, tanto em documentos quanto em pacotes. Qualquer acesso que você tenha entregue com os anteriores deixa de funcionar: pegue os novos na resposta ou leia-os com 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" }
            ]
        }
    ]
}'

Erros

Mensagem	Causa
`DOCUMENT_NOT_FOUND`	O documento não existe, não é seu ou não está em um estado editável
`PACKAGE_NOT_FOUND`	Idem para um pacote. Na sobrescrita, também quando o pacote não está marcado para edição
`PACKAGE_ID_INVALID`	O identificador do pacote não tem 24 caracteres hexadecimais
`INVALID_RESOURCE`	O `{resource}` no caminho não é `document` nem `package`

Autenticação​

Marcar o processo​

Parâmetros​

Requisitos do processo​

Resposta​

Ler o processo em edição​

Sobrescrever o processo​

Erros​