View Categories

API Key Configuration

Andreas
Updated on December 21, 2024

1 min read

Introduction

Configuring your OpenAI API key is a crucial step in setting up the WPiko Chatbot plugin. This key allows your chatbot to communicate with OpenAI’s powerful language models.

Obtaining an OpenAI API Key

Before configuring the plugin, you need to obtain an API key from OpenAI:

  1. Visit the OpenAI website (https://openai.com/).
  2. Sign up for an account or log in if you already have one.
  3. Navigate to the API section of your account.
  4. Generate a new API key. Keep this key secure, as it will be used to authenticate your requests.

Configuring the API Key in WPiko Chatbot

Once you have your OpenAI API key, follow these steps to configure it in the plugin:

  1. Log in to your WordPress admin panel.
  2. Navigate to “WPiko Chatbot” > “API Key” in the sidebar menu.
  3. You’ll see a field labeled “OpenAI API Key”.
  4. Paste your API key into this field.
  5. Click “Save API Key” to store and encrypt your key.

Security Measures

The WPiko Chatbot plugin takes several measures to keep your API key secure:

  • Encryption: Your API key is encrypted before being stored in the database.
  • Masking: Once saved, only the last 5 characters of your API key will be visible in the admin interface.
  • Nonce Protection: All API key operations are protected with WordPress nonces to prevent CSRF attacks.

Updating or Deleting the API Key

To update your API key:

  1. Navigate to the API Key settings page.
  2. Enter your new API key in the provided field.
  3. Click “Update API Key”.

To delete your API key:

  1. Go to the API Key settings page.
  2. Click the “Delete API Key” button.
  3. Confirm the deletion when prompted.

Verifying API Key Configuration

After saving your API key, the plugin will automatically attempt to validate it. If successful, you’ll see a confirmation message. If there’s an issue, you’ll receive an error message with details.

Troubleshooting API Key Issues

If you encounter problems with your API key:

  1. Double-check that you’ve copied the entire key correctly.
  2. Ensure your OpenAI account is in good standing and the key is active.
  3. Check your WordPress error logs for any specific error messages.
  4. Temporarily disable other plugins to rule out conflicts.

Best Practices

  • Regularly rotate your API key for enhanced security.
  • Never share your API key or expose it in client-side code.
  • Monitor your OpenAI usage to prevent unexpected charges.

Important Notes

  • The API key is required for both the Direct API and Assistant API functionalities of the plugin.
  • Ensure your website uses HTTPS to encrypt data transmission, including API requests.
  • If you’re using a staging or development environment, consider using a separate API key from your production site.

By carefully configuring and managing your OpenAI API key, you ensure the secure and efficient operation of your WPiko Chatbot. Remember to keep your API key confidential and update it periodically as part of your regular security practices.

Updated on December 21, 2024
Shopping Cart