fins-financial-institutions-sys-api

(0 reviews)

home

This API implementation template is a component of MuleSoft Accelerators, which accelerate the implementation of essential integration use cases.

The solution includes pre-built APIs, connectors, and integration templates that help unlock business-critical data from external systems and guide you in adopting best practices synthesized from thousands of customer implementations. Use these assets as is or extend them to meet your company’s unique needs.


Overview

This integration template implements the Financial Institutions Sys API specification.

Getting started

bulb.png The Getting Started with MuleSoft Accelerators guide provides general information on getting started with the accelerator components. This includes instructions on setting up your local workstation for configuring and deploying the applications.

Once your workstation has been set up and the application template imported into Anypoint Studio, proceed with the Prerequisites section.

Prerequisites

This implementation template has the following dependencies:

  • MariaDB

Please review the use cases described on the MuleSoft Accelerator for Financial Services solution pages for more information about dependencies on other APIs and services.

Configuring the MariaDB

These instructions assume that you have a MariaDB version 10.6.8 or later. There are DB Scripts located under the src/test/resources/scripts folder.

  1. Run the DB scripts for the Core Banking Customers System API first
  2. Run the DB scripts for this API in below order:
    • create-institutions-schema.sql
    • create-reference-data.sql
    • create-logging-scripts.sql (optional, for debugging)
    • generate-sp-create-script (produces a script to create all stored procs)
    • create-stored-procedures.sql

To drop the tables and stored procedures, execute the scripts drop-institutions-schema.sql and drop-stored-procedures.sql, respectively. To truncate data from the tables, use the truncate-data.sql script.

Deployment

Each Accelerator implementation template in Exchange includes Bash and Windows scripts for building and deploying the APIs to CloudHub. These scripts depend on repositories, global settings, deployment profiles, and associated properties configured in the Maven settings.xml file.

For additional details, please refer to the Application Deployment section of the Getting Started Guide.

Preparation

Ensure the Maven profile CloudHub-FINS-DEV has been properly configured in your settings.xml file. In particular, make sure the common properties for your environment have been provided (e.g., Anypoint Platform client ID and secret).

Required property overrides

At a minimum, the following properties must be customized for this application to reflect the target deployment environment.

Property NameDescription
api.autodiscoveryIDRequired if using API Manager to secure this API
core-banking.database.hostCore Banking Database Hostname
core-banking.database.nameCore Banking Database name
core-banking.database.usernameCore Banking Database username
core-banking.database.passwordCore Banking Database password

Implementation notes

  1. Search for institutions by institution ID, institution type, or external ID
  2. Obtain institutions modified between a given time period
  3. Retrieve an institution by its identifier
  4. Create an institution
  5. Update an institution
  6. Retrieve a bank by its bank code

Testing

Use Advanced Rest Client or Postman to send a request over HTTPS. The template includes a Postman collection in the src/test/resources folder. Update the collection variable(s) after successful import.

Additional resources


Reviews

TypeTemplate
OrganizationMulesoft Inc.
Published by
MuleSoft Solutions
Published onNov 10, 2023
Asset overview

Asset versions for 1.6.x

Asset versions
VersionActions
1.6.2
1.6.1
1.6.0