Help & Resource Center

Confirm API Connection

After retrieving your API credentials, the next step in the integration process is to establish a stable connection between the Modern Retail Integrator and your AIM POS system. This ensures that data can flow smoothly between your systems.
Testing Your API Connection
To verify that your AIM POS API connection is active and stable, your Modern Retail project manager can perform an initial API connection test using a web browser.
  1. Open a web browser and enter the following URL format:https://epw.aim-ae.com/stores/YOUR_API_KEY
  2. Replace YOUR_API_KEY with the actual AIM POS API Key. For example, if the API Key is:62c4g87b-5g06-5f6e-9dc9-fgee24fb4999 the full test URL will be https://epw.aim-ae.com/stores/62c4g87b-5g06-5f6e-9dc9-fgee24fb4999

  3. Navigate to that URL in a browser. The status page should look similar to this:

API Connection 3.png

Interpreting the Status Page

  • If the Status reads "API is working correctly," check off the corresponding onboarding task.

  • If the Status reads "API is currently down – Connection Refused," please contact AIM POS Support for assistance in resolving the issue.

After Modern Retail confirms that the API connection is successfully established, we will proceed with the next steps in your integration project.

If you have any questions about this step or any other part of the onboarding process, please reach out to your Modern Retail project manager.