Ir al contenido

Configuración de la empresa

Esta guía recorre la configuración de la empresa por API. Lo que haces aquí es lo mismo que hace una persona en el panel, en Configuración. El agente que integra con IA tiene la versión resumida en la ficha Configuración de la empresa. Desde la terminal, cada operación tiene su subcomando de redcumbre configuracion, por ejemplo redcumbre configuracion bhe cambiar --modo SINC_COMPLETO; la lista completa está en CLI de REDCUMBRE.

  • Una llave FULL-API de producción, o de prueba para ensayar. Cómo crearla: Modo de prueba.
  • Mandar sólo los campos que cada operación declara: un campo de más responde 400 y no se guarda nada.
Qué hacesRuta
Ver si hay clave y si la integración está activaGET /{tenantSlug}/config/validafirma
Guardar la clave y activar la integraciónPOST /{tenantSlug}/config/validafirma
Activar o desactivar, o reemplazar la clavePUT /{tenantSlug}/config/validafirma
Borrar la clave y la configuraciónDELETE /{tenantSlug}/config/validafirma

La clave nunca se devuelve, tampoco a quien la guardó. La respuesta trae claveConfigurada (true o false) y activo. Un PUT sin apiKey conserva la clave guardada: sirve para activar o desactivar sin conocerla. El POST responde 409 si ya hay una configuración, y el DELETE responde 404 si no hay ninguna. Si pierdes la clave, no hay cómo recuperarla: se reemplaza por una nueva.

  • POST /{tenantSlug}/config/logo: sube el logo como formulario, en el campo logo. Acepta JPEG, PNG, GIF o WEBP de hasta 2 MB y lo redimensiona.
  • GET /{tenantSlug}/config/logo: devuelve la URL del logo, o null si no hay.
  • DELETE /{tenantSlug}/config/logo: lo borra (404 si no hay).

Cada ajuste se lee con GET y se cambia con PUT:

AjusteRutaCampoValores
Modo de emisión de boletas de honorarios/{tenantSlug}/config/bhebheModoDefaultSINC_COMPLETO, SINC_PARCIAL, ASINCRONO
Modo de emisión de honorarios de terceros/{tenantSlug}/config/bhetbhetModoDefaultSINC_COMPLETO, SINC_PARCIAL, ASINCRONO
Modo de emisión de documentos tributarios/{tenantSlug}/config/dtedteModoDefaultSINC_COMPLETO, SINC_PARCIAL, ASINCRONO
Modo de emisión de boletas electrónicas/{tenantSlug}/config/boletaboletaModoDefaultSINCRONO, ASINCRONO
Caché de contribuyentes/{tenantSlug}/config/contribuyente-cachecontribuyenteCacheTtlDaysentero desde 1, o null para el valor global
Información de pago/{tenantSlug}/config/info-pagoinfoPagoHtmlHTML con hasta 500 caracteres de texto

La información de pago es el texto que se imprime en los documentos; se sanea al guardar, y además tiene DELETE para borrarla. Un valor fuera de lo permitido responde 400.

Las plantillas definen cómo se ve el PDF de cada tipo de documento. El catálogo es de la plataforma y es el mismo para todas las empresas:

Qué quieresRuta
Listar las plantillas del catálogoGET /templates/catalog
Ver el detalle de unaGET /templates/catalog/{templateId}
Ver los tipos de documento con plantillaGET /templates/document-types
Ver los formatos de papelGET /templates/paper-formats
Ver una vista previa con datos de muestraGET /templates/{templateId}/preview
Ver una vista previa con tus datosPOST /templates/{templateId}/preview

Y lo que elige tu empresa:

Qué quieresRuta
Ver las plantillas elegidasGET /{tenantSlug}/config/templates
Elegir la plantilla de cada tipo de documentoPUT /{tenantSlug}/config/templates
Ver las opciones de un tipo de documentoGET /{tenantSlug}/config/templates/{documentType}/options
Ver una vista previa con el nombre y el logo de la empresaGET /{tenantSlug}/templates/{templateId}/preview

Las vistas previas devuelven HTML o, con format=pdf, un PDF. Elegir una plantilla que no existe responde 404; una que no está habilitada o no corresponde al tipo de documento, 400.

Qué hacesRuta
Ver los topes de la empresaGET /{tenantSlug}/validafirma/topes
Ver el historial de la protección de topesGET /{tenantSlug}/validafirma/topes/proteccion/historial
Pedir una ampliación (valor entero desde 1 y motivo)POST /{tenantSlug}/validafirma/topes/solicitudes

La empresa tiene una solicitud pendiente a la vez: la segunda responde 409. Desde la terminal: redcumbre configuracion topes ver|historial-de-proteccion|pedir-ampliacion.

GET /{tenantSlug}/llamadas-llaves lista las llamadas de los últimos 30 días, con ocurridaEn, metodo, ruta, codigoRespuesta, duracionMs, traceId, la llave y el error. Filtras por desde y hasta (ISO 8601), codigo, metodo, ruta, llaveId y traceId. Desde la terminal: redcumbre configuracion llamadas listar.

Qué hacesRuta
Listar los adicionalesGET /{tenantSlug}/mi-suscripcion/adicionales
Ver un adicional con su consumoGET /{tenantSlug}/mi-suscripcion/adicionales/{id}
Ver el plan y su consumoGET /{tenantSlug}/mi-suscripcion/plan
Ver el resumen de pagos pendientes y vencidosGET /{tenantSlug}/mi-suscripcion/resumen

Son de lectura. Un adicional que no es de tu empresa responde 404; el plan responde 400 si no hay suscripción y 502 si el sistema de cobro no responde. Desde la terminal: redcumbre configuracion suscripcion adicionales listar|ver, suscripcion plan y suscripcion resumen.

Qué hacesRuta
Listar las integracionesGET /{tenantSlug}/pin/integrations
Crear unaPOST /{tenantSlug}/pin/integrations
Actualizarla (el slug no cambia)PATCH /{tenantSlug}/pin/integrations/{id}
DesactivarlaDELETE /{tenantSlug}/pin/integrations/{id}
ReactivarlaPOST /{tenantSlug}/pin/integrations/{id}/reactivate
Ver sus estadísticas (period: 24h, 7d o 30d)GET /{tenantSlug}/pin/integrations/{id}/stats

Pedir sharedPersonalData sin una dirección de aviso responde 400. Desde la terminal: redcumbre configuracion pin listar|crear|actualizar|desactivar|reactivar|estadisticas.

Qué hacesRuta
Ver la actividad de los últimos 180 díasGET /{tenantSlug}/canal-agentes/actividad
Ver las personas y asistentes para filtrarlaGET /{tenantSlug}/canal-agentes/actividad/opciones
Ver las conexiones de asistentesGET /{tenantSlug}/canal-agentes/conexiones
Ver los hechos del canalGET /{tenantSlug}/canal-agentes/hechos
Ver el estado del canalGET /{tenantSlug}/canal-agentes/estado
Apagarlo (revoca las autorizaciones vigentes)POST /{tenantSlug}/canal-agentes/apagar
Prenderlo (no revive las autorizaciones)POST /{tenantSlug}/canal-agentes/prender
Quitar la conexión de un asistentePOST /{tenantSlug}/canal-agentes/conexiones/{conexionId}/quitar

La actividad nunca trae el contenido de lo que el asistente pidió. Lo que haces con una llave queda atribuido a la llave (porCredencial). Con una llave puedes quitar cualquier conexión vigente de tu empresa; una conexión de otra empresa, inexistente o ya quitada responde 404. Desde la terminal: redcumbre configuracion canal actividad|opciones-de-actividad|conexiones|hechos|estado|apagar|prender|quitar.

Qué hacesRuta
Listar las casillasGET /{tenantSlug}/ventas/casillas
Ver las alertas de las casillasGET /{tenantSlug}/ventas/casillas/alertas
Tomar una casilla (localPart, sin dominio)POST /{tenantSlug}/ventas/casillas
Quitar una casilla (queda reservada 180 días)POST /{tenantSlug}/ventas/casillas/{id}/liberar
Listar, crear, ver, actualizar y archivar los campos de la nota/{tenantSlug}/ventas/campos-de-la-nota y /{id} (POST …/{id}/archivar)

Una casilla no disponible, una clave de campo repetida o archivar un campo que usa una forma de venta publicada responden 409. La clave de un campo son minúsculas, números y guion bajo, y no cambia después. Desde la terminal: redcumbre configuracion ventas casillas … y redcumbre configuracion ventas campos ….

Qué hacesRuta
Ver y cambiar la identidad por defectoGET y PUT /{tenantSlug}/admin/email-config/config
Listar y crear identidadesGET y POST /{tenantSlug}/admin/email-config/identities
Actualizar o eliminar unaPUT y DELETE /{tenantSlug}/admin/email-config/identities/{id}
Verificar su conexiónPOST …/identities/{id}/test-connection
Enviar un correo de prueba (to)POST …/identities/{id}/send-test
Listar y crear plantillas de correoGET y POST /{tenantSlug}/admin/email-config/templates
Ver las asignaciones por subtipoGET …/templates/assignments
Ver el contenido por defecto de un procesoGET …/templates/default-content?procesoTipo=
Ver, actualizar o eliminar una plantillaGET, PUT y DELETE …/templates/{id}
Ver la vista previa de una plantillaPOST …/templates/{id}/preview

La contraseña SMTP se escribe y no se lee: una identidad responde hasPassword, nunca la contraseña. Un servidor SMTP interno responde 400. Un subtipo tiene una sola plantilla activa por proceso (DTE_ENVIO o DTE_VENCIMIENTO): repetirlo responde 409. Desde la terminal: redcumbre configuracion correo … y redcumbre configuracion plantillas correo …; el cuerpo de una identidad va por --cuerpo @archivo, nunca con la contraseña a la vista.

Con una llave de prueba, todo responde desde un conjunto de ejemplo y no se guarda nada: ni la clave de ValidaFirma, ni el logo, ni los modos, ni las plantillas, ni los topes, el PIN, el canal, las casillas o el correo. Las escrituras validan el cuerpo como en producción y responden como si hubieran guardado.

  • GET /{tenantSlug}/config/logo devuelve la imagen de ejemplo /ejemplos/logo-de-ejemplo.png de este sitio.
  • La configuración de ValidaFirma de ejemplo trae claveConfigurada: true.
  • El registro de llamadas de prueba trae las llamadas hechas en modo de prueba, y el contenido por defecto de una plantilla de correo responde igual que en producción.
  • El catálogo de plantillas responde igual que en producción, porque no depende de ninguna empresa.

Nada se cobra. Cuando todo funcione, repite con la llave de producción.