Terminal Link SDK

This package provides a simple way to embed the Terminal Link onboarding flow into your application.

Installation

Install with NPM

npm install @terminal-api/link-sdk

Install with Script Tag

<script src="https://cdn.withterminal.com/js/link-sdk.min.js"></script>

Will be available as TerminalLink on the global scope.

Usage

// import if using package or will be globally available if installed via script tag
import { TerminalLink } from '@terminal-api/link-sdk';

async function exchangePublicToken(publicToken) {
  // provide the public token to your backend to exchange for a Terminal connection token
  // store the Terminal connection token in your database to use for future Terminal API requests
  const response = await fetch('/api/create-terminal-connection', {
    method: 'POST',
    body: JSON.stringify({
      publicToken
    })
  });

  return response.json();
}

const link = TerminalLink.initialize({
  // production or sandbox publishable key from the Terminal dashboard
  publishableKey: process.env.TERMINAL_PUBLISHABLE_KEY,
  onSuccess: (result) => exchangePublicToken(result.publicToken)
  params: {
    // optional parameters to pass to the link
    // see https://docs.withterminal.com/link-component for more details
    externalId: '1234'
  }
});

// open the link
link.open();

// close the link
link.close();

// can optionally override parameters in the open method
link.open({ params: { externalId: '1234' } });

Documentation

Can reference the Terminal Link documentation section for more details on how to use the SDK.