Group Builder

API Group Builder allows the system administrator to create a group for a set of pass though APIs falling under one module. All the parameters that are common for an APIs group can be configured here.

Pre-requisites

Transaction access is provided to System Administrator.

Workflow

Features Supported In Application

The following options are available as part of this maintenance:

Search and View API Groups
View API Services
Create API Groups

You are here How to reach here:

System/ Bank Administration Dashboard > Toggle menu > API Builder > Group Builder

API Groups - Search and View

Using this option, administrator can search for particular API group based on API group name as a search parameters. Search results displays API group name list along with group parameter and service details links.

To search and view API groups:

In the API Group Builder screen, select the search group name from the API Group Name field and click Search.
The API Group Builder screen with search results appears.
OR
Click Clear to reset the search parameters.
OR
Click Cancel to cancel the search process.

API Group Builder - Search

Field Description

Field Name	Description
API Group Name	Name of the API group/ module falling under a module.
Search Results
API Group Name	Name of the API group/ module.
Group Parameters	Link to view the API group parameter details.
Services	Link to view the service details.

Click the Group Parameters link against the record to view the details. The API Group Builder-View screen appears.
OR
Click the Services link against the record to view the details of the services falling under the selected API group.. The API Group Builder – Group Parameters -View screen appears.

API Group Builder – Group Parameters - View

Field Description

Field Name	Description
API Group Name	Name of the pass through API group / module.
API Group Description	Description of the API group.
End Point Configuration	The end point configuration type.
Group Parameters
Host IP	The host IP for the host system for which the pass through APIs are built.
Host Port	The host port for the host system for which the pass through APIs are built.
Authorization Required	The flag to display whether the authorization is required to access the host service.
Authorization Type	The authorization type. The options are: Basic- For accessing using User name and Password Bearer- For accessing using a token
User Name	The user name for authorization. This field appears for Basic type of authorization.
Password	The password for the user name.
Token	The token ID for authentication. This field appears for Bearer type of authorization.

Click Cancel to cancel the transaction and navigate back to dashboard.
OR
Click Back to navigate to the previous screen.

API Group Builder – Services Details - View

Field Description

Field Name	Description
API Group Name	Name of the API group/ module.
Method	The method type of the API service.
Service Name	The service name.
Service Details
API Group Name	Name of the API group/ module.
Service URL	The service URL.
Service ID	The service ID.
Service Name	A unique name assigned to the service.
Header	The header value.
Method Type	The method type.
Transaction Type	The transaction type for the service.
Task Code	The unique task code assigned to the service.
Redaction Type	The redaction type.
Dynamic Business Policy	The flag to display whether the business policy is dynamic or not.
Task Aspect	The transaction aspects that are applied to the service.

Click the particular Service Name link to view the specific service details.
OR
Click the Entitlement Details tab to view the entitlement details.
OR
Click Cancel to cancel the transaction and navigate back to dashboard.
OR
Click Back to navigate to the previous screen.

Entitlement Details

Field Description

Field Name	Description
Module Name	The module name under which the entitlement for the service was created.
Category Name	The category name for the selected module under which the entitlement for the service was created.
Action Type	The action type applicable for the service.

Click the JSON Path tab to view the JSON path details.
OR
Click Cancel to cancel the transaction and navigate back to dashboard.
OR
Click Back to navigate to the previous screen.

JSON Path

Field Description

Field Name	Description
Party ID	The JSON path for party ID.
Account Number	The JSON path for account number.
Currency	The JSON path for currency.
Amount	The JSON path for amount.
Error Code	The JSON path for error code.

Click the Alerts tab to view the alert details.
OR
Click Cancel to cancel the transaction and navigate back to dashboard.
OR
Click Back to navigate to the previous screen.

Alerts

Field Description

Field Name	Description
Alerts	If the alerts are configured for this service.

Click Cancel to cancel the transaction and navigate back to dashboard.
OR
Click Back to navigate to the previous screen.

API Group Builder - Create

Using this option, System AdministratorAdministrator is a set of individuals that administer the applicant/Affiliate entity. For example, Accountants, Authorized Signatories for organizations, Power of Attorney for individuals. can create an API group.

To create an API groups:

In the API Group Builder screen, click Create. The API Group Builder - Create screen appears.

API Service Builder - Create

Field Description

Field Name	Description
API Group Name	Name of the API group/ module under which the pass through APIs are to be created.
API Group Description	Description of the API group is to be created.
End Point Configuration	The end point configuration type.
Group Parameters
Host IP	The host IP for the host system for which the pass through APIs are is to be created.
Host Port	The host port for the host system for which the pass through APIs are is to be created.
Authorization Required	Whether the authorization is required to access the host service. The options are: Yes No
Authorization Type	The authorization type. The options are: Basic Bearer
User Name	The user name for authorization. This field appears if you select Basic option in the Authorization Type field.
Password	The password for the user name. This field appears if you select Basic option in the Authorization Type field.
Token	The token ID for authentication. This field appears if you select Bearer option in the Authorization Type field.

In the API Group Name field, enter the name of the API group.
In the API Group Description field, enter the description of the API group.
From the End Point Configuration field, select the appropriate option.
In the Group Parameters section, enter the host IP in the Host IP field.
In the Host Port field, enter the host port number for the host system.
In the Authorization Required field, select the appropriate option:
If you select Yes option, select the appropriate option in the Authorization Type field.
If you select Basic option in the Authorization Type field:
In the User Name field, enter the user name for authorization.
In the Password field, enter the password.
If you select Bearer option in the Authorization Type field:
In the Token field, enter the user name for authorization.
Click Save to save the created API group.
OR
Click Cancel to cancel the transaction and navigate back to dashboard.
OR
Click Back to navigate to previous screen.
The Review screen appears. Verify the details, and click Confirm.
OR
Click Cancel to cancel the transaction.
OR
Click Back to navigate to previous screen.
The success message appears along with the status of the transaction.
Click OK to complete the transaction.

Home