Developer Tools in Sprinklr
Updated
The Developer Tools in Sprinklr provide a centralized and self-service way to manage your Developer Applications, API Keys, and Secrets directly within the platform. This tool allows developers to handle the entire API lifecycle in one place.
With Developer Tools, you can:
Create and manage developer apps without leaving Sprinklr.
Generate and manage API credentials, including keys and secrets.
Generate an Access Token directly from the Sprinklr UI.
Enable or disable client credentials for any app.
Revoke API keys or delete apps when needed.
Benefits and Use Cases
Simplified API lifecycle management for developers.
Improved security and operational control through centralized management.
Reduced dependency on external tools, making token generation and troubleshooting faster and more efficient.
Note: Access to this feature is controlled by a dynamic property (DP). To enable this feature in your environment, reach out to your Success Manager. Alternatively, you can submit a request at tickets@sprinklr.com.
Prerequisites
Before you begin, make sure your user account has the following API Applications permissions:
View: Allows you to access and view existing Developer Apps.
Create: Allows you to add new Developer Apps.
Edit: Allows you to modify existing Developer Apps.
Delete: Allows you to remove Developer Apps.
Generate Token: Allows you to generate API token for authentication.
Configure Developer Apps in Sprinklr Platform
Developer Apps allow you to integrate external systems with Sprinklr using APIs. Follow the steps below to create, manage, and configure Developer Apps directly within the platform:
Step 1: Access the Developer Apps
The steps to access the Developer Apps depend on whether your environment uses the old All Settings UI or the new All Settings UI.
Access Developer Apps in Old All Settings UI
Follow the steps below to access Extensions Library in Old All Settings UI:
Navigate to All Settings from Sprinklr Launchpad.
In the Platform Settings window, select Manage Customer from left toolbar.
From the list of options, choose Developer Apps. You can also use the search bar at the top to quicky find it.
The Developer Apps Record Manager opens.
Access Extension Library in New All Settings UI
Follow the steps below to access Extensions Library in new All Settings UI:
Navigate to All Settings from Sprinklr Launchpad.
Select APIs and Integrations from left navigation bar to open detailed record manager.
Click the Developer Apps option from left menu to access Developer Apps Record Manager.
Step 2: Create a New Developer App
Follow the steps below to create a new developer app:
On the record manager screen, click the ‘+ Create App’ button the top right corner to create a new Developer App.
The Create App screen will appear. Configure the input fields as described in the table below:
Field | Description |
App Name (Required) | Refers to the name of your application. It is recommended to name your application based on the use case you will be using it for.
You can also tie the name of your application with the environment you'll be using it for, for example, Sandbox or Production. |
App Description (Optional) | Refers to the use case your application is trying to solve. This helps identify the objective of the application when monitoring usage in future. |
Callback URL (Required) | The Callback URL is the redirect_uri that tells the authorization server where to send the user back after the successful account authorization.
The URL must be a valid, publicly accessible URI; otherwise, the authorization call will return an error.
For example, if you are entering Sprinklr’s web URL, it should be https://www.sprinklr.com. |
Enable Mutual TLS Authentication (Optional Toggle) | Sprinklr APIs support Mutual TLS (mTLS) Authentication as an additional layer of security for client-server communication. In mTLS, both the client and the server authenticate each other using their respective TLS certificates, offering enhanced protection against unauthorized access.
Enable the toggle to use Mutual TLS (mTLS) Authentication. |
Click the ‘Save’ button at the bottom right corner to proceed. Your Developer App will start appearing in the record manager screen.
Step 3: Generate API Key
In this step, we will create API Key for the created developer app.
Follow the steps below to proceed:
Once the app is created, click the vertical ellipses button and select the Manage API Key/Token option from the dropdown.
The Manage API Key / Token screen will open. In this screen you can manage all the API Keys generated for the respective Developer App.
Click the ‘+ API Key’ button in the top right corner of the screen to create a new API Key.
Once the API key generation is complete, you will get the API Key and Secret details on the pop-up screen. You can copy these for future reference. Click the ‘Close’ button to close this window.
The generated API Key will start appearing on Manage API Key/Token screen. The Secret is masked for security reason.
Step 4: Generate Access Token
Now you need to generate Access Token for the Developer App. Follow the steps below to proceed:
Click the ‘Generate Token’ button to create token for the app.
You will be redirected to the Authenticate to Process screen. There are two ways to Authenticate:
Authenticate using Credentials: The screen will have your Sprinklr user id, enter your password and click ‘Next’.
Authenticate using SSO: If SSO is enabled for your profile, click the ‘Continue with SSO’ button.
After successful authentication. You will be redirected to Two Factor Authentication window. Enter the code sent to your registered email id and click the ‘Verify’ button.
Once successfully verified, the screen with Access Token and Refresh Token along with the expiry date will appear. Save these tokens for your reference as you can view and copy these details only once, and they cannot be recovered.
Once done, click the Close button. Use the Regenerate Token button to regenerate token when required and follow the procedure as mentioned above.
Step 5: Enable Client Credentials (Optional)
Turn on the Enable Client Credentials toggle to allow the app to securely request access tokens from the server without requiring a user login.
Note: If you disable this option later, all integrations using Client Credentials will stop working. To restore functionality, you must generate a new access token and update it across your systems.
Once you have generated the API Key and Access Token, your Developer App configuration is complete. You can now start using Sprinklr APIs to build integrations, automate workflows, and connect external systems with the Sprinklr Platform. For best results, ensure that you keep your credentials secure and update tokens as needed to maintain uninterrupted functionality.