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

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

API 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

Each environment has a matching MRE UI:

  • Development: https://mre.test.blackfin.tools/
  • Live: https://mre.blackfin.tools/
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

API for MyCRM is available only on development environment. This environment is not production ready and should be used sparingly.


Back to top