Users can interact with API/bots in two ways:

  1. Send messages and commands to API/bots through a direct chat, by adding them to groups/channels, or associate them to your nandbox Apps. This is useful for example in automated chat bots, news bots, and/or integrating your nandbox's App to your backend systems.

  2. Send requests directly from the input field by typing the bot's @handle and a query. This allows sending content from inline API/bots directly into any chat, group or channel within nandbox Apps.

Messages, commands and requests sent by users are passed to the software running on your servers where API/Bot is hosted. Our intermediary server handles all encryption and communication with the nandbox API/Bot for you. You communicate with this server via a WebSocket interface that offers a simplified version of the nandbox API/Bot.

How do I create an API access or bot?

Creating API access or bot within nandbox is easy. In few steps, you can configure and publish your new bots using an interactive menu.

Create API/Bot within your nandbox App

Login to your administrative portal of your nandbox App. Go to Bot Manager section and follow the instruction to create your first API/Bot as illustrated in the following screen.

createnewbotcreatenewbot botinfobotinfo

There are some API/Bot are already implemented by third party vendors offered in the Bot marketplace, where you can add them to your nandbox App and determine their access level to the information within your App.

botsmarketplacebotsmarketplace

Create API/Bot within your nandbox App

Login to your administrative portal of your nandbox App. Go to the Bot Manager section and follow the instruction to create your first API/Bot as illustrated in the following screen.

There are some API/Bot are already implemented by third-party vendors offered in the Bot marketplace, where you can add them to your nandbox App and determine their access level to the information within your App.

Creating a MailChimp bot

From the admin menu, click API and Integrations

Click on create new bot.

Select the MailChimp bot and click insert.

Hover over the bot and click the edit button.

Scroll down, and make sure that you toggle on these two privileges.

Next, click Chat with this Bot.

Type /help in the chatbox.

You will receive the following message:

To activate MailChimp bot, type /activate apikey audienceId

The API Key and Audience ID will be obtained from your MailChimp account through the following steps:

1.) Log in to your MailChimp account.

2.) From the side menu, click Audience.

3.) Then click All Contacts.

4.) From the settings menu, click Audience name and defaults.

5.) Copy the audience ID.

On the bottom left of the screen, click on your account.

Then click Account.

Click Extras, and then API keys.

Under Your API keys, you will find your API key.

Now go back to nandbox app builder and enter your API key and audience ID and click Send.

Congrats! You have now successfully activated the MailChimp bot!

Create API/Bot within nandbox Messenger

Use nandbox Android App version 2.1.0 or later.
From Settings menu open "Bot Manager".

settingssettings

Tap "+" to create a new bot.

createbotcreatebot

Enter your Bot title (Limited to 32 characters).

namebotnamebot
  1. Choose your bot type

Choose "Business", if your bot is associated or will be for use by organization, or business.

Choose "Individual" if bot will be for use by individual.

namebotnamebot

Enter Bot Description: a short text of up to 120 characters, describing your bot. Users will see this text on the bot's profile page and when they share your bot with someone, this text is sent together with the link.

When they are about to join your bot.

Update your Bot Image

Enter "About" section:
a short text of up to 512 characters, describing your bot. Users will see this text at the beginning of the conversation with the bot.

Give your bot a unique handle by providing your business email.

botsettingsbotsettings
  1. Unlike others, we protect your business name from being reserved by others bots. Your bot unique handle will be matching your web domain name. For example, if your business domain name is XYZ.com your bot handle will be "xyz".

After you reserve and book your bot handle, you can configure the following options:

  1. Inline: toggle inline mode for your bot.

  2. Private: Private Bot will not appear in Bot index search. Admin must send the Bot link to the user to invite him/her to join the bot.

  3. Filter: select which messages your bot will receive when added to a group. Choose from "none", "when mentioned", "posts" or "All".

botsettings2botsettings2