Moneytree Link JavaScript SDK

This is a library for browser client to help you integrate Moneytree tools such as My Account and the Vault without having to do it yourself.

Installation

Browser based

Include the script tag

<script
  type="text/javascript"
  src="https://cdn.jsdelivr.net/npm/@moneytree/mt-link-javascript-sdk@<version>/dist/index.js"
></script>

Change the <version> by the one you need (most likely the latest available). You can also replace <version> by latest to always get the latest published, at your own risk.

You will find the library under window.mtLinkSdk.

CommonJS

Using NPM simply install the library

npm install @moneytree/mt-link-javascript-sdk

Then you can use it directly in your code:

var mtLinkSdk = require('@moneytree/mt-link-javascript-sdk'); // es5
// or
import mtLinkSdk from '@moneytree/mt-link-javascript-sdk'; // es-next

The source also include a Typescript definition.

API

Inititalising the API

Call the following method with your desired configuration. init(<config>)

Config properties:

{
  clientId, // string; // The id of the application that asks for authorization.
  response_type, // string; // Tells the authorization server which grant to execute.
  scope, // string[]; // A list of permissions that the application requires.
  redirectUri, // string; // URI to return the user to after authorization is complete.
  locale, // string; // [optional] To force the display to a specific language (e.g.: en-AU)
  state, // string; // [optional] An opaque value, used for security purposes. If this request parameter is set in the request, then it is returned to the application as part of the redirect_uri.
  appToken, // string; // [optional] The Access Token granted through oauth
  isTestEnvironment // boolean; // [optional] If you wanna use the staging or production environemnt
}

Open the page for the user to authorize your application

mtLinkSdk.authorize(options); You can pass the following options:

• newTab: Open in a new browser tab
  • Values: true or false
  • Default: false
• authPage: Page to display during unauthenticated redirection
  • Values: 'login' or 'signup'.
  • Default: 'login'
• email: To prefill the email field for signup and login
  • Values: A string
  • Default: undefined
• backTo: Redirect URL for some actions (back, revoke, logout, delete)
  • Values: A string representing a URL
  • Default: Current URL
• showAuthToggle: Option to hide the button to toggle between login and signup pages
  • Values: false
  • Default: undefined

Open the setting page of the user account

mtLinkSdk.openSettings(options); You can pass the following options:

• newTab: Open in a new browser tab
  • Values: true or false
  • Default: false
• backTo: Redirect URL for some actions (back, revoke, logout, delete)
  • Values: A string representing a URL
  • Default: Current URL

Open the vault to let the user add credentials

mtLinkSdk.openVault(options); You can pass the following options:

• newTab: Open in a new browser tab
  • Values: true or false
  • Default: false
• backTo: Redirect URL for some actions (back, revoke, logout, delete)
  • Values: A string representing a URL
  • Default: Current URL