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?
Initial 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:
...
| Code Block |
|---|
0_query=Web_JSON_INVc_List.hal&0_full=true&0_index=Code&0_Code=10101&0_company=1&0_fieldcnt=1&0_fieldlist=Code |
Request full details for a specific Recipy
- made to the READ interface Web_JSON_Composer.hal:
| Code Block |
|---|
0_query=Web_JSON_RecVc_List.hal&0_full=true&0_index=Code&0_Code=20210&0_company=1&0_fieldcnt=1&0_fieldlist=Code |
Parameters explained
As you can see, all the parameters are prefixed with a "0_" - this is a number for the request, and is used to make multiple data requests within a single API call. In this example, there is only one data request.
...
Response file response.get.json
Response file Recipies . response.get.recipies.json
Request full list of items
...
Response file response.get2.json
Insert a new item
sample.post.json - made to the WRITE interface Web_JSON_UpdatingComposer.hal:
...