qonto-embed-sdk

Use Qonto Embed in your website with a high level abstraction that will make your integration easy and fast.

Getting started

1. Install the SDK with your package manager of choice:

npm install @qonto/embed-sdk

or

pnpm install @qonto/embed-sdk

or

yarn add @qonto/embed-sdk

2. Then, initialize the SDK in your code:

import { initialize } from '@qonto/embed-sdk/common';

const accessToken =
  'An access token you have previously generated from your app';
initialize({ accessToken });

Read more about how your users are onboarded and an access token is generated for them in the docs.

3. From that moment on, you can access the different namespaces of the SDK:

import { cards } from '@qonto/embed-sdk/cards';

const newCard = cards.orderCard(cardConfig);

API stability

We are in the early stages of the SDK implementation. While we will strongly attempt to avoid breaking changes, we may need to make some in the future. Note that while the SDK is in the v0.x stage, breaking changes might happen. Once we reach v1.0.0, we will follow semantic versioning strictly.

Programmatic features

This SDK exposes a set of programmatic features that you can use to interact with Qonto services. These features are grouped into namespaces under src (cards, sepa-transfers, beneficiaries...) and they mainly export functions that can be called by SDK users. Most of those functions are wrappers around Qonto's third party REST API, but some have more complex logic, like opening iframes to perform sensitive actions.

UI Elements

The SDK exposes a set of UI Elements that can be embedded in partners' web applications. These elements are standard Web Components that can be used in any front-end framework or vanilla JavaScript app. The implementation is done using Lit, and the components are available under the ui namespace under src.

Next steps

Now that you have the SDK installed and initialized, you can start using it. Check the documentation for each namespace to get up to speed with the different features available.