Invision Community

Create an IPS API key for TerminalCAD

TerminalCAD integrates with Invision Community directly using IPS’ REST API. Each IPS4 community provides its own instance of the API. This means if you have multiple IPS communities, API keys are each issued separately.To create an IPS API key, first log into the AdminCP

1. Once you are logged into the AdminCP, head to System > API
2. Click on REST API Keys, then click Create New
3. Once you do that, you’ll be brought to a screen where you can create and limit what the API key can access. You can find the API key on the top of the page, and an input to name the API key. Additionally, you can select the API endpoints that we will have access to. We only require access to the following endpoints:

• GET /core/groups
• GET /core/members

Then, remember to press Save at the bottom of the screen!

Connect IPS with your TerminalCAD community

After you’ve create an IPS API key, you’ll need to configure it for your TerminalCAD community.

Please note that community owners are the only people that can configure this in TerminalCAD.

1. Head over to your community admin panel > Third Party Integrations > Under Invision Community, click Configure.
2. Enter your Community URL and IPS API key you created in Step 1 and click the Save button for each respective input.

Your community url is the domain in which IPS is hosted at. For example, if your IPS instance is hosted at https://ips.example.com. You would enter example.com for your community url. You can also find your community url under System > API > REST API Reference, as shown in the screenshot below.

✅ Success