Skip to main content

Integration

Introduction

For first phase of integrating MRE into MyCRM, we've decided to:

  • Add a way to open MRE (iframe or new tab) from MyCRM with ready loaded data for generating a report
  • MyCRM will communicate to MRE data (inputs) required to calculate a specific case via an endpoint provided by MRE - Create a session
  • Data is stored in "sessions" which can be loaded by passing a session ID as URL parameter to BlackFin hosted frontend of MRE tool - https://mre.blackfin.tools/

 

 

API

Server to server API

The MRE exposes a RESTful API which uses standard HTTP response codes, authentication, and verbs, and uses JSON payloads. The API is hosted on environment-specific domains:

Environment API Base URL
Test https://api.mre.test.blackfin.tools/
Production https://api.mre.blackfin.tools/

 

Endpoints

API endpoints are represented as paths appended to the base URL. For example, create a session endpoint URL is:

https://api.mre.test.blackfin.tools/sessions/create

Authentication

The API uses the Bearer token authentication method. That means HTTP Header Authorization should contain string:

 

Bearer <API_KEY>

Where <API_KEY> is replaced by the API key issued to you by BlackFin.

 

 

User Interface

The Mortgage Recommendation Engine UI can be accessed

Environment Web URL
Test https://mre.test.blackfin.tools/
Production https://mre.blackfin.tools/

The UI does not currently require enforce any authentication


Back to top