Introducción a la API Firmaris

Introducción

Documentación técnica de la API Firmaris, una solución robusta para la integración de procesos de firma digital en aplicaciones empresariales. Esta API permite automatizar y gestionar flujos completos de firma electrónica, desde la creación de documentos hasta su seguimiento y descarga.

🎯 Objetivo

La API Firmaris está diseñada para facilitar la integración de capacidades de firma digital en sistemas existentes, permitiendo a las organizaciones:

• Digitalizar procesos documentales de manera segura y legal
• Automatizar flujos de firma para contratos, acuerdos y autorizaciones
• Validar identidades mediante métodos OTP (One-Time Password)
• Gestionar múltiples documentos y firmantes de forma eficiente
• Obtener trazabilidad completa de cada proceso de firma

🔑 Características Principales

Característica	Descripción
Autenticación Segura	Tokens de API por empresa con permisos granularizados
Múltiples Métodos de Firma	OTP básico por email y OTP móvil verificado
Gestión Masiva	Soporte para operaciones con múltiples documentos
Formatos Flexibles	Carga de documentos vía archivo o Base64
Seguimiento Completo	Consulta de estados y auditoría de firmas

📋 Flujo de Trabajo Típico

1. Autenticación: Configuración del token de empresa
2. Creación: Generación de folios con documentos y firmantes
3. Notificación: Envío automático de invitaciones a firmar
4. Seguimiento: Consulta de estados y progreso
5. Finalización: Descarga de documentos firmados

🛠️ Requisitos Técnicos

• Autenticación: Todos los endpoints requieren x-api-key: Bearer {TOKEN_EMPRESA}
• Formatos: JSON para consultas, multipart/form-data para operaciones con archivos
• Codificación: UTF-8 para todos los textos
• Conexión: HTTPS obligatorio

🚀 Primeros Pasos

Para comenzar a integrar la API Firmaris:

1. Obtén tus credenciales de acceso (API Key) de tú cuenta admin
2. Configura el encabezado de autenticación en todas las peticiones
3. Comienza con endpoints básicos de consulta para familiarizarte
4. Implementa la creación de folios según tus necesidades

📚 Estructura de la Documentación

Esta documentación está organizada en secciones que cubren:

• Endpoints principales: Descripción detallada de cada operación
• Parámetros y formatos: Especificaciones técnicas de entrada/salida
• Ejemplos prácticos: Casos de uso y código de ejemplo
• Manejo de errores: Códigos y soluciones comunes
• Mejores prácticas: Recomendaciones para implementación óptima

⚠️ Consideraciones Importantes

• Ambientes: La API está disponible en ambientes de desarrollo y producción
• Límites: Consulta los límites de tasa y tamaño de archivos
• Cumplimiento: Todos los procesos cumplen con normativas de firma digital vigentes
• Soporte: Disponible para clientes registrados, de lunes a viernes de 7:00 am a 3:00 pm, no hay soporte sábados, domingos ni festivos

---

Nota: Esta documentación está dirigida a desarrolladores y técnicos responsables de la integración. Se recomienda conocimiento previo en consumo de APIs REST y manejo de autenticación por tokens.