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 - httpsEngineCreateSession
  • 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

Mortgage Recommendation Engine exposes JSON RESTful API which uses standard HTTP response codes, authentication, and verbs.

Endpoint is hosted on environment-specific domains:

  • Development: https://api.mre.test.blackfin.tools/
  • Live: TBA

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

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

Bearer <API_KEY>

Where <API_KEY> is replaced by an API key issued by BlackFin.

Environments

At the time of writing, API for MyCRM use is available only on our development environment for multiple securities feature release: mortgage-rec-engine-dev-msec. This environment is not production ready and should be used sparingly.


Back to top