1. Allmoxy
  2. API/Database

Create Client ID and Secret Key | Set Up API Connections

Setting up your API connections

An API, or application programming interface, is a way for different software systems to communicate. To access an API, you typically need to provide some form of authentication and credentials token.

In Allmoxy, you access the API with your Client ID and Secret Key. These necessary tokens ensure only authorized users can access the API and its associated data. Without these credentials, anyone could potentially access the API and its data, which could be a security risk. This is why once you have generated your Client ID and Secret Key, it's important to keep them secure. You should only share these credentials with people who need to access the API. Anyone working with your API can do so via these credentials and an Access Key

It's important never to regenerate your Secret Key and Client ID, once you have initially created them. Regenerating these credentials could cause disruption to any existing integrations you have set up and potentially cause data loss or other issues. This is why we strongly recommend limiting permissions to edit Integrations and Manage the API key. You can do so by navigating to Contact > Edit > Scroll to Integrations Permissions.

 image.thumb.png.e2d238d9d2d10dc3b820bcdda877c90d.png

Generate API Client ID and Secret Key

When you are ready to create your Client ID and Secret Key, Navigate to Settings > Integrations > Generate Client ID and Secret. Review the pop-up to ensure you are prepared to generate or regenerate this information, then confirm to create.image.thumb.png.3c57d1b9b9d39a5f13433bf7e247714c.png

Once your Client ID and Secret Key have been generated, you can find them back here anytime you need them for reference. You'll also be able to Generate API Authorization Token here when needed, as well as reference a complete list of existing contact Access Keys.


Note: once generated, API Authorization tokens are good for 3,600 seconds; if expired, you'll need to regenerate the authorization token onlyimage.thumb.png.91c439b33b21f7238c31029e2e05a9eb.png