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?
Setup is rather complicated, so we do it for the costumer. However, there are some prerequisites that needs to be done, in order to set it up:
- HAL License;
- HAL files for Burti REST API;
- Separate setup for each register client wants to use.
How to use 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:
...
Only describing new options that are not described above:
# sort_only - this will use the provided index name as a sort order only, and will not try to look up specific data (used when listing all records within a register)
Insert a new item
sample.post.data.txt - made to the WRITE interface Web_JSON_UpdatingComposer.hal:
...