> For the complete documentation index, see [llms.txt](https://a3erpapi.appcloud.es/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://a3erpapi.appcloud.es/english/quick-start.md).

# Quick Start

{% hint style="warning" %}

### Requirements:

* **a3ERP version 13** or higher
* **Dictionary:** JNCAPI
* **Installation files:**
  * **A3APIRest.exe** → REST API service executable.
  * **CfgAPI.exe** → Program for configuration of all REST API service behavior options on the server.
  * **Config.ini** → Configuration file
  * **Install.bat** → Installation file as Windows service.
  * **Uninstall.bat** → Windows service uninstall file.
  * **CfgVistas.exe** → Utility for configuration of base and customized views.
  * **CfgProAlm.exe** → Utility for custom stored procedure configuration.
  * **CfgFRDesign.exe** → FastReport report design utility.
  * **APITesting.exe** → Utility for testing API calls.
    {% endhint %}

## Initial configuration

Before installing the API it is necessary to configure all the necessary parameters of the **Config.ini** configuration file so that it can connect properly to the database, therefore this section explains in detail how to configure the API **Config.ini.**

{% content-ref url="/pages/PGgmdUk61HSkR7xwNw4n" %}
[Initial configuration](/english/quick-start/initial-configuration.md)
{% endcontent-ref %}

## Installation

This section explains in detail how to install the API.

{% content-ref url="/pages/fRKDMlZCIl0K3JHgEZJZ" %}
[Installation](/english/quick-start/installation.md)
{% endcontent-ref %}

## First steps

To check that everything is working correctly we can make a GET call to /api to know if the service is running:

## Functional test

<mark style="color:blue;">`GET`</mark> `https://servidor:<puerto>/api`

{% tabs %}
{% tab title="200: OK a3ERP API REST ready!" %}

```javascript
{
    Hola, A3ApiRestestátrabajando
}
```

{% endtab %}
{% endtabs %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://a3erpapi.appcloud.es/english/quick-start.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.