VerifactuMidAPI/documentacion/README.md

36 lines
1.5 KiB
Markdown
Raw Normal View History

# Documentación
Índice de documentación técnica de VeriFactu MidAPI.
## Guías
| Documento | Descripción |
|-----------|-------------|
| [PREREQUISITES.md](PREREQUISITES.md) | Requisitos del sistema, setup paso a paso, build, run y troubleshooting |
| [ERRORES.md](ERRORES.md) | Códigos de error de la API y de la AEAT |
## Referencia técnica
| Documento | Descripción |
|-----------|-------------|
| [api.md](api.md) | Referencia completa de endpoints, requests y responses |
| [verifactu.md](verifactu.md) | Protocolo VeriFactu: operaciones, hash encadenado, URLs AEAT, formato XML |
| [formato_datos.md](formato_datos.md) | Formatos de datos: NIF, fechas, tipos de factura, IVA, ejemplo JSON |
| [formatos.md](formatos.md) | Formatos de entrada soportados: native, dolibarr, y cómo añadir nuevos |
| [arqui.md](arqui.md) | Arquitectura del proyecto, capas y flujo de datos |
## Seguridad y certificados
| Documento | Descripción |
|-----------|-------------|
| [seguridad.md](seguridad.md) | Certificados digitales, cifrado RSA, HTTPS, rate limiting |
| [certificado_pruebas.md](certificado_pruebas.md) | Obtención y configuración de certificados FNMT para pruebas |
| [tokens.md](tokens.md) | Sistema de tokens: flujo, almacenamiento, seguridad |
## Configuración y testing
| Documento | Descripción |
|-----------|-------------|
| [config.md](config.md) | Fichero config.yml, variables de entorno, estructura de directorios |
| [testing.md](testing.md) | Tests de certificados, tests de facturas, depuración |