> ## Documentation Index
> Fetch the complete documentation index at: https://a3erpapi.appcloud.es/llms.txt
> Use this file to discover all available pages before exploring further.

# A3ERP API: integra A3ERP con tu aplicación externa

> Descubre qué es la A3ERP API, sus requisitos previos, los archivos de instalación incluidos y cómo está organizada esta documentación.

La **A3ERP API** es un servicio REST que expone los datos y operaciones de A3ERP para que puedas integrarlos con cualquier aplicación externa. Con ella puedes consultar maestros, crear y modificar documentos de venta y compra, gestionar stock, ejecutar procedimientos almacenados personalizados y mucho más, todo ello a través de llamadas HTTP estándar autenticadas con JWT.

## Requisitos previos

Antes de instalar la API asegúrate de cumplir los siguientes requisitos:

<Note>
  La A3ERP API requiere **a3ERP versión 14 o superior** y el **diccionario JNCAPI** proporcionado junto con los archivos de instalación. Sin estos dos elementos el servicio no funcionará correctamente.
</Note>

## Archivos de instalación

El paquete de instalación incluye los siguientes archivos:

| Archivo           | Descripción                                                                                                                                                |
| ----------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `A3APIRest.exe`   | Ejecutable principal del servicio API REST. Es el proceso que escucha y responde las peticiones HTTP.                                                      |
| `CfgAPI.exe`      | Programa visual para configurar todas las opciones del servicio: conexión a base de datos, rutas, SMTP, FTP y más. Genera y edita el archivo `Config.ini`. |
| `Config.ini`      | Archivo de configuración con todos los parámetros necesarios para que el servicio se conecte y funcione correctamente.                                     |
| `Instalar.bat`    | Script de instalación que registra la API como servicio de Windows.                                                                                        |
| `Desinstalar.bat` | Script de desinstalación que elimina el servicio de Windows.                                                                                               |
| `CfgVistas.exe`   | Utilidad para crear y gestionar vistas SQL personalizadas que se exponen a través de la API.                                                               |
| `CfgProAlm.exe`   | Utilidad para configurar procedimientos almacenados personalizados accesibles desde la API.                                                                |
| `CfgFRDesign.exe` | Utilidad para diseñar informes en formato FastReport que la API puede generar y servir en PDF o Excel.                                                     |

## Fases de puesta en marcha

La instalación de la A3ERP API se divide en tres fases que debes seguir en orden:

<Steps>
  <Step title="Configurar">
    Usa **CfgAPI.exe** para rellenar el archivo `Config.ini` con los parámetros de conexión a la base de datos, rutas de logs, configuración SMTP, FTP y producción. Esta fase es obligatoria antes de cualquier instalación.
  </Step>

  <Step title="Instalar">
    Copia el diccionario JNCAPI en la ruta correspondiente de A3ERP, lanza el despliegue para regenerar las tablas y ejecuta `Instalar.bat` para registrar el servicio en Windows.
  </Step>

  <Step title="Verificar">
    Realiza una llamada `GET /api` a tu servidor. Una respuesta **401 Authorization Required** confirma que el servicio está en funcionamiento y listo para autenticar peticiones.
  </Step>
</Steps>

## Primeros pasos

Sigue la guía de inicio rápido para poner en marcha la API en tu servidor:

<CardGroup cols={3}>
  <Card title="Configuración inicial" icon="gear" href="/inicio-rapido/configuracion-inicial">
    Aprende a configurar el archivo `Config.ini` con CfgAPI.exe antes de instalar el servicio.
  </Card>

  <Card title="Instalación" icon="wrench" href="/inicio-rapido/instalacion">
    Instala el diccionario JNCAPI y registra la API como servicio de Windows.
  </Card>

  <Card title="Autenticación" icon="key" href="/conceptos/autenticacion">
    Obtén tu primer token JWT y realiza tu primera llamada autenticada a la API.
  </Card>
</CardGroup>