FINS SilverLake Customers System API - Implementation Template
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 Core Banking Customers API specification. This API is for working with the Jack Henry SilverLake provider.
Getting started
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:
- Jack Henry SilverLake Instance
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.
jXchange Web Services
The following table lists the jXchange SilverLake services used by this implementation:
API Endpoint | SilverLake Service - Operation |
---|---|
get:/customers/{customerId} | CustomerService - CustInq |
get:/customers | CustomerService - CustMod, CustInq |
post:/customers | CustomerService - CustAdd |
patch:/customers/{customerId} | CustomerService - CustMod |
get:/customers/(customerId)/contactPoints | CustomerService - CustInq |
post:/customers/{customerId}/contactPoints | CustomerService - CustMod |
put:/customers/{customerId}/contactPoints | CustomerService - CustMod |
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 Name | Description |
---|---|
api.autodiscoveryID | Required if using API Manager to secure this API |
jack-henry-ws.username | Username for connecting to Jack Henry jXchange Service |
jack-henry-ws.password | Password for connecting to Jack Henry jXchange Service |
jack-henry-ws.routing-id | Jack Henry jXchange Service Institution Routing ID |
jack-henry-ws.consumer-name | Jack Henry jXchange consumer name |
jack-henry-ws.consumer-product | Jack Henry jXchange consumer product |
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.
Implementation notes
- This version of the template uses the Jack Henry jXchange Connector instead of using the Web Service Consumer Connector as implemented in prior versions.
- Creation of Customer with partyType as Individual is only supported.
- Search with customerId, emailAddress and individualName are only supported.
- ContactPointAddress is mandatory while creating a Customer.
- TaxId is mandatory and needs to be unique for Creating a customer in Jack Henry SilverLake System. This is mapped to the customerNumber in the incoming request and a auto generated number is used if not provided or the provided value is not numeric.
- Multiple ContactPoints are not supported.
- Only US Postal Addresses are supported.
- There is no appropriate field to store GlobalIDs in Jack Henry SilverLake System.
Additional resources
- The Data mappings tab describes how the request and response data structures are mapped between the API interface and the Jack Henry SilverLake provider.
- Refer to the Accelerators documentation home for more information about the MuleSoft Accelerators.