Integration Configurations for Alternative Reference Rates
The third-party API call for fetching Alternative Reference Rates is made through the Q2 Integrations Framework. The third party has a certain API, and there is a certain API configuration for it. There can be multiple third parties, such as ICE and more. Q2 Loan Servicing has made such an integration configurable using the Q2 Integration Framework.
Configure the Integration
As part of the API configuration, if you want to customize it, you have to provide the details on how that adapter has to be configured.
Prerequisites
Before you proceed to configure the integration for Alternative Reference Rates, ensure that the following prerequisite is met:
- The Q2 Integrations Framework package version 4.1000 is installed.
Steps
Log in to your Salesforce account.
Go to (App Launcher), and in the Search apps and items... box, search for
Integration Configurations
and click it.The following page is displayed:
Go to Integration Family > Define a New Integration Family, and provide the following values:
Field Value Integration Family Name Provide the required value. For example, Alternative Reference Rates. On the Integration Configurations page, go to Integration API Types > Define a New Integration API Type, and provide the following values:
Field Value Integration API Type Specify the required value. For example, Interest Calculator. Integration Family Provide the required value. For example, Alternative Reference Rates. On the Integration Configurations page, go to Integration API Configuration > Define a New Integration API Configurations, and provide the values as explained in the following table:
Note:You can refer to the image following the table as an example.
Field Action and Description API Configuration Name Specify a valid API configuration name. Integration Family Specify the Integration Family name that you have configured. Integration Provider Specify the required provider. Integration API Type Specify the required Integration API Type. For example, Interest Calculator, as displayed in the following image. Integration Configuration Specify the name of the Integration Configuration. Adapter Class Name Specify the adapter class name. If you are using a third party, write your own custom adapter class and specify that class name.
The class name in the image displays the adapter class name as loan.ARRCalculatorAdaptor. This is a sample class name created within the loan package and extends the Q2 Integration base adapter.
API Named Credential Specify the required API Named Credential. The named credential called ARR as depicted in the following image is created as part of the Q2 Loan Servicing installation. It is provided only as a sample. You have to create a Named Credential for the new endpoint that you are using. API Endpoint Specify the required third-party API endpoint. Request Mapping Provide the request mapping for the following parameters:
Note:Refer to the sample Request Mapping in the following image for more details:
- name: Provide the third party name.
- externalField: Provide the values as per the third-party fields.
Response Mapping Provide the response mapping by referring to the same Response Mapping in the following image. After configuring, the Integration API Configuration would look like the example in the following image: