- API Keys
- Marketing Campaigns
- Upload Library
- Mail Shots
- Using HubSpot with Workbooks
- Introduction to Transaction Documents
- Credit Notes
- Customer Orders
- Supplier Orders
- Contract Management
- Introduction to System Administration
- Users & Security
- Email & Integration
- PDF Configuration
You can integrate external systems with Workbooks using the Workbooks API. Using API keys allow external systems to access a specified Workbooks Database on the user's behalf, with all of their capabilities and permissions.
Creating an API Key to allow to allow external systems to communicate with Workbooks removes the need for the external system to login using a username and password each time.
An API Key can be created by going to Start > Configuration > Email & Integration > API Keys > New API Key. Next, select a user using the dropdown picklist next to 'Access as User'. This determines which user the API Key will run as, with their capabilities and permissions.
You will also give the API Keys a name which you can use to easily identify what it is used for, along with a description if necessary.
Further to this you can specify certain login restrictions, such as a range of dates for which the API Key is valid and a permitted IP address.
Once you have done this click Save & Close. The API Key will now appear on the grid on the right.
NOTE: If you delete or disable a user who is designated as the 'Access as User', the external system will no longer be able to communicate with Workbooks. In this circumstance, you should edit the API Key.