Service Builder

This option allows the system administrator to build pass through APIs by using REST APIs exposed by host or any third party system.

To create a new pass through APIs a system administrator has to create a group builder first and then select the created API group and enter the service details.

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 Service
Create API Service

You are here How to reach here:

System/ Bank Administration Dashboard > Toggle Menu > API Builder > Service Builder

API Service - Search and View

Using this option, administrator can search API services based on API group name as search parameters. 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 also enter other search parameters for specific service search. The search results displays a list of services and its details.

To search and view API service:

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 Service Builder - Search

Field Description

Field Name	Description
API Group Name	Name of the API group maintained under a module.
Service ID	The service ID as a search parameter.
Service Name	A unique name assigned to the service as a search parameter.
Service URL	The service URL as a search parameter.
Search Results - Service Details
Method Type	The method type of the API service. The method type can be: Get Post Put Delete Patch
Service Name	The service name.
Service ID	The service ID.
Service URL	The service URL.

Click the Service URL link against the record to view the details. The API Service Builder - Service Details -View screen appears.

API Service Builder - Service Details - View

Field Description

Field Name	Description
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 is applied to the service.

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

API Service Builder - Entitlement Details - View

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	JSON path for party ID.
Account Number	JSON path for account number.
Currency	JSON path for currency.
Amount	JSON path for amount.
Error Code	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 or not.

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

Service Builder - Create

Using this option, System Administrator can create a service API.

To create a service API:

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

API Service Builder - Create

Field Description

Field Name	Description
API Group Name	Name of the API group maintained under a module.
Service URL	The service URL.
Service ID	The identification for the service which is to be created.
Service Name	The service name.
Header	The header key and header value.
Method Type	The method type. The options are: Get Post Put Delete Patch
Transaction Type	The transaction type for the service. The options are: Financial Non-Financial Inquiry Admin Maintenances Maintenances Others
Task Code	The unique task code of the service.
Redaction Type	The redaction type. The options are: NONE XSLT JOLT JAVA JAVA_SCRIPT
File Name	The option to upload the file. This field appears if you select JAVA from the Redaction Type field.
Dynamic Business Policy	The flag to display whether the business policy is dynamic or not.
File Name	The option to upload the file. This field appears if you select Yes from the Redaction Type field.
Task Aspect	The task aspects that is applied to the service which is to be created.

In the API Group Name field, enter the name of the API group.
In the Service URL field, enter the service URL.
In the Service ID field, enter the identification for service.
In the Service Name field, enter the name of the service.
In the Header field, enter the values in Key and Value field.
OR
Click the Add More link to add multiple headers.
OR
Click to delete the added header.
From the Method Type field, select the appropriate method.
From the Transaction Type field, select the appropriate type of transaction.
In the Task Code field, enter the task code for the service.
From the Redaction Type field, select the redaction type.
If you have selected JAVA option, browse and select the file to be uploaded, in the File Name field.
From the Dynamic Business Policy field, select the appropriate option.
If you have selected Yes option, browse and select the file to be uploaded, in the File Name field.
From the Task Aspect field, select the task aspects to be applied to the service.
Click Next. The API Service Builder - Entitlement Details tab appears.
OR
Click Cancel to cancel the transaction and navigate back to dashboard.
OR
Click Back to navigate to previous screen.

API Service Builder - Entitlement Details

Field Description

Field Name	Description
Module Name	The module name under which the entitlement for the service is to be created.
Category Name	The category name for the selected module under which the entitlement for the service is to be created.
Action Type	The action type applicable for the service. The options are: Perform Approve View

Field Name

Description

Module Name

The module name under which the entitlement for the service is to be created.

Category Name

The category name for the selected module under which the entitlement for the service is to be created.

Action Type

The action type applicable for the service.

The options are:

Perform
Approve
View

From the Module Name field, select the appropriate module.
From the Category Name field, select the appropriate category.
From the Action Type field, select the appropriate action.
Click Next. The API Service Builder - JSON Path tab appears.
OR
Click Cancel to cancel the transaction and navigate back to dashboard.
OR
Click Back to navigate to previous screen.

API Service Builder - JSON Path

Field Description

Field Name	Description
Party ID	JSON path for party ID.
Party ID - JSON Result	JSON result for party ID.
Account Number	JSON path for account number.
Account Number - JSON Result	JSON result for account number.
Currency	JSON path for currency.
Currency -JSON Result	JSON result for currency.
Amount	JSON path for amount.
Amount - JSON Result	JSON result for amount.
JSON Path for Error Code
Error Code	JSON path for error code.
Error Code - JSON Result	JSON result for error code.
JSON Evaluator	It is a tool to validate the JSON path entered.. Enter the JSON path against each field then enter the JSON in the evaluator and click on Evaluate. System will populate the result against each field if the validation is successful.

In the Party ID field, enter the JSON path for party ID.
In the Account Number field, enter the JSON path for account number.
In the Currency field, enter the JSON path for currency.
In the Amount field, enter the JSON path for amount.
In the Evaluator tool, enter the complete JSON and click Evaluate.
The tool validates the JSON and will populate the JSON Result field (if the evaluation is successful).
Click Next. The API Service Builder - Alerts tab appears.
OR
Click Cancel to cancel the transaction and navigate back to dashboard.
OR
Click Back to navigate to previous screen.

Alerts

Field Description

Field Name	Description
Alerts	Select Yes if alerts needs to be configured.

In the Alerts field, select the appropriate option.
Click Save to save the created API service.
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