YouLend Embedded Components SDK

A TypeScript/JavaScript SDK for embedding YouLend's application journey into your web application.

How It Works

This NPM package provides TypeScript support and dynamically loads the YlEmbed.js script from YouLend's CDN.

If you prefer, you can also load the SDK script directly from our CDN via a script tag. The script is hosted at https://sdk.youlend.com/v1/ylembed.js.

Quick Start

For more detailed examples and docs, visit the embedded components docs.

import { loadYlEmbed, YlEmbedOptions, ApplicationJourney } from 'ylembed-js';

const options: YlEmbedOptions = {
  partnerName: 'your-partner-name',
  country: 'GB', // 'US' | 'GB' | 'DE' | 'FR' | 'PL' | 'NL' | 'BE' | 'ES' | 'IE'
  environment: 'sandbox', // 'production' | 'sandbox'
  thirdPartyCustomerId: 'your-unique-id-for-the-logged-in-user',
  createEmbedToken: async () => { // Create embed token for the logged in merchant
    const response = await fetch('/yourapi/yl-embed-token', { method: 'POST' });
    const { accessToken } = await response.json();
    return accessToken;
  }
};

const ylEmbed = await loadYlEmbed(options);
const journey: ApplicationJourney = ylEmbed.create('ApplicationJourney');
journey.open();

Available Types: YlEmbedOptions, ApplicationJourneyOptions, ApplicationJourney, YlEmbed

Versioning

Each major version of the NPM package loads a specific version of the CDN-hosted script. For example, NPM package version 1.x.y loads https://sdk.youlend.com/v1/ylembed.js.

Because all minor and patch updates (e.g., 1.0.0 → 1.2.5) use the same CDN script version, you can safely bump versions to get wrapper or TypeScript improvements without any breaking changes to the embed experience.

Content Security Policy

If you implement a CSP, please ensure you allow the following:

• Scripts (script-src) from https://sdk.youlend.com
• Iframes (frame-src):
  • Production: https://youlend.com (and/or https://youlend.us if supporting USA)
  • Sandbox: https://partners.staging-youlend.com (and/or https://uspartners.staging-youlend.com if supporting USA)

Documentation

📖 Full Documentation 🔧 API Reference

License

ISC © YouLend