FINS Synergy Documents 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 FINS Core Banking Documents System API specification. This API is for working with the Jack Henry Synergy 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 Synergy
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 Synergy services used by this implementation:
| API Endpoint | Synergy Service - Operation |
|---|---|
| get:/documentImages/ | ImageService - DocImgSrch |
| post:/documentImages | ImageService - DocImgAdd |
| get:/documentImages/{documentImageId} | ImageService - DocImgSrch |
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.
Additional resources
- The Data mappings tab describes how the request and response data structures are mapped between the API interface and Jack Henry Synergy provider.
- Refer to the Accelerators documentation home for more information about the MuleSoft Accelerators.