The Custom Integration feature allows you to securely connect your own applications and services to the BayEngage platform using our APIs. To establish this connection, you will need to generate a unique set of credentials: a Client ID, a Public Key, and a Private Key.
This guide will walk you through the process of generating and managing your Version 1.0 integration keys.
Understanding your credentials:
Client ID: A unique public identifier for your application. It is used to identify your application when it makes a request to our API.
Client Secret (private key): A confidential key that must be kept secret. It is used to authenticate your application's API requests. Treat your private key like a password; never share it or expose it publicly.
Client Secret (public key): A key that can be shared and is used to verify the requests signed by your private key.
How to generate your API keys
Follow these steps to generate the necessary keys for your custom integration setup.
Navigate to the custom integration page:
From your main dashboard, go to the App section and select Custom Integration.
Locate your Client ID:
Under the VERSION 1.0 section, you will find your pre-generated Client ID.
Generate your client secret keys:
The Client Secret (private key) and Client Secret (public key) fields will initially show "None".
Click the Generate Client Secret button next to either the private or public key field.
This single action will generate a new unique key and automatically populate the public and private key fields.
Copy and securely store your keys:
Once the keys are generated, immediately copy both the public and private keys.
IMPORTANT: Your private key is highly sensitive. Store it in a secure location, such as a password manager or a secure server environment variable. For security purposes,the keys may not be displayed again after you navigate away from this page.