👋 Welcome

Getting Started

Sign Up & Add Games

SDK Setup & Updates

Sharing & Permissions

Popmall (Catalog)

Analytics

SDK Changelog

Set up the SDK

The Bloxbiz SDK takes only a few minutes to set up and enables products like the Catalog, Analytics, and more.

1. Install the Bloxbiz Plugin and Setup Your API Key

The Bloxbiz Plugin makes easy to install and update the SDK.

  1. First make sure to sign up and register your game.

  2. Download the Bloxbiz Plugin (made by @simplelobster1).

  3. Open studio, navigate to the Bloxbiz Plugin, and click on "Settings"

    Screen Shot 2022-06-01 at 11.03.54 AM Copy.jpg

  4. Enter your API key and press "Apply." You can find your API Key in the Dev Portal > Account > SDK Details.

    https://s3-us-west-2.amazonaws.com/secure.notion-static.com/7d5d43ef-86a2-4001-82a4-9afd99f9bee0/Screen_Shot_2021-06-22_at_11.16.35_AM.png

  5. Press "Allow" to give the Bloxbiz Plugin permission to use the Bloxbiz API (you only need to do this once)

2. Add the Bloxbiz SDK

  1. In your plugin toolbar, click on "Add/Update SDK" to add the BloxbizSDK to your game. Note: if the "Add/Update SDK" button shows a refresh icon, that means there is an update to the BloxbizSDK or you do not have the BloxbizSDK added to your game.

    Screen Shot 2022-06-01 at 11.03.46 AM Copy.jpg

  2. You'll need to turn on Script Injection for the Bloxbiz Plugin in the Plugin Manager. Note: Bloxbiz only uses Script Injection to add/update the BloxbizSDK.

  3. You should see the BloxbizSDK in your game's ServeScriptService in the Explorer Note: Do not modify anything within BloxbizSDK.

    https://s3-us-west-2.amazonaws.com/secure.notion-static.com/13959872-57b0-4628-9a80-7fef2f78829f/Screen_Shot_2021-06-22_at_11.20.46_AM.png

  4. Make sure to enable HTTP requests. Go to Game Settings > Security and turn on Allow HTTP Requests.

3. Configure the BloxbizConfig

  1. In your Explorer, add a ModuleScript to Replicated Storage and name it "BloxbizConfig"

  2. Open "BloxbizConfig" and delete any code in the file

  3. Copy and paste the below code snippet into "BloxbizConfig":

    local BloxbizConfig = {}

BloxbizConfig.AccountID = Account ID

return BloxbizConfig

  4. Replace where it says Account ID with your Bloxbiz Account ID

4. Publish Your Game

After you configure your BloxbizConfig, you’re finished getting setup. Congrats! 🎉

You’ll automatically start to see analytics in the Dev Portal within 24 hours (reports are generated every night at 1am EST) and you’re ready to explore other Super Biz products.

Update the Bloxbiz SDK

We make regular improvements to the Bloxbiz SDK. To keep your SDK up-to-date with the latest improvements, make sure to check for updates:

  1. Open Roblox Studio, and use the Toolbar to navigate to your Plugins.

  2. First update your Bloxbiz Plugin and then see if the Bloxbiz Plugin is displaying a refresh icon, that means there is a new version available for the BloxbizSDK.

    Screen Shot 2022-06-01 at 11.03.46 AM Copy.jpg

  3. Press "Add/Update SDK" to get the latest version of the BloxbizSDK.

Next Step

<aside> ➡️ Continue to Sharing & Permissions

</aside>