Eyelit offers integration with third-party applications through the use of a Public API. A series of endpoints are exposed and can be called by an external system (normally a middleware provider) to make changes directly within a given instance of the Eyelit software. The calls to these endpoints are performed through the use of pre-formatted JSON packets and are authorised through OAuth 2.0. For detail on the authorisation process, see Authentication
This documentation provides technical information on the endpoints available to call through the Eyelit MES-M Public API relating specifically to the 'Product' functionality. The endpoints covered are listed in Table 1.
Table 1: Summary of Product-Related Public API Endpoints
API Endpoint | High Level Description |
/api/ProductType/List | Reads existing Product Types within MESTEC and returns a payload |
/api/ProductType/Upsert | Creates a Product Type or updates a Product Type that already exists within MESTEC |
/api/ProductType/Delete | Deletes an existing Product Type if it has not been used |
/api/ProductGroup/List | Reads existing Product Groups within MESTEC and returns a payload |
/api/ProductGroup/Upsert | Creates a Product Group or updates a Product Group that already exists within MESTEC |
/api/ProductGroup/Delete | Deletes an existing Product Group if it is not currently in use |
/api/Product/List | Reads existing Products within MESTEC and returns a payload |
/api/Product/Upsert | Creates a Product or updates a Product that already exists within MESTEC |
/api/Product/Delete | Deletes an existing Product if it has not been used |
/api/Product/Copy | Copies product from a template product |
/api/ProductGroup/AssignProducts | Assigns a Product to a Product Group |
/api/ProductGroup/UnassignProducts | Unassigns a Product from a Product Group |
The documentation also covers a sample use case for a product interface and presents a sample flow diagram representing business logic.