Creating API credential for Connector plugin
Asura’s API System takes your licensing-system to a whole new level with its advanced capabilities in terms of security and extensions. API System is allowing and making it possible for 3rd party plugin to interact with the Asura plugin.
The Connector plugin is one of an implementation of the Asura’s API.
The API credential is needed with proper permission and route configuration to allow the Connector plugin to communicate with the Asura plugin.
This documentation will walk you through creating an API credential for the Connector plugin.
Creating API credential
Navigate to the Asura menu on the sidebar of your WordPress admin dashboard
Go to the “APIs” page on your dashboard sidebar. Click the Add New button. A new form will show up, and please fill in all required fields.
Label: fill the label field with anything that describes the API credential usage or purpose and easily distinguished it from another API credential. E.g., you can fill it with “For my awesome Customers.”
User: assign the owner of the API credential. The potential function of this feature is not available at the moment. You can set it to your admin (primary) account or your secondary account for best practice. Type the email, and the list of users will show.
Status: to allow API credentials to access and communicated with the Asura plugin, you need to Enabled it.
Override settings: The potential function of this feature is not available at the moment. You can leave the default value “Custom.”
Routes permissions: to allow the Connector plugin to access some function and restrict the other function from the Asura plugin, you need to set a proper routes permission; giving more permission means the API credential has more control over your Asura plugin. The explanation of each route permission available on a separate Document. Here the route permission you need for the Connector plugin:
✅ licenses → domains → register
✅ licenses → domains → deregister
✅ licenses → terms → index
✅ oxygenbuilder → items
✅ oxygenbuilder → componentclases
✅ oxygenbuilder → pageclasses
and click the Save button.
NB: If you want to allow the Install Wizard feature, you may tick all Routes permissions prefixed with oxygenbuilder →
Congraluation, the new API Credentials were created successfully. Click the 📋 icon on the Key column. The Connector String will be copied to your clipboard.
You can save the Connector String for later use, or attach it to your Easy Digital Downloads / WooCommerce Product’s “Purchase note” and even to the email receipt, so your customer can access their purchased design sets using the API credential we just made in this documentation.
Learn by watching a brand new screencast on YouTube!
