API Client Registration
API Client Registration
The API Client Registration feature allows administrators to register and manage both internal and external API clients. Once registered, these clients can be used to call APIs directly, including through tools such as Postman.
This section describes how to:
Register internal and external API clients.
Configure API clients with the required authentication details.
Call the APIs using Postman.
Prerequisites
Access to the Admin Module.
Valid credentials to register API clients.
Postman installed on your local machine.
Registering an API Client
Navigate to the Admin Module.
Click API Client Registration in the side navigation bar.
The API Client Registration page opens.
Click New to create a new client registration.
Select one of the two Authentication Types:
Internal
External
Internal Client Registration
Internal authentication is managed from the platform using the Client ID, Client Secret, App Name, and Content Type.
Select Internal as the authentication option.
Provide the following information:
Client Name
Client Email
App Name
Request Per Hour
Request Per Day
Select API Type: Choose one option:
Data as API
Model as API
AI as API
Widget as API
After selecting an API type, the field Select the entitled services appears. Select one or more services using the checkboxes.
Click Save after filling in all fields.
A notification message confirms the creation.
The new API client is listed at the top of the Client List.
Note:
The Client ID and Client Secret are generated automatically when saving the registration.
Both Data as API and Model as API support internal authentication.
External Client Registration
External clients use authentication with Secret Key and Values/Mapping Key. Authentication is valid only when the Validation Type is set to Validated.
Select External as the authentication option.
Provide the following information:
Client Name
Client Email
Select Entitled Services (from the Data Center module’s published datasets).
Key, Validation Type, and Value/Mapping Key.
Click Save.
A notification confirms the creation.
The client appears at the top of the Client List.
Using Postman to Retrieve Data
Internal Client API Request
In API Client Registration, click Edit for the registered client.
Copy the following details:
Client ID
Client Secret
App Name
Content Type (from the Headers section).
Copy the API URL from the GET/POST section.
In Postman:
Navigate to Collections → create a new connection.
Select GET from the method dropdown.
Paste the copied URL.
Navigate to the Headers tab and add:
clientidappnameclientsecretcontent-type
Click Send.
The response appears under the Body tab (default: JSON).
Required Parameters:
Client ID
App Name
Client Secret Key
Content-Type
External Authentication API Request
In Postman, navigate to Collections → create a new connection.
Select GET as the method.
Enter the API URL including the tenant (space) name.
In the Headers tab:
Add Content-Type.
Select the appropriate value (e.g.,
application/x-www-form-urlencoded).
Click Send.
The response is displayed under the Body tab (default: JSON).
Note: If the tenant or space name is not included in the URL, the GET request will fail.
Adding Additional Keys & Values (External Clients)
External clients can be configured with extra key-value pairs during registration or through editing.
Go to API Client Registration.
Enter Client Name and Client Email.
Click the plus (+) icon to add a new key-value pair.
Define the parameters:
Key
Validation Type (dropdown)
Value or Mapping Key
Click Save to complete the registration.
Use the mapping key value along with Content-Type in the Headers section of a Postman GET/POST call to retrieve data.
Send Mail to Client
Edit Client Details
Delete Client
Download
Last updated