Obtenir un modèle par ID

Ce service vous permet de récupérer le détail complet d'un modèle spécifique à partir de son id. Il est utile pour consulter la configuration, les champs, les profils de signature et les métadonnées d'un modèle avant de l'utiliser dans des processus de signature ou des modifications.

GET/template?id={templateId}clé publiquepuk_

---

Authentification

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

Authorization: puk_xxx...

---

Paramètres de la requête

Propriété	Type	Obligatoire	Description
id	string	Obligatoire	Identifiant unique du modèle

Exemples de requête

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):
    """
    Récupère le détail d'un modèle spécifique

    Args:
        template_id (str): ID du modèle à récupérer
    """
    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"Modèle récupéré : {data['name']}")
        print(f"Champs : {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"Erreur lors de la récupération du modèle : {detail}")

if __name__ == "__main__":
    # Remplacez par votre template_id
    get_template("template_id")

Node.js

const axios = require('axios');

/**
 * Récupère le détail d'un modèle spécifique
 * @param {string} templateId - ID du modèle à récupérer
 */
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(`Modèle récupéré : ${data.name}`);
    console.log(`Champs : ${data.config.length}`);

    return data;
  } catch (error) {
    console.error(
      'Erreur lors de la récupération du modèle :',
      error.response?.data || error.message
    );
  }
}

// Remplacez par votre template_id
getTemplate('template_id');

---

Exemple de réponse

{
  "id": "template_id",
  "name": "Test de modification des variables du document",
  "description": "Contrat de service avec un seul signataire, pour l'équipe commerciale",
  "config": [
    {
      "name": "name_cliente",
      "type": "name",
      "description": "Saisissez le nom du client"
    },
    {
      "description": "Sélectionnez le type de document du client",
      "name": "document_type_cliente",
      "type": "clausula",
      "value": "cc",
      "options": [
        {
          "name": "Carte d'identité de citoyen",
          "value": "cc"
        },
        {
          "name": "Carte d'identité d'étranger",
          "value": "ce"
        }
      ]
    },
    {
      "description": "Saisissez le numéro de carte d'identité de citoyen du client",
      "name": "cedula_cliente",
      "type": "number",
      "prereq": [
        {
          "k": "document_type_cliente",
          "v": "cc"
        }
      ]
    },
    {
      "description": "Saisissez le numéro de carte d'identité d'étranger du client",
      "name": "cedulae_cliente",
      "type": "number",
      "prereq": [
        {
          "k": "document_type_cliente",
          "v": "ce"
        }
      ]
    },
    {
      "name": "email_cliente",
      "type": "email",
      "description": "Saisissez l'e-mail du client"
    },
    {
      "name": "phone_cliente",
      "type": "phone",
      "description": "Saisissez le numéro de téléphone du client"
    }
  ],
  "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"
  }
}

Propriétés de la réponse

Propriété	Type	Description
id	string	Identifiant unique du modèle
name	string	Nom du modèle
description	string	Facultatif. Texte décrivant le modèle, jusqu'à 500 caractères. N'apparaît que si le modèle en possède une
config	array	Tableau des questions/champs du modèle
config[].name	string	Identifiant unique du champ
config[].type	string	Type de question (text, name, email, etc.)
config[].description	string	Texte affiché à l'utilisateur
config[].value	string	Valeur par défaut (facultatif)
config[].options	array	Options disponibles pour les champs clausula/select
config[].prereq	array	Conditions d'affichage du champ (facultatif)
sign	array	Noms des questions obligatoires
signatureProfile	array	Configuration des signataires
signatureProfile[].name	string	Champ contenant le nom du signataire
signatureProfile[].identification	string	Champ(s) d'identification (séparés par |)
signatureProfile[].email	string	Champ contenant l'e-mail du signataire
signatureProfile[].phone	string	Champ contenant le téléphone du signataire
signatureProfile[].type	string	Identifiant de la signature (par ex. : cliente, vendedor)
preBuild	boolean	Indique si le modèle inclut un pré-remplissage automatique
urls.mask	string	URL signée pour télécharger le HTML Mask. Expire après 120 secondes
urls.complete	string	URL signée pour télécharger le HTML Complete. Expire après 120 secondes

description n'identifie pas un modèle

description est un texte libre que vous définissez lorsque vous créez ou mettez à jour le modèle, et elle n'est renvoyée que si le modèle en possède une. Ne l'utilisez pas comme identifiant : c'est le rôle de id.

---

⚠️ Réponses d'erreur

Code	Description
400	Modèle introuvable : TEMPLATE_NOT_FOUND (l'id ne correspond à aucun modèle de votre organisation)
401	Authentification invalide ou manquante