FINS Address Validation 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 Address Validation System API specification. It supports the following functionalities:
- Validates a postal addresses by integrating with USPS Shipping API
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
Each implementation template relies on services or data in order to function.
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.
Prerequisite setup
This system API relies on USPS Web Tools Application Programming Interface to validate US addresses. This link can be used to register to the USPS Web Tool API. Once registered configure the postaladdress-validation-service. Update the postaladdress-validation-service.username in the configuration file with the username obtained over the email.
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 to reflect the target deployment environment.
| Property Name | Description |
|---|---|
api.autodiscoveryID | Required if using API Manager to secure this API |
fins-address-validation-sys-api.host | USPS Shipping API host name |
fins-address-validation-sys-api.port | USPS Shipping API port |
fins-address-validation-sys-api.username | Username that is used to register in the USPS Shipping API |
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 interfaces.
- Refer to the Accelerators documentation home for more information about the MuleSoft Accelerators.