Integra tu ERP, CRM o Plataforma SaaS directamente con DocVault24. Automatiza el resguardo de CFDI, expedientes NOM-151 y Webhooks en tiempo real.
Nuestra plataforma cuenta con una especificación OpenAPI 3.0 viva. Puedes explorar todos los esquemas, endpoints y realizar pruebas directas a la API desde nuestro portal interactivo Swagger.
Para autenticar tus peticiones a la API de DocVault24, necesitas enviar tu API Key a través del header HTTP X-DocVault24-API-Key.
Importante: Las API Keys solo pueden ser generadas desde el Portal de Clientes si tu cuenta cuenta con una suscripción activa al plan Enterprise.
Para garantizar trazabilidad (Observabilidad Universal) e idempotencia en transacciones críticas, la API exige las siguientes cabeceras:
POST, PUT, PATCH, DELETE) Un UUIDv4 único asociado a la acción. Garantiza que la mutación se ejecute solo una vez, previniendo operaciones duplicadas en caso de reintentos por red.Guarda los CFDI de tu ERP (XML y representación impresa en PDF) de forma directa en la bóveda inmutable de DocVault24, generando su sello de tiempo blockchain y la constancia NOM-151.
/cfdi-vault/syncEl Document Management System (DMS) de DocVault24 utiliza URLs prefirmadas para subidas y descargas seguras, evitando el paso de binarios por el API Gateway.
POST /connector/dms/presigned-url/uploadPOST /connector/:tenantId/dms/presigned-url/uploadPOST /connector/:tenantId/dms/presigned-url/downloadcurl -X POST https://api.docvault24.com/connector/dms/presigned-url/upload \
-H "X-DocVault24-API-Key: dv24_live_YOUR_API_KEY_HERE" \
-H "Content-Type: application/json" \
-d '{
"tenantId": "opcional_para_superadmin",
"filename": "contrato.pdf",
"contentType": "application/pdf",
"folder": "contracts",
"isPublic": false
}'| Carpeta (ID) | Descripción | Retención Recomendada |
|---|---|---|
| cfdi | CFDI / Comprobante Fiscal Digital | 5 Años (Fiscal) |
| csd | Certificados de Sello Digital (CSD) | Permanente (Revocados) |
| csf | Constancia de Situación Fiscal (CSF) | Activo (Última) |
| bank-statements | Estados de Cuenta Bancarios | 5 Años |
| payroll | Recibos y Timbrados de Nómina | 5 Años (Laboral) |
| declarations | Declaraciones Fiscales y Acuses | 5 Años |
| tax-payments | Líneas de Captura y Pagos SAT | 5 Años |
| insurance | Pólizas y Endosos de Seguro | Vigencia + 2 Años |
| legal-docs | Actas y Documentos Legales | Permanente |
| evidence | Evidencias Operativas / Logísticas | 1 Año |
| riders | Documentos de Repartidores / Operadores | Activo |
| franchisees | Expedientes de Franquiciatarios | Activo |
| contracts | Contratos Comerciales y Laborales | Vigencia + 5 Años |
| general | Expediente General y Misceláneo | N/A |
Para el resguardo de documentos (fiscales u operativos), DocVault24 proporciona el API DMS Universal basado en URLs prefirmadas. Este enfoque asegura un aislamiento estricto por Tenant en nuestro object storage y previene accesos no autorizados, integrando tanto documentos corporativos como evidencia logística (e.g., Mande24).
/connector/dms/presigned-url/upload enviando el tenantId, el nombre del archivo (key) y seleccionando una carpeta autorizada de la Whitelist Oficial (ej. cfdi, evidence, contracts).Verifica de manera pública y sin autenticación la integridad de un documento sellado, asegurando que no ha sido alterado desde su emisión. Los datos sensibles se devuelven enmascarados.
/cfdi-vault/public/verify/:hashEscucha el Ciclo de Vida Ecosistema DocVault24 en tiempo real. Cuando ocurre un evento operativo, fiscal o de retención, haremos un POST a tu endpoint.
guide.created / order.guide.created - Se provisiona un expediente de evidencia.payment.confirmed - Se registra un comprobante de pago.fiscal.stamped - Se indexa un CFDI en el DMS.tenant.archive_request / tenant.archived - Cierre o suspensión de operaciones del Tenant.doc.expired - Vencimiento normativo de un documento.storage.quota_warning - El Tenant superó el umbral de almacenamiento S3/MinIO.DEAD_LETTER y podrás reintentarlo manualmente.Para garantizar la legitimidad del payload, DocVault24 firma la cadena concatenada de timestamp + '.' + rawBody usando HMAC-SHA256 (Cabeceras canónicas: X-DocVault24-Signature y X-DocVault-To-Mande-Signature). Todos los requests incluyen el X-DocVault24-Timestamp. Tu servidor debe validar que el timestamp entrante no exceda la ventana de tolerancia de 300 segundos (5 minutos) antes de verificar la firma, bloqueando completamente los ataques de repetición (Replay Attacks).
Si un webhook falla 3 veces seguidas (por timeout o error 5xx en tu endpoint), se mueve al Dead Letter Queue. Puedes consultar y reintentar estos webhooks programáticamente.
POST /webhooks/deliveries/replay/:idEl sistema extrae atómicamente los conceptos de cada CFDI para permitir una clasificación detallada a nivel de partida. Ideal para integraciones con ERPs o Sistemas Contables (ej. Conta24) que requieren inyectar Cuentas Contables y Tipos de Gasto a nivel granular.
GET /tenant/cfdis/:cfdiId/conceptosPATCH /tenant/cfdis/conceptos/:id{ "cuentaContable": "string", "tipoGastoId": "uuid" } para aplicar la clasificación.POST /tenant/cfdis/conceptos/clasificar-loteGET /tenant/tipos-gastocfdi.concept_classified hacia tus endpoints, permitiéndote actualizar el asiento contable en tiempo real.Endpoints diseñados para la integración Máquina a Máquina (M2M) con la plataforma Segmenta24.
POST /api/v1/m2m/connectors/handshake autenticación inicial.POST /api/v1/m2m/connectors/trigger-event para notificar flujos.POST /api/v1/m2m/contacts/sync para carga masiva de agenda B2B.Todos los requests requieren el header X-Api-Key validado a nivel Gateway.
Aprovecha el orquestador Multi-Modelo de DocVault24 para realizar auditoría de riesgo profunda, extracción de conocimiento y consultoría tributaria.
POST /api/v1/intelligence/cfdi-risk/:idconfidenceScore y un booleano requiresHumanReview.POST /api/v1/intelligence/askauditTrail y una recomendación sobre si un humano debe verificar la conclusión.Para poblar selectores (dropdowns) en el ERP de tu sistema, puedes usar nuestros endpoints de catálogos sincronizados directamente con el SAT.
GET /api/v1/catalogs/sat/usocfdi (Opcional param: ?rfc=XXX para filtrar aplicables a Moral/Física)GET /api/v1/catalogs/sat/regimenes (Opcional param: ?rfc=XXX)GET /api/v1/catalogs/sat/formapagoEstos endpoints soportan ETag y retornan Cache-Control headers para permitir cache agresivo en el frontend o Edge CDN.
DocVault24 implementa un modelo de Control de Acceso Basado en Roles (RBAC) estricto. Todas las llamadas al API deben ser autenticadas y autorizadas. A continuación, se detallan los permisos mínimos requeridos por endpoint.
| Dominio / Endpoint | SUPER_ADMIN | TENANT_ADMIN | TENANT_USER |
|---|---|---|---|
GET /tenant/dashboard | ✓ (Todos) | ✓ | ✓ (Lectura) |
POST /connector/dms/presigned-url/upload | ✓ | ✓ | ✗ |
POST /cfdi-vault/sync | ✓ | ✓ | ✗ |
| Gestión de CSD / Llaves Privadas | ✓ | ✓ | ✗ |
| Gestión de Webhooks y Endpoints | ✓ | ✓ | ✗ |
| DLQ Replay y Monitor | ✓ (Global) | ✓ (Tenant) | ✗ |
| Archivar / Suspender Tenant | ✓ | ✗ | ✗ |
ARCHIVED, todos los permisos de mutación (POST, PUT, DELETE) se revocan automáticamente, permitiendo únicamente solicitudes GET (Modo Auditoría).Ciclo de vida de la autenticación:
POST /auth/refresh enviando el Bearer token.El backend intercepta proactivamente las subidas de archivos evaluando la métrica storage_used_bytes del Tenant. Si el archivo entrante (declaración, póliza, PDF) supera el límite (storage_quota_gb), el servicio S3/Minio rechazará la solicitud y el API Gateway emitirá un error PayloadTooLargeException.
Adicionalmente, se puede forzar una recalibración administrativa de la cuota llamando a /admin/tenants/:id/recalculate-storage, la cual escanea físicamente los objetos S3 y actualiza el contador.