@meshconnect/web-link-sdk

A client-side JS library for integrating with Mesh Connect

Install

With npm:

npm install --save @meshconnect/web-link-sdk

With yarn

yarn add @meshconnect/web-link-sdk

Getting Link token

Link token should be obtained from the GET /api/v1/linktoken endpoint. Api reference for this request is available here. Request must be preformed from the server side because it requires the client secret. You will get the response in the following format:

{
  "content": {
    "linkToken": "{linktoken}"
  },
  "status": "ok",
  "message": ""
}

You can use linkToken value from this response to open the popup window with openLink method.

Generating connection method

import { createLink } from '@meshconnect/web-link-sdk';

// ...

const linkConnection = createLink({
  onIntegrationConnected: (data: LinkPayload) => {
    // use broker account data
  },
  onExit: (error?: string) => {
    if (error) {
      // handle error
    } else {
      // ...
    }
  }

Using connection to open auth link

To open authentication link provided by Front Finance Integration API you need to call openLink method:

linkConnection.openLink(linkToken)

ℹ️ See full source code example at react-example/src/ui/Link.tsx

import { createLink, Link, LinkPayload } from '@meshconnect/web-link-sdk'

// ...

const [linkConnection, setLinkConnection] = useState<Link | null>(null)

useEffect(() => {
  setLinkConnection(createLink(options))
}, [])

useEffect(() => {
  if (authLink) {
    linkConnection?.openLink(linkToken)
  }
}, [linkConnection, authLink])

return <></>

Getting tokens

After successfull authentication on the Link session, the popup will be closed and the broker tokens will be passed to the onIntegrationConnected function. Link instance will check if URL contains query parameters, load broker tokens and fire the events.

Available Connection configuration options

ℹ️ See src/types/index.ts for exported types.

createLink arguments

| key | type | description | | ------------------------ | ------------------------------------------------------ | ------------------------------------------------------------------------------------ | | onIntegrationConnected | (payload: LinkPayload) => void | Callback called when users connects their accounts | | onExit | ((error?: string \| undefined) => void) \| undefined | Called if connection not happened | | onTransferFinished | (payload: TransferFinishedPayload) => void | Callback called when a crypto transfer is executed | | onEvent | (payload: LinkEventType) => void | A callback function that is called when various events occur within the Front iframe | | accessTokens | IntegrationAccessToken[] | An array of integration access tokens | | language | 'en' \| undefined | Link UI language | | displayFiatCurrency | 'USD' \| undefined | A fiat currency to display fiat equivalent of a crypto amount | | theme | 'dark' \| 'light' \| 'system' \| undefined | Color theme of Link UI interface | | renderType | 'overlay' \| 'embedded' \| undefined | 'overlay' (default) renders a full-screen popup; 'embedded' renders inside a client-supplied iframe (requires customIframeId in openLink) |

createLink return value

| key | type | description | | -------------------- | ----------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | | openLink | (linkToken: string, customIframeId?: string) => void | Opens the Link UI popup. Optionally targets an existing iframe by ID instead of creating a new popup | | closeLink | () => void | Closes the Link UI popup immediately | | closeLinkRequested | () => void | Requests graceful close in embedded mode (sends closeRequested to iframe); closes immediately otherwise |

Using tokens

You can use broker tokens to perform requests to get current balance, assets and execute transactions. Full API reference can be found here.

Typescript support

TypeScript definitions for @meshconnect/web-link-sdk are built into the npm package.

Exported types

| type | description | | ------------------------- | --------------------------------------------------------------------------------------------- | | LinkPayload | Payload passed to onIntegrationConnected | | AccessTokenPayload | Broker access token details within LinkPayload | | DelayedAuthPayload | Delayed auth details within LinkPayload | | IntegrationAccessToken | Access token shape used in the accessTokens option | | TransferFinishedPayload | Payload passed to onTransferFinished | | BrokerType | Union of supported broker/integration type strings (re-exported from @meshconnect/node-api) | | LinkOptions | Full options object passed to createLink | | Link | Return type of createLink | | AccountToken | Account token within AccessTokenPayload | | Account | Account details within AccountToken | | BrandInfo | Integration brand/logo info |