Glossary
What is API?
A short definition of API, how it is applied on the floor and where it lives in the product.
- Short definition
- API: Application programming interface: the defined door through which a piece of software opens its data and functions to other software; machines talking instead of screens.
How is it applied?
An ERP, a BI tool or the company's own report pulls data from the API; access is limited by a key and what can be read and what can be written is documented. Each integration needs its own permission and log. Fictional example: the company's BI tool reads the number of open actions from the API every night and adds it to the management report. The key it uses carries read permission only. An API is often confused with a file export. An export is a one-off file a person takes by hand; an API is called by software repeatedly under set rules.
In the product
In the product the read API serves record, action, indicator, unit and person data; the inbound webhook accepts indicator measurements only. The company switches it on and manages the key; there is no ready-made ERP connector.