Quick Start

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.

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.

Initial configuration

Installation

This section explains in detail how to install the API.

Installation

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

GET https://servidor:<puerto>/api

200: OK a3ERP API REST ready!

{
    Hola, A3ApiRestestátrabajando
}