πΒ Welcome
Getting Started
Sign Up & Add Games
SDK Setup & Updates
Sharing & Permissions
Products
Popmall (Catalog)
Data Store Editor
Custom Events
Analytics
Product Optimization
Popfeed
Brand Collab
Ads
Ad Control
Support
Questions or Feedback
Metric Definitions
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.
- First make sure to sign up and register your game.
- Download the Bloxbiz Plugin (made by @simplelobster1).
- Open studio, navigate to the Bloxbiz Plugin, and click on "Settings"
- Enter your API key and press "Apply." You can find your API Key in the Dev Portal > Account > SDK Details.
- 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
- 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.
- 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.
- You should see the BloxbizSDK in your game's ServeScriptService in the Explorer Note: Do not modify anything within BloxbizSDK.
- Make sure to enable HTTP requests. Go to Game Settings > Security and turn on
Allow HTTP Requests
.
3. Configure the BloxbizConfig
- In your Explorer, add a ModuleScript to Replicated Storage and name it "BloxbizConfig"
- Open "BloxbizConfig" and delete any code in the file
- Copy and paste the below code snippet into "BloxbizConfig":
- Replace where it says
Account ID
with your Bloxbiz Account ID
local BloxbizConfig = {}
BloxbizConfig.AccountID = Account ID
return BloxbizConfig
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:
- Open Roblox Studio, and use the Toolbar to navigate to your Plugins.
- 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.
- Press "Add/Update SDK" to get the latest version of the BloxbizSDK.