​
Secure Authentication and API Key Management

To ensure secure communication and interaction with the Kwei Client SDK, proper authentication using API keys is essential. Here’s how you can securely authenticate and manage your API keys through the Kwei Dashboard.

​
Step 1: Create Your Account on the Kwei Dashboard

Before you can use the Kwei Client SDK, you must register and create an account on the Kwei Dashboard. This account will serve as the central point for managing your applications, API keys, usage statistics, and billing information.

​
Step 2: Generate API Keys

Once your account is set up, you can generate API keys that will allow your application to authenticate and interact with Kwei services. Here’s how:

  • Navigate to the API Keys Section: After logging into the dashboard, go to the ‘API Keys’ section.
  • Create a New Key: Click on the ‘Create New Key’ button. You will be prompted to name your key and select the services it should access.
  • Generate the Key: After configuring your key, click ‘Generate’. This will create a new API Key and Secret Key.

​
Step 3: Secure Your Secret Key

When your keys are generated, the Secret Key is displayed only once. It’s crucial to save this key securely as it will not be shown again for security reasons. Here are some tips for managing your Secret Key:

  • Save Immediately: Copy and securely save the Secret Key in a safe location such as a password manager or an encrypted database.
  • Do Not Share: Keep your Secret Key confidential. Exposure could allow unauthorized access to your Kwei services.
  • Regenerate If Compromised: If you suspect that your Secret Key has been compromised, regenerate your API keys immediately from the dashboard.

​
Step 4: Initialize the SDK

With your API Key and Secret Key, you can now initialize the Kwei Client SDK in your application:

const kwei = require("kwei-client-js-sdk");
const room = new kwei.Room();

room
  .init("your_api_key", "your_secret_key")
  .then(() => {
    console.log("SDK successfully initialized");
  })
  .catch((error) => {
    console.error("Initialization failed:", error);
  });

​
Best Practices for API Key Usage

  • Environment Variables: Store your API keys in environment variables instead of hardcoding them into your application code.
  • Limit Permissions: Only grant your API keys the permissions necessary for your application to function.
  • Regular Audits: Regularly review and audit your API key usage through the Kwei Dashboard to ensure they are being used appropriately and by authorized users only.

​
Conclusion

Following these steps will help you securely integrate and use the Kwei Client SDK in your application. Proper management of your API keys is crucial for maintaining the security of your real-time communication features.

PrerequisitesJoining Room