Overview
API integrations allow you to connect PXM with external systems such as ERPs or other applications. Instead of manually updating data, APIs enable systems to communicate automatically—saving time, reducing errors, and keeping your data in sync.
This article walks through what PXM API integrations are, how to set them up, and best practices to ensure reliable performance.
Before You Begin
To create or manage API integrations in PXM, you must have the Super Admin role.
If you do not see the settings or options described below, it is likely due to insufficient permissions.
Creating an API Authorization
Follow these steps to generate your API credentials:
In PXM, open the left-hand sidebar and click Settings.
Under System, select the Integrations tab.
In the bottom-right corner, click Register Application.
Enter a name for your authorization (for example, API Auth) and save.
After saving, PXM will generate a Client ID and Client Secret. These credentials are required to access the APIs.
⚠️ Keep your Client Secret secure. Do not share it publicly.
Accessing the PXM API Documentation
To explore and test available API endpoints:
Navigate to the PXM API documentation site: https://entapi.amplifi.io/docs/index.html.
Use your Client ID and Client Secret to authorize access.
Click Authorize after pasting your credentials.
From the documentation site, you can:
Explore available endpoints
Test API requests
Confirm that your integration is working as expected
Best Practices for API Usage
To maintain system performance and stability, we strongly recommend the following:
Batch updates only: PXM APIs are designed for daily or less frequent batch updates.
Write/update actions: Update data no more than once per day.
Read actions: Extract data no more than once per day.
Use caching: If PXM data is consumed by other applications, maintain a local data source (cache) that is updated via the API instead of repeatedly calling PXM.
Following these guidelines helps prevent performance issues and ensures consistent data synchronization.
Need Help?
Once your API keys are set up and best practices are followed, API integrations can greatly simplify how you manage and synchronize data in PXM.
For more details, refer to the API documentation or reach out to PXMsupport@pattern.com if you need assistance.