Learn how to get access to a Kustomer account and obtain a valid API key to start creating apps with Kustomer.
Before you can create and register an app with Kustomer, you'll need access to a sandbox Kustomer organization and access to a valid API key.
Accessing a Kustomer account
Developers can access a Kustomer account through the following:
If you'd like to create a private app to install for your organization, develop and test apps using a sandbox account before you register the app to your Kustomer organization. You can contact [email protected] to request a new sandbox account or to request a test organization for development.
To create and register apps, you must have at least Administrator access to your Kustomer organization.
Partners and independent developers
If you'd like to create an app for a client or for a broader audience, you can request a partner organization through Partner with Kustomer.
Obtaining an API key
A valid API key is required to register or update an app with Kustomer. The Kustomer API uses your API key to authenticate requests for registering and updating your app. To generate an API key:
- In your Kustomer organization, navigate to Settings > Security > API Keys.
- Select Add API Key.
- Give your API key a descriptive name and an appropriate expiration date.
- Set the Roles for your API key to include
org.permission.appsat the minimum.
- Once you've created your API key, copy and save the key in a secure place (for example, a password manager) if you intend to reuse the key. If you lose your API key, you won't be able to access the key again in the Kustomer UI and you'll need to generate a new one.
Once you have access to your Kustomer organization and a valid API key, you can start creating apps with the Kustomer Apps Platform.
Updated over 2 years ago