How to: Add, Download, Delete or View an InterWorx-CP Theme
November 15, 2012How to: Mail Queue Guide
November 15, 2012How to: Generate / Delete an API Key
In order for 3rd party software like billing systems to interface with InterWorx to perform tasks such as SiteWorx account creation, the 3rd party software must first authenticate to prove that it is indeed permitted to request actions of the InterWorx control panel system. The most common way to provide authentication is to pass what is known as an API Key, a long string of random characters that is statistically impossible to guess or brute force. The API key will remain the same despite NodeWorx user email/password changes and there can even be a different API Key per reseller to have certain actions fall under the umbrella of a given reseller.
Generate an API Key
- Click the NodeWorx menu item if it is not already open.
- Click the API Key menu item.
- If there is no API key generated, you will see the following: API key not set.
- Click the Generate Button.
- You will see the following message at the top of the screen: New Remote Access Key Generated.
If you re-generate your API key, you will need to replace all instances of the API key in your programs that connect to the InterWorx Control Panel service with the re-generated key.
Delete an API Key
- Click the NodeWorx menu item if it is not already open.
- Click the API Key menu item.
- Click the Delete button.
- You will see the following message at the top of the screen: API key successfully deleted.
- Where the API key used to be, you will also see: API Key Not Set.
This will effectively cut off access to any 3rd party programs or other InterWorx servers that interact with this control panel.
