Help & Resource Center

API Connection


The next step Modern Retail takes after retrieving your API credentials is to initialize the connection between the Modern Retail integrator and your POS system. This article will briefly go over what we're doing for this step, and what it means for your project.


After getting your API credentials from Tri-Tech, you'll perform an initial API connection test.

You need to create a specially formatted URL which is:

For example, your store's AIM API Key may look something like this

Putting the URL and AIM API Key together gives you the following URL:

Navigate to that URL and you'll see a status page that looks like the example below:


The Status box is the most important field here. If the Status reads, "API is working correctly," please check off the corresponding Onboarding task.

If the status page looks like the example below:


...please reach out to your Tri-Tech/AIM dealer for assistance with the connection.

Once this test is successful and the Onboarding task is complete, Modern Retail will perform an additional connection test. Because this connection is incredibly important for the day-to-day function of your site, we make absolutely certain that everything is safe & stable. After we're certain that the API connection is established, we'll proceed with the next steps in your project.

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