Versions Compared

Key

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

...

It is available since Standard ERP version 8.4. In versions 8.2 and above REST API v1 is available which is limited to specific registers. In case of a need for also write functionality of REST API we can offer Burti REST API which offers read & write operations with any records with extensive customisation options.

...

  • In the system module, Optional Features setting, the checkbox Web Rest API is used to enable the API.
  • The user must be given the access right to the action Rest API
  • In some versions it is also needed to change setting in Webshop >> Settings >> Access to functions from web 

Image Added

Basic Use

Requests specify the company and resource to read, in the most basic format:

...

Writing Data to Standard ERP

Functionally RecordNew will be called, then each set command will be called in order with it's respective window actions (to fill e.g. customer's name and payment terms). Finally, the record will be inserted calling the same record actions as if a user did it with a client. There is no limit to the number of set commands you can issue, they can be either in the url or in post data. Only fields with non-default (non blank) data is returned.

Note the "url" parameter that uniquely identifies the created record. If you have more than one field in the main key these fields will be separated by '/'. If the main key contains special characters they will be url encoded.

In case of any messages that user would receive when entering the data manually, these messages will be returned in the following format: <message description='message_text'></message>

In case of error, while inserting/updating a record, the following will be returned: <error code='error_code' description='error description' row='row_no' field='field_name'></error>


POST


To create new records you POST to the registers. The 'set' commands have the same syntax and functionality as with POST.

...