Getting started with Boxo as a miniapp is simple and can be broken down into three key steps:

  1. Optimize your web application for mobile
    Ensure that your web application is responsive and provides a seamless experience on mobile devices.

  2. Install the JS SDK
    Integrate the Boxo JS SDK into your miniapp to enable smooth interaction with the Boxo platform.

  3. Register your miniapp for approval
    Submit your miniapp for review and approval to ensure it meets Boxo’s guidelines before being made available to users.

​
JS SDK

Install the Boxo JS SDK package with:

npm install @appboxo/js-sdk --save
# or
yarn add @appboxo/js-sdk

​
Usage

TIP If you would like to develop a miniapp from scratch, we recommend building it using a modern JavaScript frameworks such as React.js, Angular, Vue etc. as they provide the best optimization tools to make web applications perform faster. 
import appboxo from '@appboxo/js-sdk';

// Sends init event to host client
appboxo.send('AppBoxoWebAppInit');

// Subscribes to event, sent by host client
appboxo.subscribe(e => console.log(e));
TIP If you already have a lightweight mobile adaptive web app, you can easily install the Boxo JS SDK and start using its features.

For use in a browser, include the file /dist/index.umd.js and use it as follows:

<script src="dist/index.umd.js"></script>

<script>
  // Sends init event to host client
  appboxo.send('AppBoxoWebAppInit');
</script>
TIP See [Boxo JS SDK API](/MiniApp API Reference/EventsAPI#sendpromise-method-params) for the full list of API

or use unpkg.com if your want it from CDN:

<script src="https://unpkg.com/@appboxo/js-sdk"></script>

​
Adding a miniapp to Boxo

​
Add a miniapp

  1. Sign in to the Boxo Dashboard.

  2. Click on the “Add miniapp” button located at the bottom of the screen. Alternatively, navigate to the “My miniapps” page and find the “Add miniapp” button at the footer.

​
Miniapp name

  1. Enter your miniapp name.

  2. If you have an existing website or mobile app, use the existing name so that users can identify the existing products and services.

​
Category

  1. Select the appropriate category from the dropdown menu. (Please ensure you choose the correct category!)

  2. If you cannot find a suitable category for your business, please reach out via email to support@boxo.io.

​
Description

Make sure your description is informative and detailed. Remember to include all your financial terms for potential partners. The description is an important aspect as it is a good way for new potential partners to learn about your business before deciding to integrate.

​
Add app to Boxo Showroom

If you are not ready to make your published miniapp public on the showroom, simply turn off the toggle for Add app to Boxo showroom.

​
URL

Enter the URL of your miniapp. All the miniapps should be hosted by the miniapp owner.

​
Miniapp icon

A miniapp icon is a small logo that represents your business and appears during the launch of your miniapp. Ensure that the icon is in PNG format for optimal display.