Configuración de la empresa por API
Qué resuelve
Sección titulada «Qué resuelve»La empresa decide cómo se ven y cómo se emiten sus documentos: con qué logo, con qué plantilla, en qué modo se emiten por defecto las boletas de honorarios, las facturas y las boletas, qué información de pago se imprime y con qué clave se conecta a ValidaFirma. Esta ficha deja que un agente haga por API lo que la persona hace en el panel, en Configuración. Son setenta y siete operaciones, con las mismas reglas y los mismos mensajes de rechazo que el panel.
Esta ficha cubre la configuración documental de la empresa y su configuración general: topes de ValidaFirma, registro de llamadas de las llaves, suscripción, PIN, canal de agentes, ventas y correo. No incluye las llaves de API: una llave no administra llaves. Otras partes de la configuración tienen su propia ficha, por ejemplo Configuración de Comunicación.
| Para | Operaciones |
|---|---|
| La clave de ValidaFirma | obtenerConfiguracionValidafirma, crearConfiguracionValidafirma, actualizarConfiguracionValidafirma, eliminarConfiguracionValidafirma |
| El logo de la empresa | subirLogoDeEmpresa, obtenerLogoDeEmpresa, eliminarLogoDeEmpresa |
| El modo de emisión por defecto | obtenerConfiguracionBhe y actualizarConfiguracionBhe; lo mismo para Bhet, Dte y Boleta |
| La caché de contribuyentes | obtenerCacheDeContribuyentes, actualizarCacheDeContribuyentes |
| La información de pago de los documentos | obtenerInformacionDePago, actualizarInformacionDePago, eliminarInformacionDePago |
| El catálogo de plantillas de la plataforma | listarPlantillasDelCatalogo, obtenerPlantillaDelCatalogo, listarTiposDeDocumentoDePlantilla, listarFormatosDePapel |
| Las vistas previas | generarVistaPreviaDePlantilla, generarVistaPreviaDePlantillaConDatos, generarVistaPreviaDePlantillaDeEmpresa |
| Las plantillas que eligió la empresa | obtenerPlantillasDeEmpresa, actualizarPlantillasDeEmpresa, listarOpcionesDePlantilla |
| Los topes de ValidaFirma | obtenerTopesDeValidaFirma, obtenerHistorialDeProteccionValidaFirma, crearSolicitudDeTopeValidaFirma |
| El registro de llamadas de las llaves | listarLlamadasDeLlaves |
| La suscripción | listarAdicionalesDeMiSuscripcion, obtenerAdicionalDeMiSuscripcion, obtenerPlanDeMiSuscripcion, obtenerResumenDePagosDeMiSuscripcion |
| El PIN | listarIntegracionesPin, crearIntegracionPin, actualizarIntegracionPin, desactivarIntegracionPin, reactivarIntegracionPin, obtenerEstadisticasDeIntegracionPin |
| El canal de agentes | listarActividadDelCanalDeAgentes, listarOpcionesDeActividadDelCanalDeAgentes, listarConexionesDelCanalDeAgentes, listarHechosDelCanalDeAgentes, obtenerEstadoDelCanalDeAgentes, desactivarCanalDeAgentes, activarCanalDeAgentes, quitarConexionDelCanalDeAgentes |
| Las casillas de ventas | listarCasillasDeVentas, listarAlertasDeCasillasDeVentas, reclamarCasillaDeVentas, quitarCasillaDeVentas |
| Los campos de la nota | listarCamposDeLaNota, crearCampoDeLaNota, obtenerCampoDeLaNota, actualizarCampoDeLaNota, archivarCampoDeLaNota |
| La configuración de correo y sus identidades | obtenerConfiguracionDeCorreo, actualizarConfiguracionDeCorreo, listarIdentidadesDeCorreo, crearIdentidadDeCorreo, actualizarIdentidadDeCorreo, eliminarIdentidadDeCorreo, verificarConexionDeIdentidadDeCorreo, enviarPruebaDeIdentidadDeCorreo |
| Las plantillas de correo | listarPlantillasDeCorreo, listarAsignacionesDePlantillasDeCorreo, obtenerContenidoPorDefectoDePlantillaDeCorreo, obtenerPlantillaDeCorreo, crearPlantillaDeCorreo, actualizarPlantillaDeCorreo, eliminarPlantillaDeCorreo, generarVistaPreviaDePlantillaDeCorreo |
La clave de ValidaFirma se escribe y no se lee
Sección titulada «La clave de ValidaFirma se escribe y no se lee»Ninguna operación devuelve la clave de ValidaFirma, ni siquiera a la llave que la escribió. Las respuestas traen claveConfigurada (true o false) y si la integración está activo, nada más. Si necesitas saber si hay una clave, lee claveConfigurada; si
la persona perdió la clave, no hay cómo recuperarla por API: se reemplaza por una nueva.
crearConfiguracionValidafirmaguarda la clave y activa la integración. Responde409si la empresa ya tiene una configuración: para cambiarla, usa la operación de actualizar.actualizarConfiguracionValidafirmaactiva o desactiva la integración y, sólo si mandasapiKey, reemplaza la clave. UnPUTsinapiKeyconserva la clave guardada: para activar o desactivar no necesitas conocerla.eliminarConfiguracionValidafirmaborra la clave y la configuración. Responde404si no había configuración.
No imprimas la clave, no la pidas por el chat ni la dejes en un archivo versionado. La persona la escribe o la deja en un archivo fuera del repositorio, y tú la lees de ahí sólo para armar el cuerpo.
La contraseña SMTP se escribe y no se lee
Sección titulada «La contraseña SMTP se escribe y no se lee»Ninguna operación de correo devuelve la contraseña SMTP, ni a la llave que la escribió. Una identidad responde hasPassword (true o false) y nunca la contraseña, ni cifrada, ni su sal ni su huella. Si la persona la perdió, no hay cómo recuperarla por API: se reemplaza por otra con actualizarIdentidadDeCorreo.
No pongas la contraseña en la línea de comandos ni en el chat. Con el CLI, el cuerpo de correo identidades crear y correo identidades actualizar va por --cuerpo @archivo (un archivo fuera del repositorio) o por la entrada estándar con --cuerpo -; el CLI no imprime el cuerpo.
Qué necesitas antes
Sección titulada «Qué necesitas antes»- Una llave con acceso a la configuración. La llave del proyecto que instala
redcumbre initesFULL-APIy alcanza. Las operaciones de plantillas declaran el rol de administración de plantillas;redcumbre api describir actualizarPlantillasDeEmpresamuestra el rol exacto de cada una. - El archivo de la llave en el proyecto, como en Modo de prueba y producción. No lo leas, no lo imprimas ni le pidas a la persona que pegue el secreto en el chat.
- Un cuerpo sólo con los campos que la operación declara: un campo de más responde
400y no se guarda nada. - Paginación, errores y límites: Reglas comunes.
Cómo se comporta el modo de prueba
Sección titulada «Cómo se comporta el modo de prueba»Con una llave de prueba, las setenta y siete operaciones responden desde un conjunto de ejemplo y no guardan nada: ni la clave de ValidaFirma, ni el logo, ni los modos, ni las plantillas, ni los topes, ni el PIN, ni el canal, ni las casillas, ni el correo de la empresa. Las lecturas devuelven los datos del conjunto de ejemplo
(una empresa sintética, RUT 76.123.456-0); las escrituras validan el cuerpo como en producción y responden como si hubieran guardado, sin cambiar nada y sin llamar a ValidaFirma. Ninguna se cobra.
-
El logo de prueba es una imagen de ejemplo del sitio de documentación:
obtenerLogoDeEmpresadevuelve/ejemplos/logo-de-ejemplo.png, que se abre enhttps://docs.redcumbre.cl/ejemplos/logo-de-ejemplo.png.subirLogoDeEmpresaresponde como subido yeliminarLogoDeEmpresacomo eliminado, sin tocar el logo de la empresa. -
La configuración de ValidaFirma de prueba trae
claveConfigurada: true, sin haber leído la clave de la empresa. -
La vista previa de la empresa se arma con una empresa de ejemplo y su logo de ejemplo.
-
El catálogo de plantillas, los tipos de documento y los formatos de papel son fijos y no dependen de ninguna empresa: con una llave de prueba responden igual que en producción.
-
El registro de llamadas de prueba (
listarLlamadasDeLlaves) responde las llamadas de la empresa hechas en modo de prueba, y no las de producción. -
El contenido por defecto de una plantilla de correo (
obtenerContenidoPorDefectoDePlantillaDeCorreo) es del sistema y no depende de la empresa: responde igual que en producción. -
Las acciones del canal, del PIN, de las casillas y del correo (apagar, prender, quitar una conexión, crear una integración, tomar una casilla, enviar un correo de prueba) validan el cuerpo como en producción y responden como hechas, sin cambiar nada ni enviar nada.
Eso confirma que la llave, el rol y el cuerpo son correctos; no confirma que algo se haya guardado.
Cada paso usa el subcomando de redcumbre configuracion. Todos trabajan con la llave de prueba; para producción agrega --produccion --confirmar <slug-de-la-empresa>, y con --ensayo ves la petición sin hacerla. La alternativa genérica es redcumbre api <operationId>.
1. Ubica las operaciones
Sección titulada «1. Ubica las operaciones»redcumbre buscar "configuración de la empresa"redcumbre api describir obtenerConfiguracionValidafirmaResultado esperado: las operaciones de esta ficha, con su método, su ruta y los campos del cuerpo.
2. Revisa la clave de ValidaFirma
Sección titulada «2. Revisa la clave de ValidaFirma»redcumbre configuracion validafirma verResultado esperado: si la integración está activa y claveConfigurada, sin la clave. Para guardar una nueva por primera vez:
{ "apiKey": "clave-de-prueba"}Para activar o desactivar sin cambiar la clave, manda sólo activo; si además quieres reemplazarla, suma apiKey:
{ "activo": true}redcumbre configuracion validafirma actualizar --activo trueResultado esperado: la configuración con claveConfigurada: true y el valor de activo; la clave no aparece en la respuesta. actualizar --activo no toca la clave. Para borrar la configuración: redcumbre configuracion validafirma quitar.
El CLI no lleva la clave. Ningún comando de redcumbre acepta un cuerpo con apiKey, ni por --cuerpo ni por redcumbre api: sale con código 2 y CUERPO_CON_CREDENCIAL, antes de llamar al API, para que la clave no pase por la terminal ni por el agente. Guardarla por primera vez o reemplazarla se hace desde el código del integrador, con una llamada HTTP a crearConfiguracionValidafirma o actualizarConfiguracionValidafirma y la llave en el encabezado, o desde el panel de la empresa.
3. Sube, lee o elimina el logo
Sección titulada «3. Sube, lee o elimina el logo»redcumbre configuracion logo subir --archivo logo.pngredcumbre configuracion logo verredcumbre configuracion logo quitarResultado esperado: tras subir, la URL del logo; obtenerLogoDeEmpresa devuelve la URL, o null si la empresa no tiene logo. La imagen es JPEG, PNG, GIF o WEBP de hasta 2 MB, va en el campo logo del formulario y se redimensiona. Un campo de texto de más responde 400.
Eliminar un logo que no existe responde 404.
4. Elige el modo de emisión por defecto
Sección titulada «4. Elige el modo de emisión por defecto»Hay un modo por tipo de documento: boletas de honorarios (Bhe), boletas de honorarios de terceros (Bhet), documentos tributarios (Dte) y boletas electrónicas (Boleta). Cada uno se lee y se cambia con su propio par de operaciones.
{ "bheModoDefault": "SINC_COMPLETO"}{ "bhetModoDefault": "SINC_PARCIAL"}{ "dteModoDefault": "ASINCRONO"}{ "boletaModoDefault": "SINCRONO"}redcumbre configuracion bhe verredcumbre configuracion bhe cambiar --modo SINC_COMPLETOLos otros tres tipos usan el mismo par: redcumbre configuracion bhet ver|cambiar, redcumbre configuracion dte ver|cambiar y redcumbre configuracion boleta ver|cambiar, cada uno con --modo.
Resultado esperado: el modo por defecto guardado. Los valores válidos son SINC_COMPLETO, SINC_PARCIAL y ASINCRONO para Bhe, Bhet y Dte, y SINCRONO y ASINCRONO para Boleta. Un valor fuera de esa lista responde 400.
Es el modo por defecto de la empresa; qué hace cada modo al emitir está en Emisión.
5. Ajusta la caché de contribuyentes
Sección titulada «5. Ajusta la caché de contribuyentes»{ "contribuyenteCacheTtlDays": 7}redcumbre configuracion cache-contribuyentes verredcumbre configuracion cache-contribuyentes cambiar --cuerpo @cache.jsonResultado esperado: los días de vigencia guardados. Es un entero desde 1; con null la empresa vuelve al valor global. obtenerCacheDeContribuyentes devuelve null cuando usa el valor global.
6. Guarda la información de pago
Sección titulada «6. Guarda la información de pago»{ "infoPagoHtml": "<p>Paga por transferencia a la cuenta indicada en tu cotización.</p>"}redcumbre configuracion info-pago verredcumbre configuracion info-pago guardar --html '<p>Paga por transferencia a la cuenta indicada en tu cotización.</p>'redcumbre configuracion info-pago quitarResultado esperado: el HTML guardado, ya saneado. Es el texto que se imprime en los documentos, con hasta 500 caracteres de texto: si excede, responde 400. obtenerInformacionDePago devuelve el HTML, o null si no hay.
7. Elige las plantillas de los documentos
Sección titulada «7. Elige las plantillas de los documentos»Primero mira qué hay y para qué tipo de documento:
redcumbre configuracion plantillas listarredcumbre configuracion plantillas ver <id-de-la-plantilla>redcumbre configuracion plantillas tipos-de-documentoredcumbre configuracion plantillas formatos-de-papelredcumbre configuracion plantillas opciones documento_tributario.boleta_honorarioResultado esperado: las plantillas de la plataforma (filtrables por tipo de documento, formato de papel y estado), los tipos de documento, los formatos de papel (carta, rollo de 80 mm, etc.), y para un tipo, las plantillas disponibles, la que eligió la empresa y la de la plataforma por defecto. Antes de elegir, mira cómo queda:
redcumbre configuracion plantillas vista-previa-de-empresa <id-de-la-plantilla> --formato pdf --salida vista.pdfResultado esperado: el archivo vista.pdf con la plantilla armada con el nombre y el logo de la empresa (sin --formato, HTML). Si el logo no carga, se genera sin logo. redcumbre configuracion plantillas vista-previa <id> --salida vista.pdf hace lo mismo con datos de muestra del catálogo, y
redcumbre configuracion plantillas vista-previa-con-datos <id> --cuerpo @datos.json mezcla esos datos con los tuyos:
{ "data": { "cliente": "Cliente de ejemplo" }}Elige la plantilla de cada tipo de documento:
{ "templates": { "documento_tributario.boleta_honorario": "bhe-estandar-carta" }}redcumbre configuracion plantillas elegir --cuerpo @plantillas.jsonredcumbre configuracion plantillas elegidasResultado esperado: la plantilla elegida por tipo de documento, con su detalle. Una plantilla que no existe responde 404; una que no está habilitada, que no corresponde al tipo de documento o que sólo se usa declarándola al emitir responde 400.
8. Revisa los topes de ValidaFirma y pide una ampliación
Sección titulada «8. Revisa los topes de ValidaFirma y pide una ampliación»redcumbre configuracion topes verredcumbre configuracion topes historial-de-proteccion --limite 20redcumbre configuracion topes pedir-ampliacion --valor 200 --motivo "Subimos el volumen de firmas del mes"{ "valor": 200, "motivo": "Subimos el volumen de firmas del mes"}Resultado esperado: topes ver trae los topes vigentes de la empresa; historial-de-proteccion lista, paginado, los momentos en que la protección de topes actuó; pedir-ampliacion registra la solicitud. valor es un entero desde 1 y motivo tiene hasta 2.000 caracteres. La empresa tiene una solicitud pendiente a la vez: la segunda responde 409 hasta que la primera se resuelva.
9. Lee el registro de llamadas de las llaves
Sección titulada «9. Lee el registro de llamadas de las llaves»redcumbre configuracion llamadas listar --desde-fecha 2026-11-01T00:00:00Z --codigo 403redcumbre configuracion llamadas listar --llave-id 12 --metodo POST --limite 50Resultado esperado: { data, total, limit, offset }. Cada elemento de data trae exactamente id, ocurridaEn, metodo, ruta, codigoRespuesta, duracionMs, traceId, llave ({ id, nombre }) y error ({ codigo, mensajes }, o null si la llamada salió bien). El registro guarda los últimos 30 días; nunca trae el cuerpo de la llamada ni los secretos. Filtros: --desde-fecha y --hasta-fecha (ISO 8601), --codigo (100 a 599), --metodo, --ruta, --llave-id y --traza; --limite y --desde paginan.
10. Consulta la suscripción
Sección titulada «10. Consulta la suscripción»redcumbre configuracion suscripcion adicionales listarredcumbre configuracion suscripcion adicionales ver <id-del-adicional>redcumbre configuracion suscripcion planredcumbre configuracion suscripcion resumenResultado esperado:
- Adicionales (
{ data }): cada uno traeid,saas(codigo,nombre,origen),estado,plan(lagoPlanCode,nombre,cicloDeCobro,cuotaCents),periodo(desdeyhasta, onullsi está terminada),operacionProgramada(onull),contratadaEn,terminadaEn,silenciarCorreosAlClienteyalLlegarAlCupo. No trae identificadores del sistema de cobro. - Un adicional suma
consumopor cupo, que esnullcuando el sistema de cobro no responde, yconsumoNoDisponiblepara decirlo. Un adicional que no es de la empresa responde404. - El plan (
{ success, data }):plan(code,nombre,interval,amountCents),consumoActualyconsumoAnterior(cada uno conperiodoymetricas) ysinServiciosActivos. Sin suscripción responde400; si el sistema de cobro no responde,502. - El resumen de pagos (
{ success, data }):pendientes,vencidas,montoTotal,periodoMasAntiguoynombreReseller.
Ninguna de las cuatro cobra ni cambia la suscripción: son de lectura.
11. Administra las integraciones de PIN
Sección titulada «11. Administra las integraciones de PIN»redcumbre configuracion pin listarredcumbre configuracion pin crear --cuerpo @integracion.jsonredcumbre configuracion pin actualizar <id-de-la-integracion> --cuerpo @cambios.jsonredcumbre configuracion pin estadisticas <id-de-la-integracion> --periodo 7dredcumbre configuracion pin desactivar <id-de-la-integracion>redcumbre configuracion pin reactivar <id-de-la-integracion>{ "slug": "tienda-ejemplo", "name": "Tienda de ejemplo", "defaultRedirectUri": "https://example.com/retorno", "allowedRedirectUris": ["https://example.com/retorno"]}{ "name": "Tienda de ejemplo (nueva)"}Resultado esperado: una integración trae id, tenantId, slug, name, defaultRedirectUri, allowedRedirectUris, allowedCallbackUrls, active, createdAt, updatedAt y sharedPersonalData. El slug tiene de 2 a 50 caracteres (minúsculas, números, guion y guion bajo) y no se puede cambiar. Si pides compartir datos personales con sharedPersonalData y no declaras una dirección de aviso (allowedCallbackUrls), responde 400. desactivar no borra: deja active: false y reactivar la vuelve a dejar activa. estadisticas acepta 24h, 7d o 30d (por defecto 24h) y responde authorized, failed, expired, cancelled, pending y lastTransactionAt.
12. Opera el canal de agentes
Sección titulada «12. Opera el canal de agentes»El canal es la vía por la que los asistentes de las personas operan en nombre de la empresa.
redcumbre configuracion canal estadoredcumbre configuracion canal actividad --resultado rechazo --limite 50redcumbre configuracion canal opciones-de-actividadredcumbre configuracion canal conexionesredcumbre configuracion canal hechosredcumbre configuracion canal apagarredcumbre configuracion canal prenderredcumbre configuracion canal quitar <id-de-la-conexion>Resultado esperado:
- Estado:
apagado,desde,poryporCredencial. - Actividad (
{ data, total, limit, offset }, ventana de 180 días): cada elemento traeid,ocurridaEn,persona({ id, nombre }onull),asistente(nombre,verificado),herramienta,operacion,mutacion,resultado(exito,rechazo,falloodesconocido),codigoRechazoyversionAutorizacion. Nunca trae el contenido de lo que el asistente pidió. Filtros:--desde-fecha,--hasta-fecha,--persona-id,--asistente,--herramienta,--resultadoy--cliente-id. - Opciones de actividad:
personas(id,nombre) yasistentes, para armar los filtros. - Conexiones (
{ data }):conexionId,persona,propia,asistente(nombre,verificado,clientId,redirectUris) yconstancias(id,version,aceptadaEn,revocadaEn,motivoRevocacion). Con una llave,propiaes siemprefalse. - Hechos (
{ data, total, limit, offset }):id,tipo,persona,porCredencial,ocurridoEnyconexion. - Apagar y prender responden el estado. Si el canal ya estaba en ese estado, responden
200sin cambiar nada. Apagar revoca las autorizaciones vigentes y prender no las revive: cada persona tiene que volver a autorizar. - Quitar responde
{ quitada: true }. ElconexionIdes el identificador público de la conexión, el deconexiones.
Quién hizo qué. Lo que haces con una llave queda atribuido a la llave: apagar y prender dejan su nombre en porCredencial (con por en null), y los hechos del canal lo traen igual. Una persona con sesión sólo puede quitar sus propias conexiones; una llave puede quitar cualquier conexión vigente de la empresa. Una conexión de otra empresa, que no existe o que ya está quitada responde 404.
13. Administra las casillas de ventas
Sección titulada «13. Administra las casillas de ventas»redcumbre configuracion ventas casillas listarredcumbre configuracion ventas casillas alertasredcumbre configuracion ventas casillas tomar --parte-local ventasredcumbre configuracion ventas casillas quitar <id-de-la-casilla>{ "localPart": "ventas"}Resultado esperado: una casilla trae id, localPart, direccion, estado (ACTIVA o RESERVADA), tomadaAt, liberadaAt, reservadaHasta, usos (formaId, nombre, version, conBorrador) y alerta (causa y desde, o null). Las alertas traen casillaId, direccion, causa (FALLOS_SEGUIDOS, UNA_HORA o CASILLA_LIBERADA), desde y formasDeVenta. Para tomar una casilla manda sólo la parte local, sin el dominio. Si no está disponible responde 409. La casilla que tomas con una llave queda sin autor: la persona que la usa la ve igual. Quitar una casilla la deja reservada 180 días para la misma empresa; si la usa una forma de venta publicada, responde 409.
14. Define los campos de la nota
Sección titulada «14. Define los campos de la nota»redcumbre configuracion ventas campos listar --archivo VIGENTES --tipo TEXTOredcumbre configuracion ventas campos crear --cuerpo @campo.jsonredcumbre configuracion ventas campos ver <id-del-campo>redcumbre configuracion ventas campos actualizar <id-del-campo> --cuerpo @cambios.jsonredcumbre configuracion ventas campos archivar <id-del-campo>{ "clave": "orden_de_compra", "nombre": "Orden de compra", "tipo": "TEXTO", "obligatorio": false, "visibilidad": "CLIENTE"}{ "nombre": "Número de orden de compra"}Resultado esperado: un campo trae id, clave, nombre, tipo (TEXTO, NUMERO, FECHA, LISTA o SI_NO), opciones, obligatorio, visibilidad (CLIENTE o INTERNO), destino, archivadoEn y formasQueLoUsan (id, nombre). El listado es { data, total, limit, offset } y filtra por --archivo (VIGENTES, ARCHIVADOS o TODOS), --tipo, --visibilidad y --busqueda. La clave son minúsculas, números y guion bajo, empieza con letra y no cambia después; un campo de tipo LISTA necesita opciones. Una clave repetida responde 409. El tipo no se cambia si el campo ya tiene valores. Archivar un campo que usa una forma de venta no archivada, o que ya está archivado, responde 409.
15. Configura el correo de la empresa
Sección titulada «15. Configura el correo de la empresa»redcumbre configuracion correo verredcumbre configuracion correo identidades listarredcumbre configuracion correo identidades crear --cuerpo @identidad.jsonredcumbre configuracion correo identidades verificar-conexion <id-de-la-identidad>redcumbre configuracion correo identidades enviar-prueba <id-de-la-identidad> --a persona@example.comredcumbre configuracion correo cambiar --cuerpo @correo.json{ "defaultIdentityId": "identidad-de-ejemplo"}{ "to": "persona@example.com"}Resultado esperado:
- Configuración (
correo ver):id,tenantId,defaultIdentityId,creadoEn,actualizadoEnycreadoPorUserId, onullsi la empresa no tiene.correo cambiarfija la identidad por defecto; connullla quita. Una identidad de otra empresa responde400. - Identidad:
id,tenantId,nombre,tipo(SIMPLEoSMTP_CUSTOM),fromName,fromEmail,replyTo,smtpHost,smtpPort,smtpUser,smtpSecure,smtpMaxConnections,smtpMaxPerHour,smtpMaxPerConnection,verificada,verificadaAt,activa,createdAt,updatedAt,createdByUserIdyhasPassword. SinsmtpPassword. - Crear una identidad
SMTP_CUSTOMexigefromName,fromEmail,smtpHost,smtpPort(1 a 65535),smtpUserysmtpPassword; el servidor tiene que ser público: uno interno responde400. Actualizar acepta cualquier subconjunto de esos campos, másactiva, y la contraseña sólo se guarda en una identidadSMTP_CUSTOM. verificar-conexionresponde{ success, message }, con «Conexión exitosa» o un mensaje fijo según la causa de la falla.enviar-pruebaresponde{ success, message }y envía un correo real a la dirección--a.quitarresponde{ success: true, message }; una identidad que no existe o es de otra empresa responde404.
Lo que escribes en el correo y en el PIN con una llave queda atribuido a esa llave (llave:<id>) en el registro de actividad, no a una persona.
16. Administra las plantillas de correo
Sección titulada «16. Administra las plantillas de correo»redcumbre configuracion plantillas correo listarredcumbre configuracion plantillas correo asignaciones --proceso DTE_ENVIOredcumbre configuracion plantillas correo contenido-por-defecto --proceso DTE_ENVIOredcumbre configuracion plantillas correo crear --cuerpo @plantilla.jsonredcumbre configuracion plantillas correo vista-previa <id-de-la-plantilla>redcumbre configuracion plantillas correo actualizar <id-de-la-plantilla> --cuerpo @cambios.jsonredcumbre configuracion plantillas correo quitar <id-de-la-plantilla>{ "nombre": "Envío de factura", "procesoTipo": "DTE_ENVIO", "subject": "Tu documento {{folio}}", "htmlContent": "<p>Hola, te enviamos tu documento.</p>", "adjuntarPdf": true, "subTipos": ["33"]}{ "activo": true}Resultado esperado:
- Plantilla:
id,tenantId,nombre,procesoTipo(DTE_ENVIOoDTE_VENCIMIENTO),modoEdicion(VISUALoAVANZADO),subject,htmlContent,identityId,activo,adjuntarPdf,createdAt,updatedAtycreatedByUserId; el listado y el detalle suman la identidad (id,nombre,tipo,activa) y las asignaciones por subtipo. - Crear y actualizar responden
{ template, warnings }:warningsavisa de las variables del texto que el sistema no conoce. Un subtipo tiene una sola plantilla activa por proceso; repetirlo responde409. No se puede volver deAVANZADOaVISUAL. - Asignaciones: por cada subtipo del proceso,
subTipo,asignadoytemplate(id,nombre,activo, onull). - Contenido por defecto:
htmlysubjectdel sistema.--procesoes obligatorio; uno que no existe responde400. - Vista previa:
html,subject,identityyisExample. Sin--dte-idse arma con datos de ejemplo (isExample: true); con un documento de la empresa, con sus datos. - Quitar responde
{ deleted: true }; una plantilla que no existe o es de otra empresa responde404.
Errores que vas a ver
Sección titulada «Errores que vas a ver»| Respuesta | Qué significa | Qué haces |
|---|---|---|
400 | Un campo que la operación no declara, un modo fuera del catálogo, una caché menor a 1, una información de pago de más de 500 caracteres o una plantilla que no corresponde | Corrige el cuerpo y repite |
404 | Eliminar una configuración, un logo, una identidad o una plantilla de correo que no existe; un adicional o una conexión que no es de la empresa; una plantilla fuera del catálogo | Verifica con la operación de lectura |
409 | Crear la configuración de ValidaFirma cuando ya existe, una segunda solicitud de tope pendiente, una casilla o una clave de campo repetida, archivar un campo o quitar una casilla que una forma de venta usa, o una plantilla de correo activa repetida para un subtipo | Usa la operación de actualizar, espera a que se resuelva la pendiente o libera el recurso que lo usa |
502 | El sistema de cobro no responde al leer el plan | Repite más tarde |