What is an API?
API is an Application Programming Interface. It is a set of rules that strictly describe how programs and subroutines communicate with each other. The API accepts the JSON data format.
Main API methods:
- GET – is used to retrieve data (e.g. displaying a list of materials)
- POST – creates new data (e.g. adds a new recipient)
- PUT - updates previously added resources (e.g. makes changes to the material)
- DELETE - deletes data
What is it in practice mean?
In practice, this means that every function in the system can be called via the API. Thanks to this, it is possible to integrate systems with Weaver WMS in a standardized way. A partner or a third party can perform a number of operations through the API that will enable integration with another system.
Examples of operations that can be performed via REST API:
- Download list of materials
- Adding a recipient
- Downloading a list of GRNs awaiting execution
- Adding a notification of a GRN document
- Downloading a list of stocktaking done in WMS
100% of the Weaver WMS application logic is available through the API.
From a technical point of view...
The operation of the Weaver WMS API structure is described in a dedicated article here. It presents, among other things, the process of configuring the API in the warehouse system, as well as authorization and general operation of the entire interface.
Swagger
Swagger allows you to check individual URI addresses (so-called endpoints). The entire list of available methods is here.
