APIs are the programmatic way to "talk to Erply", and let you:
If you are new to Erply API development, then most likely what you need is "Erply API". It is an all-around, general-purpose API that supports Erply's standard features.
Erply API has a separate documentation site. You can start with usage instructions and the list of available calls.
We are also continuously introducing new purpose-built REST APIs — each one for a particular area of functionality. These APIs expose data in a more approachable format and have additional features.
These APIs consume and produce JSON.
For initial authentication, use a username and password. This will give you a session key to use with subsequent requests.
Manage registers (points of sale), users and employees.
Build interactive user authentication, two-factor authentication, password resets.
Note: if you just need a session key to make calls from your integration, see verifyUser instead.
Store app configuration.
Upload and fetch pictures and files.
Manage customer information.
Fetch product quantities on hand, reserved quantities and cost changes. Add products to purchase orders and transfer orders.
Extend Erply records with additional data.
Manage products and assortments.
Day opening and closing, cash in and out, gift cards.
Create and retrieve sales documents. Fetch printouts.
Fine-grained warehouse management.
A common need is to synchronize data from Erply to another system.
Here is a high-level overview how to build a web shop integration.
Erply supports push notifications via web hooks, but note that the information returned via web hooks might be limited.