Automatización
Automatice la generación de documentos con las automatizaciones de Lark Base: genere documentos automáticamente cuando se crean o actualizan registros, o cuando se cumplen ciertas condiciones.
1. Active el HTTP Trigger
Sección titulada «1. Active el HTTP Trigger»- Vaya a la pestaña Plantilla.
- Abra la sección Automatización y despliegue HTTP Trigger.
- Copie la URL de webhook que aparece.
2. Configure la automatización en Lark Base
Sección titulada «2. Configure la automatización en Lark Base»- Abra su Base → Automations.
- Cree una automatización nueva.
- Añada un disparador (por ejemplo, “When record is created”).
- Añada la acción Send HTTP Request.
- Configure: Method =
POST, URL = la URL del webhook +?recordId={{record_id}}. - Añada el encabezado:
X-Webhook-API-Key: <su clave de API>.
Formato de la URL del webhook:
https://api.automadoc.cc/api/webhook/templates/{templateId}/generate?recordId={recordId}La clave puede ser la de la propia plantilla o una clave de API de la empresa, que un administrador de la app crea en el Portal de empresa, en Empresa → Claves de API, y que sirve para todas las plantillas. La respuesta enumera los generationIds de los documentos que ha iniciado; GET /api/v1/documents/{generationId} informa del estado de cada uno.
Enviar el documento para firmar
Sección titulada «Enviar el documento para firmar»Para enviar a firmar cada documento generado, dele al paso Send HTTP Request un cuerpo JSON (Content-Type: application/json):
{ "sign": {} }Los firmantes se toman del registro, según lo configurado en Firma por automatización en la pestaña Plantilla; los enlaces y las contraseñas generadas de las personas externas se escriben de vuelta en el registro para que su automatización los envíe por correo. Si prefiere indicar un firmante en la propia solicitud, pase signers por rol, tal como los acepta la API de documentos. Consulte Firma electrónica.
Recetas para cada tipo de disparador
Sección titulada «Recetas para cada tipo de disparador»Todas las recetas terminan con el mismo paso: Send HTTP Request con el método POST, la URL del webhook seguida de ?recordId= y el ID del registro que encontró el disparador, y el encabezado X-Webhook-API-Key. Solo cambia el disparador. Los nombres de los disparadores varían ligeramente entre versiones de Lark.
Cuando se añade un registro: un documento por cada registro nuevo, por ejemplo un presupuesto en cuanto se introduce una solicitud. Elija el disparador de registros nuevos y la tabla.
Cuando se edita un registro: un documento actualizado cuando cambia un registro. Elija el disparador de registros modificados y los campos que hay que vigilar (por ejemplo, solo Amount y Customer), para que una edición sin relación no genere un documento nuevo.
Cuando un registro cumple unas condiciones: un documento en el momento en que un registro llega a un estado, por ejemplo cuando Status pasa a Approved. Es la receta más habitual: se ejecuta una sola vez, cuando la condición empieza a cumplirse.
Cuando se alcanza una fecha: un documento en una fecha del registro, por ejemplo una carta de recordatorio en la Due date o siete días antes. Elija el campo de fecha y el desfase.
Según una programación: documentos a una hora fija, por ejemplo todos los lunes a las 9:00. Una programación no tiene un registro propio, así que añada un paso Find records (por ejemplo, “Status is Open”) y después envíe la solicitud HTTP para los registros encontrados, con su ID de registro. Compruebe en una ejecución de prueba que la solicitud se envía una vez por registro.
Desde AnyCross o cualquier cliente HTTP
Sección titulada «Desde AnyCross o cualquier cliente HTTP»AnyCross y otras herramientas de integración pueden llamar a AutomaDoc con un simple nodo de solicitud HTTP. Para generar a partir de un registro de Base, use el HTTP Trigger descrito arriba. Para generar a partir de datos que no están en una Base (un formulario, un ERP), use la API de documentos, que recibe los datos en JSON:
| Ajuste | Valor |
|---|---|
| Método | POST |
| URL | https://api.automadoc.cc/api/v1/templates/{templateId}/documents?wait=20 |
| Encabezado | X-Webhook-API-Key: la clave de API de su plantilla o de su empresa |
| Encabezado | Content-Type: application/json |
| Cuerpo | {"data": { … los campos de su documento … }} |
Con ?wait=20 la respuesta llega cuando el documento está listo, y su downloadUrl se puede pasar al nodo siguiente, para adjuntar el archivo a un mensaje o guardarlo en Drive.
Cuando se rechaza una solicitud
Sección titulada «Cuando se rechaza una solicitud»Cuando el rechazo tiene que ver con su plan, el HTTP Trigger responde 403 con un code en el cuerpo JSON:
code |
Por qué | Qué hacer |
|---|---|---|
AUTOMATION_NOT_INCLUDED |
Su empresa no tiene plan Pro, ni una prueba activa, ni un puesto Business. | Compre un puesto Business o Pro en la página Facturación del Portal de empresa. |
QUOTA_EXCEEDED |
Se han agotado los documentos automatizados incluidos en sus puestos Business y la cuota mensual gratuita, y ningún paquete de documentos tiene saldo. | Compre un paquete de documentos en la página Facturación, o espere al siguiente periodo. |
TEMPLATE_DISABLED |
La plantilla está bloqueada: su empresa tiene más plantillas de las que permite su plan. | Amplíe el límite de plantillas en la página Facturación (un plan, puestos o Plantillas adicionales), o elimine una plantilla. Una plantilla bloqueada vuelve en un plazo de 24 horas. |
Si falta X-Webhook-API-Key, la respuesta es 401 (API_KEY_MISSING); si la clave es incorrecta o no abre esta plantilla, 403 (API_KEY_INVALID).
El HTTP Trigger acepta 300 solicitudes por minuto por plantilla, un límite propio: una automatización de Lark envía cada registro una sola vez y no reintenta, por lo que no se le aplican las 60 de la API de documentos. Sus documentos cuentan para los 600 por minuto de la empresa, compartidos con la API de documentos. Si se supera alguno de los dos límites, responde 429 (RATE_LIMITED) y no genera ningún documento para esa solicitud, así que reparta una importación muy grande en varios minutos. Cualquier otro rechazo también tiene un code, por ejemplo RECORD_ID_REQUIRED (400, falta recordId) y WORKER_UNAVAILABLE (502, inténtelo de nuevo en breve).
Notificaciones salientes
Sección titulada «Notificaciones salientes»Reciba una notificación cuando se generen los documentos. Perfecto para encadenar automatizaciones.
- En la pestaña Plantilla, abra la sección Automatización y active Callback de Webhook.
- Introduzca la URL de su webhook.
- Opcionalmente, añada un token Bearer para la autenticación.
AutomaDoc envía un POST con este cuerpo JSON:
{ "url": "https://api.automadoc.cc/...?expires=...&signature=...", "filename": "Invoice-INV-2024-001.pdf", "fields": { "Customer_Name": "Acme Corp", "Total_Amount": "1,500.00" }}url: enlace de descarga firmado, válido durante 2 horas.filename: el nombre final, tras aplicar el patrón de nombre de archivo.fields: los valores simples del registro utilizados para la generación: texto, números, fechas y similares, tal como los imprime el documento. Los registros vinculados, las listas y los adjuntos no se incluyen.warnings: solo cuando la generación advirtió de algo, como una imagen que no se pudo obtener (indicada por su campo y el host de la URL).
Si define el token Bearer, se envía en el encabezado Authorization.
Casos de uso
Sección titulada «Casos de uso»- Encadenar otras automatizaciones de Lark
- Enviar notificaciones por Lark Messenger mediante bots
- Integrarse con flujos de Lark Approval: para generar un documento cuando se aprueba una solicitud, consulte Documentos de aprobación, que no necesita ninguna automatización
- Archivar documentos en Lark Docs o Drive