Embeddables

Embeddables is a JavaScript (TypeScript supported) library which allows for easy integration to our PayBucky-services. It comes with completed views that are easily inserted into any web-project, as well as methods to easily call our API from your frontend for custom views.

Embeddables is a frontend library designed to seamlessly integrate PayBucky-services into your web projects. Built with both JavaScript and TypeScript support—it offers a collection of fully completed views and components that are ready to be embedded into your application with minimal setup. The library abstracts away the complexities of embedding iframes and managing their lifecycle, allowing you to focus on delivering a polished user experience.

Key Features

  • Ready-to-Use Components: Quickly integrate pre-built views that cover a range of PayBucky-services, from payment processing to account management.

  • Ease-of-Integration: Designed for simplicity, Embeddables handles the setup and management of embedded iframes automatically, ensuring that you can plug in services without hassle.

  • Flexible Integration Methods: Whether you’re building a modern single-page application with a module bundler or a straightforward static HTML project, Embeddables supports both npm installation and direct inclusion via a script tag.

  • TypeScript Support: Enjoy strong typing and better developer experience with TypeScript, making your integrations more robust and easier to maintain.

  • Optimized for Performance and Security: By managing embedded components internally, the library reduces your overhead while ensuring that communication with PayBucky-services remains secure, efficient and up-to-date.

Why Use Embeddables?

Embeddables is built with developer experience in mind. Its simple API and intuitive design allow you to add sophisticated, dynamic components to your website in just a few steps. The library is especially useful for projects that require secure and reliable integrations with our financial or account management services.

How It Works

Embeddables makes it simple to bring powerful, interactive features to your website without worrying about the technical details. Here’s an overview of the process:

  • Secure Connection: To protect your data, the component uses a secure token from our server, fetched by your backend, defining which tenant/tenants this token applies to. Using this token in the Embeddable on the frontend makes it possible for our services to confirm that the right content is shown to the right users, keeping everything safe and secure.

  • Easy Integration: You choose a spot on your webpage where you want the component to appear—like a designated box or section. Embeddables will take care of placing and displaying the interactive content right there.

  • Customizable Experience: Whether you need to show account details, payments, or other services, you can customize what your visitors see by choosing a specific route, or by delivering a list of routes for a custom navbar to appear.

  • Automatic Adjustments: Once embedded, the component can automatically adjust its size and settings based on your page’s design. It can even update its behavior on the fly—like changing the layout or adding navigation—so it always fits perfectly with your site.

  • Rich event listeners: Embeddables features a robust event listener system that lets you react to key moments throughout the component’s lifecycle. Whether the component is mounted, updated, or experiences significant state changes—such as route transitions, processing refunds, or account creation—you can trigger custom functionality effortlessly, keeping your app fully synchronized and responsive.

In essence, Embeddables handles the heavy lifting behind the scenes. You simply plug it into your website, configure a few options, and let it deliver a seamless, interactive experience powered by our PayBucky-services in just a few lines.