Creating API credential for Remote Access
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 remote access is one of an implementation of the Asura’s API. You can manage multiple installed asura plugins on different sites from a single dashboard.
The API credential is needed with proper permission and route configuration to allow the remote access to work properly.
This documentation will walk you through creating an API credential for remote access.
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 “The magical gate for my central dashboard.”
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 remote access to control your Asura plugin, you need to set a proper routes permission; giving less or more permission means the API credential has more control over your Asura plugin or some function not accessible. The explanation of each route permission available on a separate Document. Here the route permission you need for the remote access (general use case and full potential):
✅ licenses → index
✅ licenses → store
✅ licenses → show
✅ licenses → update
✅ licenses → destroy
✅ licenses → status
✅ licenses → domains → update
✅ generators → index
✅ generators → store
✅ generators → show
✅ generators → update
✅ generators → destroy
✅ generators → generate
✅ generators → terms → index
✅ users → index
✅ users → store
✅ users → show
✅ users → find
and click the Save button
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 use the copied Connector String on your main WordPress site. Please read the Asura: Adding remote site using Connector String (API credential) documentation.
Learn by watching a brand new screencast on YouTube!
