How to Issue a Plugin License and Add it to Your Account
Plugin Licenses are a feature of the Dev Portal that was created in order to give you more autonomy and control over the usage of your plugins by limiting who can use them and how often.
How To Create a Plugin License
Before you can add your plugin to an app or configuration, you will need to create a Plugin License for it. Here’s how:
Step 1: Log-in to the Developer Portal and go to the “License” tab
Once there click “Generate New License Key”.
Step 2: Select the plugin that you’d like to create a License Key for and the number of allowed installs
If you’d like to allow unlimited installs on this key, then check the “Unlimited Installs” box.
Step 3: Click “Generate” to create a License Key for that plugin
Once the key has been generated it will appear in a list on the “License” page along with any other license keys that you’ve generated.
Step 4: Copy the License Key
Once generated, you’ll want to copy the license key so that you can add it to a configuration or an app.
You can manage your plugin licenses under the Licenses tab in your dev portal, as well as view who has access to the license, revoke license keys, and change the number of installs allowed on that license.
Now let’s go over how to implement that plugin license. There are two ways to add a plugin license. You can add it to a configuration or you can add it to a single app. Let’s go over how to add it to a configuration first.
How To Add the Plugin License to a Configuration
Adding a plugin license to a configuration will give any app tied to that configuration access to that plugin. Here’s how to add your license key to a configuration:
Step 1: Log-in to your White Label Admin Control Panel and go to the “Plugin Licenses” tab
Once there click “Add New License”.
Step 2: Give the License a Name and Paste the License Key that was generated
Then click “Add”.
Step 3: Go to the “Configurations” tab and Select the Configuration that you want to add the Plugin to
Alternatively you can create a new configuration to add the plugin to by clicking on “Add New Configuration”.
Step 4: Scroll down to the “Plugin Licenses” section under “Add/Edit Configuration”
Check the box next to the plugin’s name to enable it for that configuration.
Step 5: Scroll to the bottom of the page and click “Save”
Once that’s done, every app tied to that configuration will now have access to that plugin which can be found in the Feature Marketplace in the App Dashboard. Next we’ll go over how to add a License Key to an individual app.
How To Add the Plugin License to a Single App
If you are on a single app subscription and you’d like to add the custom plugin that you’ve created in our developer portal, here’s how to add it to your app.
Note: in order to add your custom plugin to your app, the app will need to be on our Enterprise level plan.
Step 1: Go to the Feature Marketplace in the App Dashboard
Step 2: Click on “Install New Plugin”
Then paste the plugin license key and click “Install”.
In addition to this article, we recommend checking out the following related articles so that you have a better insight into how to use the system to its fullest advantage:
- BuildFire Plugin: Creating Your First Plugin
- How to Submit Your Plugin to the Marketplace
- How to Upload and Update a Plugin to Your Developer Portal
Still have questions? No problem! Reach out to us and we’d be happy to help :)