Documento funcional público
Ficha Técnica del sistema SOATI E-Factura® Módulo: API Conexión
Consulta usuarios de integración, respuesta XML/PDF, límites, restricciones, historial, regeneración y revocación.
Detalle profundo del módulo
API Conexión administra accesos controlados para que un sistema externo autorizado utilice los servicios de timbrado y conserve trazabilidad por empresa y usuario de integración.
Describe la experiencia del usuario final, la información que captura o selecciona, las acciones disponibles, los pasos que ejecuta SOATI E-Factura® y el resultado operativo de cada función. No expone credenciales, infraestructura, tablas, rutas internas ni detalles de implementación.
Funciones, entradas, acciones y resultados
Cada bloque sigue el orden real de trabajo: qué necesita el usuario, qué puede hacer, cómo responde el sistema y qué obtiene al terminar.
Crear un usuario de integración
Registra una identidad técnica separada de los usuarios que operan la interfaz.
Información que registra o selecciona el usuario
- Empresa autorizada.
- Nombre del usuario de integración.
- Nombre descriptivo.
- Correo técnico.
- Estado activo.
Acciones disponibles para el usuario
- Crear.
- Guardar.
- Editar configuración.
- Activar o desactivar.
Pasos que ejecuta SOATI E-Factura®
- Valida que el identificador sea utilizable.
- Relaciona el acceso con una empresa.
- Genera la información de autenticación que debe resguardarse de forma segura.
Resultado para la operación
- Usuario API asociado a una empresa.
- Acceso controlado y revocable.
Definir respuesta y límites
Configura cómo se entregará el resultado y protege la operación ante consumos fuera de lo previsto.
Información que registra o selecciona el usuario
- Respuesta XML o XML más PDF.
- Límite por minuto.
- Límite diario.
- Restricción de origen opcional.
- Notas internas.
Acciones disponibles para el usuario
- Cambiar formato de respuesta.
- Ajustar límites autorizados.
- Registrar restricciones.
- Guardar notas de control.
Pasos que ejecuta SOATI E-Factura®
- Aplica la configuración al usuario de integración.
- Controla el consumo conforme a los límites.
- Entrega sólo los formatos habilitados.
Resultado para la operación
- Integración alineada con el flujo del cliente.
- Control de volumen.
- Respuesta consistente.
Regenerar o revocar acceso
Permite sustituir una llave o impedir el uso de un acceso existente.
Información que registra o selecciona el usuario
- Usuario API seleccionado.
- Estado actual.
- Confirmación del administrador.
Acciones disponibles para el usuario
- Regenerar llave.
- Revocar acceso.
- Reactivar sólo mediante la configuración autorizada.
Pasos que ejecuta SOATI E-Factura®
- Invalida el acceso anterior cuando corresponde.
- Registra el cambio de estado.
- Impide nuevas operaciones para accesos revocados.
Resultado para la operación
- Control ante cambios de personal o incidentes.
- Acceso anterior fuera de uso.
- Historial administrativo.
Consultar historial reciente
Muestra referencias de las operaciones atendidas por la integración.
Información que registra o selecciona el usuario
- Usuario o empresa.
- Fecha.
- Referencia externa.
- UUID, estado y origen de la solicitud.
Acciones disponibles para el usuario
- Consultar historial.
- Filtrar y revisar resultados.
- Relacionar una referencia con su CFDI.
Pasos que ejecuta SOATI E-Factura®
- Recupera las solicitudes compatibles.
- Relaciona referencia, UUID y estado.
- Presenta información de diagnóstico sin mostrar secretos.
Resultado para la operación
- Trazabilidad de operaciones.
- Apoyo para soporte entre ERP y SOATI.
- Identificación de solicitudes exitosas o pendientes.
Flujo de uso desde la perspectiva del usuario
Esta secuencia resume cómo se utiliza el módulo dentro de una operación cotidiana, desde la preparación de datos hasta la consulta del resultado.
- Autorizar empresaSe selecciona la razón social que podrá operar.
- Crear usuario APISe registra una identidad independiente y revocable.
- Definir controlesSe eligen respuesta, límites y restricciones.
- IntegrarEl sistema externo utiliza el acceso conforme a la documentación.
- MonitorearEl administrador consulta historial, regenera o revoca cuando se requiere.
Datos, integraciones y controles
El módulo no trabaja aislado. La siguiente información explica qué datos conserva, con qué otras funciones se relaciona y qué controles acompañan el flujo.
Datos que maneja
- Empresa.
- Usuario de integración.
- Correo técnico.
- Formato de respuesta.
- Límites de consumo.
- Restricciones autorizadas.
- Referencias, UUID y estados del historial.
Integraciones entre módulos
- Emisión y timbrado CFDI.
- Cancelación.
- Consulta de estado SAT.
- Saldo de timbres.
- ERP, ecommerce, punto de venta o sistemas propios.
Controles operativos
- Accesos separados por empresa.
- Llaves revocables.
- Límites por periodo.
- Restricción opcional de origen.
- Historial sin exposición de secretos.
Revisa este alcance con tu operación real
Consulta el Centro de soluciones o registra tu empresa para validar cómo SOATI E-Factura® puede integrarse al proceso de tu equipo.