☄️Integrate - No/Low Code

Kiln Widget enables the activate of earn feature without requiring extensive technical resources. Whether you have a dedicated development team or not, you can integrate Kiln Widget with ease.

Prerequisites

• You need a dashboard organization, if it's not already the case, ask kiln team so that we can onboard you.

• You need access to a Kiln Connect API key, if it's not already the case, ask kiln team so that we can onboard you. You can generate one yourself, click here to read more.

• Have some deployed products on mainnet, if it's not already the case, kiln can provide test product for your testing and trial integration.

• Optional : have customize your widget, you can directly upload your configuration via API and soon in Kiln dashboard directly

Configure your Widget

Configure the widget look and feel

You can export the configuration from the editor, the you just have to past this json in the API widget config endpoint to edit the widget to your configuration.

Endpoint: PUT /v1/widget/config

Request Body:

{
    "theme": "light", // Values: light, dark, desktop (take the broswer default) 
    "logo_url": null; // null for no logo, paste url for logo
    "rounding": "8", // use editor value 
    "widget_style": "flat+border", // use editor value 
    "card_padding": "16", // use editor value 
    "widget_width": "compact", // use editor value 
    "navigation": "segment", // use editor value 
    "font_primary": "Geist", // use editor value 
    "font_secondary": "IBM Plex Sans", // use editor value 
    "show_icons": true, // show hide icons in navigation
    "show_wallet": true, // show hide wallet selector
    "multi_chain": true, // force the wallet to only display reporting and product to only one chain
    "css_variables": {
        "--Color-Brand-Light-Primary": "rgba(255,101,33,1.00)",
        "--Color-Brand-Light-Secondary": "rgba(255,101,33,1.00)",
        "--Color-Brand-Light-Secondary-10\\%": "rgba(255,101,33,0.10)",
        "--Color-Brand-Dark-Primary": "rgba(255,101,33,1.00)",
        "--Color-Brand-Dark-Secondary": "rgba(255,101,33,1.00)",
        "--Color-Brand-Dark-Secondary-10\\%": "rgba(255,101,33,0.10)",
        "--Color-Surface-Light-Transparent": "rgba(0,0,0,0.00)",
        "--Color-Surface-Light-World": "rgba(240,240,240,1.00)",
        "--Color-Surface-Light-Primary": "rgba(255,255,255,1.00)",
        "--Color-Surface-Light-Underlay": "rgba(240,240,240,1.00)",
        "--Color-Surface-Light-Input": "rgba(255,255,255,1.00)",
        "--Color-Surface-Dark-Transparent": "rgba(0,0,0,0.00)",
        "--Color-Surface-Dark-World": "rgba(17,17,17,1.00)",
        "--Color-Surface-Dark-Primary": "rgba(21,21,21,1.00)",
        "--Color-Surface-Dark-Underlay": "rgba(32,32,32,1.00)",
        "--Color-Surface-Dark-Input": "rgba(51,51,51,1.00)",
        "--Color-Border-Light-Primary": "rgba(217,217,217,1.00)",
        "--Color-Border-Light-Secondary": "rgba(217,217,217,1.00)",
        "--Color-Border-Light-Input": "rgba(0,0,0,1.00)",
        "--Color-Border-Light-Divider": "rgba(229,229,229,1.00)",
        "--Color-Text-Light-Primary": "rgba(0,0,0,1.00)",
        "--Color-Button-Light-Primary": "var(--Color-Brand-Light-Primary)",
        "--Color-Button-Light-Primary-Text": "rgba(255,255,255,1.00)",
        "--Color-Button-Light-Secondary": "rgba(255,255,255,1.00)",
        "--Color-Button-Light-Tertiary": "rgba(255,255,255,1.00)",
        "--Color-Text-Light-Secondary": "rgba(85,85,85,1.00)",
        "--Color-Text-Light-Tertiary": "rgba(136,136,136,1.00)",
        "--Color-Text-Light-Additional": "rgba(170,170,170,1.00)",
        "--Color-Text-Light-Positive": "rgba(87,176,31,1.00)",
        "--Color-Text-Light-Negative": "rgba(252,36,36,1.00)",
        "--Radius-0": "0px",
        "--Radius-4": "4px",
        "--Radius-8": "8px",
        "--Radius-12": "12px",
        "--Radius-16": "16px",
        "--Radius-20": "20px",
        "--Radius-24": "24px",
        "--Radius-28": "28px",
        "--Radius-32": "32px",
        "--Radius-100\\%": "999%",
        "--logo": "kiln",
        "--Color-Border-Dark-Primary": "rgba(51,51,51,1.00)",
        "--Color-Border-Dark-Secondary": "rgba(51,51,51,1.00)",
        "--Color-Border-Dark-Input": "rgba(68,68,68,1.00)",
        "--Color-Border-Dark-Divider": "rgba(41,41,41,1.00)",
        "--Color-Text-Dark-Primary": "rgba(255,255,255,1.00)",
        "--Color-Text-Dark-Secondary": "rgba(169,169,169,1.00)",
        "--Color-Text-Dark-Tertiary": "rgba(136,136,136,1.00)",
        "--Color-Text-Dark-Additional": "rgba(255,255,255,1.00)",
        "--Color-Text-Dark-Positive": "rgba(87,176,31,1.00)",
        "--Color-Text-Dark-Negative": "rgba(255,61,61,1.00)",
        "--Color-Button-Dark-Primary": "var(--Color-Brand-Light-Primary)",
        "--Color-Button-Dark-Primary-Text": "rgba(255,255,255,1.00)",
        "--Color-Button-Dark-Secondary": "rgba(51,51,51,1.00)",
        "--Color-Button-Dark-Tertiary": "rgba(21,21,21,1.00)"
    }
}

Advanced configuration

Advanced parameters can be used to further customize your widget integration:

• slug:

  Defining a custom sub-domain for your widget : slug.widget.kiln.fi By default the slug is your organization-id, something like: d6309182-cbad-11ec-9d64-0242ac120002

• frame_ancestor_urls: By specifying the frame_ancestor_urls, you're explicitly allowing only your domain to embed Kiln Widget, enhancing security of your integration.

• connector: By default it's set to browser enabling the user to connect a wallet extension. If on your platform user can't use a browser extension to connect to the Widget, Kiln will need to build a custom connector, a great example of similar setups are with Safe or Ledger Live.

• links: By default it's set to null to display the default kiln T&Cs and privacy policy. You can pass custom links here as presented in the example bellow.

Endpoint: PUT /v1/widget/config

Request Body:

{
    "frame_ancestor_urls": [
        "my-custom-domain.com"
    ],
    "connector": "custom-connector", // Contact our team if you need a custom connector
    "slug": "super-custom", // url will be super-custom.widget.kiln.fi
    "links": [
        {
            "text": "FAQ",
            "url": "https://www.faq.com"
        },
        {
            "text": "Support",
            "url": "https://www.support.kiln.fi"
        }
    ]
}

Integrate your Widget

To integrate kiln widget in your platform, you just need to embed you widget URL in an iFrame, it can work on any tech stack and even in no-code tools.

React code sample demonstrating how to embed "kiln.widget.kiln.fi" in an iframe

const KilnWidget = () => {
  return (
      <iframe
        src="https://kiln.widget.kiln.fi"
        title="Kiln Widget"
        allow="clipboard-write"
        style={{ width:"100vw", height:"100vh"}}
      />
  );
};

export default KilnWidget;

This code creates a React component called KilnWidget that embeds the "kiln.widget.kiln.fi" widget in an iframe.

Deeplinks

Kiln provides a deeplink mechanism that allows seamless redirection into the different pages between overview, deposit and withdraw.

To enhance your platform's capabilities, consider integrating specific features of the Kiln Widget. For instance, if you already have an existing native earn section, you can redirect users to the Kiln Widget for deposit transactions. After a transaction is signed, seamlessly bring the user back to your platform.

Your widget base url

Access your widget using the configured slug , this will automatically pull your configuration including theme and available earn products. In this document we refer to this as "base url" or "your widget".

Structure: https://slug.widget.kiln.fi/

Example: https://iframe.widget.testnet.kiln.fi/ , a Kiln managed configuration for testing the widget in an iframe.

Portfolio / Reporting

By default if you redirect the user to "your widget" the overview page, it's will show all the user active and potential position based on the products you enabled in your widget.

To redirect the user to this page you need to add the /overview after your base URL.

Structure: https://slug.widget.kiln.fi/overview

Deposit

If you want to open the widget direct on the deposit flow, you will need to add /earn after your base URL.

Structure: https://slug.widget.kiln.fi/earn

On this page, you can use the following path params to further customize the deposit flow.

Here’s the improved Kiln Widget Deeplink Integration Guide with a clearer query parameters table, better type definitions, select options, detailed descriptions, and examples.

Parameter	Allowed Values	Description	Example
select_deployment	"disabled" or unspecified	Controls whether users can select a deployment. If "disabled", the deployment selection is locked.	select_deployment=disabled
select_asset	"disabled" or unspecified	Controls whether users can select an asset. If "disabled", the asset selection is locked.	select_asset=disabled
deployment_id	Valid deployment ID in the format <chainId>_<vaultAddress>	Predefines the deployment to use.	deployment_id=1_0xabc123456789...
asset_id	Valid asset ID in the format <chainId>_<assetAddress>	Predefines the asset to deposit.	asset_id=1_0xdef456789abc...
callback_title	Any string	The text displayed on the return button after deposit.	callback_title=Back+to+Dashboard
callback_url	Valid HTTPS URL	The URL where the user is redirected after deposit completion.	callback_url=https://yourapp.com/dashboard

---

Example Deeplinks

1. Allow full Selection

Users can freely choose deployment and asset:

https://iframe.widget.testnet.kiln.fi/earn

2. Predefine deployment and asset

Locking a specific deployment and asset:

https://iframe.widget.testnet.kiln.fi/earn?deployment_id=8453_0x390D077f8E60ffb58805420edc635670AA4f34C3&asset_id=8453_0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913

3. Disable deployment and asset selection

Prevent users from changing the predefined values:

https://iframe.widget.testnet.kiln.fi/earn?select_deployment=disabled&select_asset=disabled

4. Redirect users after deposit

Automatically send users back to your app after completing the deposit:

https://slug.widget.kiln.fi/earn?deployment_id=1_0xabc123...&asset_id=1_0xdef456...&callback_title=Back+to+App&callback_url=https://yourapp.com/dashboard

Withdraw

If you want to open the widget direct on the deposit flow, you will need to add /withdraw after your base URL.

Structure: https://slug.widget.kiln.fi/withdraw