Remember that integrations via API must be carried out by an IT specialist.
Get there
- Open the Control menu
- Go to Settings
- Click on Developers
Using Holded's API
Holded's API is very useful in cases in which you want to carry out a personalized integration between Holded and other apps you use in your business, to automate the use of the platform as much as possible.
We encourage you to visit the Holded store to check the integrations we've already built so that you can directly connect your everyday apps to Holded without having to use the API. If none of the options works in your case, read on to find out how to use our API.
1. Creating the API Key
In order to use the API of Holded, you will need to create an API Key that will allow you to identify your Holded account and transfer information between applications.
- Click on New API Key
- Use the field Description to enter the name that you wish to give to the Key
We recommend that the name refers to the application that you want to integrate with Holded (for example, WooCommerce). In this way, it will be much easier for you to find each of the Keys that you generate in Holded and understand what they are used for.
- Hit Save
An alphanumeric code will be generated. You can copy this code from the APIKEY column, next to the Key name (Description).
2. Checking the API's documentation
Once you have generated the API Key, you will need to refer to the API documentation to find out which sections of Holded are available for integration:
- Click on API Documentation
- Check out the available actions and items to work with within each of the sections in the API:
Section Items with available actions Invoice Contacts, Contact groups, Products, Warehouses, Taxes, Treasuries, Numbering series, Expenses accounts, Sales channels, Payments, Documents, Remittances, and Services. CRM Funnels, Leads, and Events. Projects Projects, Tasks, and Time tracking. Team Employees and Employees' time-tracking. Accounting Daily ledger and Chart of accounts.
3. Testing using Postman
Before carrying out the API integration, the technicians in charge will be able to test it via Postman:
- Download the Postman app
- Check whether the features you need are available
After the tests, and if everything works correctly, you will be able to perform the integration definitively.