Guide to API Integrations
API integrations in Amplifi offer a powerful solution for connecting your system with your Enterprise Resource Planning (ERP) software. This functionality eliminates the need for manual data updates, streamlining processes and enhancing efficiency. This guide outlines the steps to set up API integrations and recommendations for best practices.
Preparation Steps
Ensure Permissions: Verify that individuals tasked with setting up API integrations have the Super Admin role.
Setting Up API Keys
Go to "Admin" > "System" > "System Settings" and select the "Integration" tab.
Click on "Register a New Application" to generate a new API key. Provide a name and optional description for easy identification.
Once created, the API key will display a client ID and client secret. These will be used in your application for authentication.
API Documentation
Our API documentation is a living working application where you can test and run API commands against your data. Click here to access this resource. Use your client ID and secret to authenticate.
API Best Practices
Amplifi API is best used in daily or less frequent batch updates:
Update and write actions: Update no more frequently than once per day.
Read actions: Extract data no more frequently than once per day. If Amplifi data is meant to be used in other applications you should have a data source that you update on yourside to act as a data cache that is populated using the APIs.