Page Comparison

Versions Compared

Key

This line was added.
This line was removed.
Formatting was changed.

Table of Contents

...

To take advantage of the more advanced aspects of the API, you will benefit greatly from having some HAL programming knowledge or a HAL programmer's assistance. For simpler use cases this might not be necessary.

In this documentation topics and API elements and functions that either require or can be altered by HAL programming will be marked with a lightbulb symbol.

Burti API license and package

...

Section

Column

width	30%

Retrieving the database structure of a register

To generate the various end-points Burti API relies on the database structure that Standard ERP exposes via the Export/import Format report in its' Technics module.

When the report is run without specifying a register code, it will dump the database definitions of all the registers in the database. These are for example Invoices, Sales Orders, Deliveries and such.

You will need to look up the register(-s) that you wish to expose via the API in this report and then separately export these to a text file.

Example

In this example we show how to retrieve the database structure of the Orders register to use for creating its' API end-point.

Step 1: Enter the keyword "Orders" in the search field of the report

Step 2: Cycling through the search results pin-point the correct register and take note of its' code (ORVc).

Step 3: Reopen to the Report Specification window using the cogwheel menu available in the upper-left hand corner of the window.

Step 4: Enter the register code (ORVc in this example) in the field labeled "Vc (View Code)", set Media to File and press Run to save the definition in a file.

Column

width	70%

...

Section

Column

width	30%

To generate the API end-point from your API Register Definition record, select the option(-s) you need under the cogwheel menu in the record.

To enable the Read API, select "Generate JSON read API"

To enable the Write API, select "Generate JSON write API"

Column

width	70%

After running these functions, you will receive a message box about generated HAL files for your end-point interfaces.

The structure and role of these files are as follows:

File Role

halcust/serverJSON/generated-interfaces/JSON_InterfaceCallers.hal

This is is the main entry point for all API calls. Think of it as a router. Everything will go through this file and get re-routed to the appropriate API sub-routines.

Info
You won't need to ever make changes to this file, and it will always be re-generated when changing the API configuration.

Info
The register code for Orders - `ORVc` - is used, but this part of the filename will change according to whatever register you are setting up the API for.

halcust/serverJSON/generated-interfaces/JSON_ORVc.hal

This is the main Read API functionality. It contains code for all the indexing, filtering and include/exclude options you selected.

Info
You won't need to ever make changes to this file, and it will always be re-generated when changing the API configuration.

halcust/serverJSON/generated-interfaces/JSON_ORVc_Tools.hal

This file is where the Read API customisation happens. This contains all the available HAL hooks that you can take advantage of to either include additional data or add custom filtering or other behavior to the API.

The various possibilities are documented towards the end of the documentation.

halcust/serverJSON/generated-interfaces/JSON_Save_ORVc.hal

This is the main Write API functionality. It's responsible for populating the record with the field values that you pass via the API.

Info
You won't need to ever make changes to this file, and it will always be re-generated when changing the API configuration.

halcust/serverJSON/generated-interfaces/JSON_Save_ORVc_Tools.hal

This file is where the Write API customisation happens. This contains all the available HAL hooks that you can take advantage of to either include record validations, additional calculations, changes to other linked records etc.

The various possibilities are documented towards the end of the documentation.

Read API

Write API

Section

Column

width	30%

Column

width	70%

...