Obter modelo por ID

Este serviço permite obter os detalhes completos de um modelo específico usando seu id. É útil para consultar a configuração, os campos, os perfis de assinatura e os metadados de um modelo antes de usá-lo em processos de assinatura ou modificações.

GET/template?id={templateId}chave públicapuk_

---

Autenticação

Inclua sua chave pública no cabeçalho Authorization.

Authorization: puk_xxx...

---

Parâmetros da requisição

Propriedade	Tipo	Obrigatório	Descrição
id	string	Obrigatório	Identificador único do modelo

Exemplos de requisição

curl

curl -X GET "https://api.auco.ai/v1.5/ext/template?id=template_id" \
  -H "Authorization: your_public_key"

Python

import requests

def get_template(template_id):
    """
    Obtém os detalhes de um modelo específico

    Args:
        template_id (str): ID do modelo a ser obtido
    """
    url = "https://api.auco.ai/v1.5/ext/template"
    params = {
        "id": template_id
    }
    headers = {
        "Authorization": "your_public_key"
    }

    try:
        response = requests.get(url, params=params, headers=headers)
        response.raise_for_status()

        data = response.json()
        print(f"Modelo obtido: {data['name']}")
        print(f"Campos: {len(data['config'])}")

        return data

    except requests.exceptions.RequestException as error:
        detail = (
            error.response.json()
            if hasattr(error, "response") and error.response is not None
            else error
        )
        print(f"Erro ao obter o modelo: {detail}")

if __name__ == "__main__":
    # Substitua pelo seu template_id
    get_template("template_id")

Node.js

const axios = require('axios');

/**
 * Obtém os detalhes de um modelo específico
 * @param {string} templateId - ID do modelo a ser obtido
 */
async function getTemplate(templateId) {
  try {
    const response = await axios.get(
      'https://api.auco.ai/v1.5/ext/template',
      {
        params: {
          id: templateId,
        },
        headers: {
          Authorization: 'your_public_key',
        },
      }
    );

    const data = response.data;
    console.log(`Modelo obtido: ${data.name}`);
    console.log(`Campos: ${data.config.length}`);

    return data;
  } catch (error) {
    console.error(
      'Erro ao obter o modelo:',
      error.response?.data || error.message
    );
  }
}

// Substitua pelo seu template_id
getTemplate('template_id');

---

Exemplo de resposta

{
  "id": "template_id",
  "name": "Teste de modificação de variáveis do documento",
  "description": "Contrato de serviço com um único signatário, para a equipe de vendas",
  "config": [
    {
      "name": "name_cliente",
      "type": "name",
      "description": "Informe o nome do cliente"
    },
    {
      "description": "Selecione o tipo de documento do cliente",
      "name": "document_type_cliente",
      "type": "clausula",
      "value": "cc",
      "options": [
        {
          "name": "Cédula de cidadania",
          "value": "cc"
        },
        {
          "name": "Cédula de estrangeiro",
          "value": "ce"
        }
      ]
    },
    {
      "description": "Informe o número da cédula de cidadania do cliente",
      "name": "cedula_cliente",
      "type": "number",
      "prereq": [
        {
          "k": "document_type_cliente",
          "v": "cc"
        }
      ]
    },
    {
      "description": "Informe o número da cédula de estrangeiro do cliente",
      "name": "cedulae_cliente",
      "type": "number",
      "prereq": [
        {
          "k": "document_type_cliente",
          "v": "ce"
        }
      ]
    },
    {
      "name": "email_cliente",
      "type": "email",
      "description": "Informe o e-mail do cliente"
    },
    {
      "name": "phone_cliente",
      "type": "phone",
      "description": "Informe o número de telefone do cliente"
    }
  ],
  "sign": [
    "name_cliente",
    "cedula_cliente",
    "cedulae_cliente",
    "email_cliente",
    "phone_cliente"
  ],
  "signatureProfile": [
    {
      "email": "email_cliente",
      "phone": "phone_cliente",
      "identification": "cedula_cliente|cedulae_cliente",
      "name": "name_cliente",
      "type": "cliente"
    }
  ],
  "preBuild": false,
  "urls": {
    "mask": "https://signed_url_mask",
    "complete": "https://signed_url_complete"
  }
}

Propriedades da resposta

Propriedade	Tipo	Descrição
id	string	Identificador único do modelo
name	string	Nome do modelo
description	string	Opcional. Texto que descreve o modelo, com até 500 caracteres. Só aparece se o modelo tiver uma definida
config	array	Array de perguntas/campos do modelo
config[].name	string	Identificador único do campo
config[].type	string	Tipo de pergunta (text, name, email, etc.)
config[].description	string	Texto exibido ao usuário
config[].value	string	Valor padrão (opcional)
config[].options	array	Opções disponíveis para campos clausula/select
config[].prereq	array	Condições para exibir o campo (opcional)
sign	array	Nomes das perguntas obrigatórias
signatureProfile	array	Configuração dos signatários
signatureProfile[].name	string	Campo com o nome do signatário
signatureProfile[].identification	string	Campo(s) de identificação (separados por |)
signatureProfile[].email	string	Campo com o e-mail do signatário
signatureProfile[].phone	string	Campo com o telefone do signatário
signatureProfile[].type	string	Identificador da assinatura (ex.: cliente, vendedor)
preBuild	boolean	Indica se o modelo inclui preenchimento automático
urls.mask	string	URL assinada para baixar o HTML Mask. Expira após 120 segundos
urls.complete	string	URL assinada para baixar o HTML Complete. Expira após 120 segundos

description não identifica um modelo

description é um texto livre que você define ao criar ou atualizar o modelo, e só é retornada quando o modelo tem uma definida. Não a use como identificador: para isso existe o id.

---

⚠️ Respostas de erro

Código	Descrição
400	Modelo não encontrado: TEMPLATE_NOT_FOUND (o id não corresponde a um modelo da sua organização)
401	Autenticação inválida ou ausente