Introduction to Beefree SDK

Welcome to the Beefree SDK technical documentation!

What is Beefree SDK?

Beefree SDK is an embeddable no-code email, landing page, and popup builder. It enables your end users to achieve their design goals without writing a single line of code. By embedding Beefree SDK into your application, you'll provide your end users with access to a full suite of design features that include the following and more:

• Email builder: A no-code email creation environment that helps end users quickly create beautiful emails. This environment supports your end users in following email creation best practices recommended by industry experts.

• Page builder: A no-code landing page creation environment that empowers end users to build visually stunning landing pages. They can use a landing page as a link for a call-to-action (CTA) inside emails, to embed forms and capture information, or to create standalone pages.

• Popup builder: The popup builder is a no-code environment that provides end users with the tools they need to build compelling popups that capture attention.

• File manager: A tool to manage media assets (images, PDFs, and so on).

• Template catalog: A design template catalog that integrates industry best practices to support end users in quickly getting across the finish line with their creations and achieving quick design wins.

• AI Writing Assistant: A helpful AI assistant to help end users write their design content.

These builders can easily integrate into your application in minutes. Browse this documentation's latest sample code and implementation guides to get started.

Quick Start

Take the following steps to get started with Beefree SDK in a few minutes:

1. Create an account to access the Developer Console and obtain your credentials.

2. Create a new subscription to get started. Beefree SDK offers a generous Free plan that includes each builder type mentioned in the previous section.

3. Create an application and obtain your Client ID and Client Secret.

4. Clone the beefree-sdk-sample-client repository, which includes the code for email and popup builder implementations.

5. Add your credentials, the Client ID and Client Secret from step three, inside the placeholders in the code.

6. Once the email builder, or popup builder, depending on which environment you chose, opens, you can start experimenting with the SDK's configuration by customizing the configuration parameters in the beeConfig section of the code.

7. You can also customize the SDK's configuration inside the Developer Console under the Application configuration section of the application you created.

Note: Visit the Beefree SDK pricing page for a comprehensive list of features and the plan type they correspond to.

Beefree SDK's Embeddable Builders

Learn more about our three embeddable builders.

Email Builder: An email editor that makes building gorgeous, mobile-ready emails a breeze.

Page Builder: A delightful tool to design beautiful, effective landing pages in minutes, without writing a single line of code.

Popup Builder: An easy to deploy, true WYSIWYG solution for designing standout popups.

File Manager

In addition to our drag-and-drop editors, we also offer a standalone File Manager application, which can be used alongside any of the builders. The File Manager is specifically designed to simplify the organization and management of digital assets, which might happen outside of a content editing session. It is an image and document management user interface that can be launched as a standalone application. This allows your customers to quickly upload or manage assets, without having to load one of the builders.

Learn more about our File Manager and File Storage Options.

File Manager

Storage Options

Configure Your AWS S3 Bucket

Customize Your Application with AddOns

Learn more about how our builder AddOns can help you customize your application's offerings.

AI Writing Assistant with Multiple Provider Options

Partner AddOns

Custom AddOns

Content Services API and Template Catalog API

The Content Services API allows you to perform a number of tasks (e.g. refreshing the HTML for a certain asset) and add features to your application (e.g. converting an email to a PDF document). We continue to release new API methods to help you enrich and personalize the content design experience for your customers.

The Template Catalog API enables you to incorporate design templates into your application. With this API, you can browse, retrieve, and utilize a variety of pre-designed templates to enhance your user's content creation experience. It gives you the flexibility to offer customized design solutions directly within your platform.

Learn more about Content Services API and Template Catalog API.

Content Services: Export plain text, transform JSON to HTML, and manage brand styles.

Template Catalog: Add templates to your application.

AI Collection: Use the AI collection to get metadata, SMS, and summary text.

Sample Code

Browse our sample code to experiment and gain hands-on experience. Get up and running quickly with a simple implementation.

Full-stack application built with NextJS

Official NPM package of Beefree SDK

A simple HTML sample client to start playing with Beefree SDK

Beefree SDK simple React starter

Templates to accelerate the set-up of your Beefree SDK integration.

Explore methods

Developer Essentials

Get your free Client ID and Client Secret in the Developer Console to get started. Experiment with customizing a configuration in the playground. When you're ready, install Beefree SDK.

Developer Console

Playground

Install Beefree SDK

Configuration Parameters

Create an Application

Authorization Process

About this documentation

These products share the same, unique combination of design flexibility and ease of use. Note that the majority of the documentation applies to all builders (and in many cases to the File Manger too), unless otherwise specified.

If you need support at any point throughout your integration, contact us. We are here to support you along the way.