Edit online

Oxygen AI Positron API Key Encryption Add-on

Installation

To install this add-on, follow these steps:
  1. Go to Help > Install new add-ons to open the add-on selection dialog box. Enter or paste https://www.oxygenxml.com/InstData/Addons/default/updateSite.xml in the Show add-ons from field or select it from the drop-down menu.
  2. Select the Oxygen AI Positron API Key Encryption add-on and click Next.
  3. Read the end-user license agreement. Then select the I accept all terms of the end-user license agreement option and click Install.
  4. Restart the application.
Result: The API Key Tools menu will be available.

Alternatively, you can install the add-on by downloading the JAR file from the Releases page and unzipping it inside {Oxygen XMLInstallDir}/plugins. Ensure there are no intermediate folders and that the plugin.xml file is present in the correct location.

Encrypting API Keys for the Configuration File

To securely store your API key in the ai-service-configuration.json configuration file for the Oxygen AI Positron Assistant Enterprise add-on, use the oxygen-ai-positron-apikey-encryption-addon. This add-on provides tools to encrypt your API key before adding it to the configuration file, and to decrypt it for verification purposes.

Encrypting the API Key

  1. Install the Encryption Add-on: Make sure the oxygen-ai-positron-apikey-encryption-addon is installed.
  2. Open API Key Tools: In the main menu, select API Key Tools.
  3. Encrypt the API Key: Choose Encrypt... from the menu. Enter your encryption key and the API key you want to protect. The tool will generate an encrypted version of your API key.
  4. Publish the Encrypted Key: Publish both the encryption key and the encrypted API key to the URLs referenced in your local-ai-service-configuration.json configuration file (for example, ai_key_param_encrypted and ai_key_param_seed).

By following these steps, you can securely manage your API key and ensure it is only accessible to authorized users. This also makes it easy to configure the AI service using the ai-service-configuration.json file.