Versions Compared

Key

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

What is Rest API?

A RESTful API is an application program interface (API) that uses HTTP requests to GET, PUT, POST and DELETE data.

...

A RESTful API breaks down a transaction to create a series of small modules. Each module addresses a particular underlying part of the transaction. This modularity provides developers with a lot of flexibility. 

How to set up Burti Rest API?

It is necessary to create script in server folder run-burti-web-api-requests.sh that will contain requests to the server, using the curl command-line tool:

...

As you can see, the request is now in JSON format. It is once again numbered and can contain multiple requests within the single call. These would be expected to be numbered 0, 1, 2 and so on.

# {{name}}  - the name of the update interface. The principle is similar to the read interfaces.
{{company}}  - the company number to use for inserting data
# {{data}}  - the data block
# {{action}}  - insert/update/delete
# {{matrix}}  - to be used with matrix rows - array of rows in the same format as the following
# {{Code}}, {{Name}}  - database fields to update with values

...