Documento funcional público
Ficha Técnica del sistema SOATI E-Factura® Módulo: API Conexión
Consulta accesos, XML firmado, timbrado, seguimiento, XML/PDF, cancelación, consulta SAT, saldo, límites e historial de integración en SOATI.
Detalle profundo del módulo
API Conexión administra los accesos de integración por empresa; la API fiscal permite procesar el XML firmado preparado por el sistema externo, consultar solicitudes, cancelar comprobantes, revisar estado SAT y saldo y recuperar archivos autorizados. La ficha distingue cada acción y su resultado: una solicitud recibida, un timbrado confirmado, un PDF disponible y una cancelación fiscal no son el mismo hecho.
Qué explica esta ficha técnica
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 predeterminada y límites
Separa la configuración del acceso del consumo fiscal de comprobantes.
Información que registra o selecciona el usuario
- Respuesta predeterminada XML o XML/PDF.
- Límites de solicitudes por minuto y día.
- Restricción de origen opcional.
- Notas de control y estado del acceso.
Acciones disponibles para el usuario
- Elegir el formato predeterminado.
- Ajustar límites permitidos.
- Registrar restricciones cuando corresponden.
- Guardar y revisar la configuración.
Pasos que ejecuta SOATI E-Factura®
- Aplica límites al usuario y a solicitudes autenticadas, incluidas consultas.
- Permite que la solicitud elija un formato válido distinto del predeterminado.
- Distingue límite de solicitudes de créditos fiscales.
- Valida configuración, empresa y versión.
Resultado para la operación
- Acceso con configuración revisable.
- Control de solicitudes.
- Modalidad predeterminada para la integración.
Resguardar, regenerar o revocar el acceso
Conserva control del uso sin permitir recuperar una llave completa después de ocultarla.
Información que registra o selecciona el usuario
- Usuario de integración autorizado.
- Estado actual y versión.
- Confirmación del responsable para regenerar o revocar.
Acciones disponibles para el usuario
- Resguardar la llave mostrada al crear o regenerar.
- Ocultarla después de su entrega segura.
- Regenerar cuando procede y actualizar el sistema externo.
- Revocar el acceso.
- Consultar el resultado si la respuesta administrativa se interrumpe.
Pasos que ejecuta SOATI E-Factura®
- Muestra la llave completa únicamente en la respuesta de creación o regeneración.
- Regenerar invalida las llaves activas anteriores.
- Revocar desactiva el usuario y conserva su historial.
- Activar un usuario revocado no revive una llave sin vigencia.
- Consultar no recupera una llave completa perdida ni desbloquea una operación fiscal incierta.
Resultado para la operación
- Acceso renovado o retirado.
- Historial conservado.
- Cambio de integración controlado por el responsable.
Consultar, buscar y exportar el historial
Relaciona operaciones del usuario de integración con su referencia y resultado disponible.
Información que registra o selecciona el usuario
- Empresa activa y usuario de integración autorizado.
- Referencia, UUID y estado disponibles.
- Búsqueda, orden y columnas elegidas.
Acciones disponibles para el usuario
- Abrir el historial del usuario de integración.
- Delimitar la consulta.
- Buscar y ordenar resultados.
- Cambiar la página o cantidad de registros.
- Copiar o exportar a Excel/PDF con las columnas elegidas.
Pasos que ejecuta SOATI E-Factura®
- Verifica el acceso a la empresa y al usuario de integración.
- Aplica filtros y búsqueda antes de paginar.
- Relaciona solicitudes con referencia, UUID y estado.
- Prepara las salidas de consulta autorizadas sin incluir secretos.
Resultado para la operación
- Historial delimitado y consultable.
- Referencias para conciliación y soporte.
- Exportación de resultados autorizados.
Solicitar el timbrado del XML externo
Procesa el comprobante preparado y firmado por el integrador sin recapturar la venta en el portal.
Información que registra o selecciona el usuario
- Empresa y acceso autorizado.
- XML firmado preparado por el sistema externo.
- Referencia comercial y seguimiento de la misma operación.
- Modalidad de respuesta elegida o predeterminada.
- Certificado, saldo y condiciones vigentes aplicables.
Acciones disponibles para el usuario
- Preparar y revisar el comprobante en el sistema origen.
- Enviar la solicitud de emisión.
- Guardar la referencia de seguimiento.
- Revisar confirmación o incidencia.
- Relacionar el UUID y XML confirmados con la operación original.
Pasos que ejecuta SOATI E-Factura®
- Comprueba autenticación, empresa y límites configurados.
- Valida estructura, datos y emisor dentro del alcance disponible.
- Reconoce solicitudes repetidas bajo las reglas de identidad de la operación.
- Solicita timbrado cuando procede y comprueba el resultado fiscal.
- Conserva referencias y archivos del resultado confirmado.
- Mantiene seguimiento cuando no existe certeza concluyente.
Resultado para la operación
- CFDI confirmado cuando el proceso concluye.
- UUID y XML relacionados con la solicitud.
- Resultado o incidencia localizables.
- Operación de origen conservada en el sistema externo.
Consultar una solicitud antes de repetirla
Distingue respuesta perdida, operación pendiente, rechazo conocido y emisión confirmada.
Información que registra o selecciona el usuario
- Acceso autorizado de la misma empresa.
- Identificador de seguimiento de la solicitud original.
- Referencia comercial conservada.
Acciones disponibles para el usuario
- Recuperar el identificador original.
- Consultar el estado.
- Relacionar resultado y UUID disponibles.
- Atender la incidencia indicada.
- Escalar una operación incierta sin crear otra identidad de solicitud.
Pasos que ejecuta SOATI E-Factura®
- Comprueba pertenencia de la solicitud al acceso autorizado.
- Consulta el resultado registrado.
- Devuelve datos y estados disponibles sin volver a solicitar el timbrado.
- Mantiene separado el estado del PDF.
- Impide tratar un resultado incierto como autorización automática para emitir de nuevo.
Resultado para la operación
- Estado consultable de la solicitud.
- UUID confirmado cuando existe.
- Base para conciliar con el sistema origen.
- Sin una nueva emisión por consultar.
Recuperar XML y PDF autorizados
Entrega los archivos disponibles de acuerdo con la modalidad de integración y el estado de preparación.
Información que registra o selecciona el usuario
- Solicitud y UUID disponibles.
- Modalidad XML o XML/PDF autorizada.
- Acceso de integración de la empresa.
- Estado del PDF cuando aplica.
Acciones disponibles para el usuario
- Revisar la respuesta de emisión.
- Guardar el XML confirmado.
- Consultar la disponibilidad del PDF.
- Recuperar el PDF autorizado cuando esté listo.
- Relacionar ambos archivos con el mismo comprobante.
Pasos que ejecuta SOATI E-Factura®
- Mantiene el XML fiscal confirmado sin recalcular sus datos.
- Separa la confirmación del timbrado de la preparación del PDF.
- Comprueba autorización antes de entregar el archivo.
- Recupera el resultado existente; no timbra otra vez para obtener un PDF.
Resultado para la operación
- XML fiscal conservado.
- Representación PDF disponible según modalidad y estado.
- Archivos relacionados con solicitud y UUID.
- Pendientes de archivo diferenciados de pendientes fiscales.
Solicitar cancelación y revisar su resultado
Atiende la cancelación de un comprobante con motivo y sustituto cuando corresponda.
Información que registra o selecciona el usuario
- UUID del comprobante autorizado.
- Motivo aplicable.
- UUID sustituto cuando se requiere.
- Referencia de la solicitud original.
Acciones disponibles para el usuario
- Verificar el comprobante y motivo.
- Solicitar la cancelación.
- Conservar la referencia y resultado.
- Revisar estado y acuse disponibles.
- Dar seguimiento cuando la respuesta no sea concluyente.
Pasos que ejecuta SOATI E-Factura®
- Valida empresa y datos de cancelación.
- Procesa la solicitud fiscal cuando procede.
- Conserva el resultado y su relación con el comprobante.
- Distingue solicitud procesada de estado fiscal cancelado.
- Mantiene seguimiento ante incertidumbre, sin reenvío fiscal automático.
Resultado para la operación
- Solicitud de cancelación identificada.
- Resultado y acuse disponibles conforme a la respuesta fiscal.
- Pendientes identificables para seguimiento.
- Original y sustituto relacionados cuando aplica.
Consultar estado SAT y saldo de créditos
Permite responder por la vigencia fiscal de un documento y por la disponibilidad de emisión, sin confundir ambas consultas.
Información que registra o selecciona el usuario
- Acceso autorizado.
- Datos fiscales requeridos del comprobante para consultar el SAT.
- Empresa o grupo de créditos aplicable.
Acciones disponibles para el usuario
- Consultar el estado fiscal del comprobante.
- Revisar el resultado disponible del SAT.
- Consultar el saldo autorizado.
- Revisar la regla de consumo aplicable a la operación.
- Continuar el proceso sólo con condiciones vigentes.
Pasos que ejecuta SOATI E-Factura®
- Valida los datos y permisos de cada consulta.
- Solicita el estado fiscal disponible al servicio externo.
- Consulta saldo y regla de consumo aplicables.
- No modifica el XML por consultar ni acredita un pago bancario.
Resultado para la operación
- Estado fiscal disponible del comprobante.
- Saldo y condiciones para la emisión.
- Datos para soporte y planeación del integrador.
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.
- Acordar alcanceConfirma documentos, complementos, volumen y modalidad de entrega con soporte.
- AutorizarEl responsable administra el usuario de integración de la empresa y sus límites.
- PrepararEl sistema externo genera y firma el XML correcto y conserva su referencia comercial.
- SolicitarEnvía el comprobante y registra su identificador de seguimiento.
- ConsultarComprueba el resultado antes de resolver un pendiente o repetir una acción.
- RecuperarRelaciona UUID, XML y PDF disponible con el origen comercial.
- AdministrarConsulta historial, estado SAT, saldo y cancelaciones; renueva o retira accesos cuando corresponde.
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.
- XML fiscal preparado y firmado por el integrador.
- Referencia comercial e identificador de seguimiento.
- Motivo y sustituto de cancelación cuando aplica.
- Estado de preparación y disponibilidad de archivos.
- Estado SAT y regla de consumo aplicable.
Integraciones entre módulos
- Emisión y timbrado CFDI.
- Cancelación.
- Consulta de estado SAT.
- Saldo de créditos.
- 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.
- Consultar primero ante resultados fiscales inciertos.
- No emitir de nuevo para resolver únicamente un PDF pendiente.
- Separación entre solicitud procesada y estado fiscal cancelado.
- XML confirmado conservado sin cambiar moneda o tipo de cambio por una sugerencia posterior.
- Una exportación de historial no incluye información de autenticación.
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.