CPaaS Guide
API Guide
BlogLogin

API Key Management

Learn how to generate/ view API keys for our CPaaS channels (Email, SMS, RCS, WhatsApp).

To begin, ensure you are logged into your Netcore CPaaS Dashboard with the appropriate administrative credentials.

⭐

Important Points to Remember

Email & WhatsApp: API keys can be manually generated directly through the CPaaS dashboard.

SMS: A unique API key is automatically assigned to each phone number registered in your dashboard.

RCS: A single, unique API key is provided for your entire CPaaS dashboard and is shared across all bots. Please note that you cannot generate new or additional API keys for this channel.

📘

Best Practices for API Security

  • Never share your API keys in public repositories (like GitHub) or via unencrypted messages.
  • Rotate your keys periodically (especially for Email and WhatsApp) to minimize risk.
  • Use IP Whitelisting for the Email channel whenever possible to ensure only authorized servers can send mail.

Email


The Email API key allows you to integrate email sending capabilities into your application. You can customize permissions and restrict access by IP for added security.

  1. Navigate to Settings > Integrations.
  2. Switch to the API tab.
  3. On the top right pane, click GENERATE API KEY.
  4. Configure your key:
  • Name: Enter a name for your reference.
  • Permissions: Select All or choose specific events.
  • IP Restriction: Add your IP address to restrict requests, or leave it empty for unrestricted access.
  1. Click GENERATE.
  2. Your key is now active and visible on the API Listing screen.

SMS

Unlike other channels, SMS authentication is handled at the individual number level.

  • Key Location: There is a unique API key attached to every phone number registered in your dashboard.
  • To find a specific key, locate the desired number within your SMS configuration settings.

RCS

For RCS, the API key is static and tied to the CPaaS dashboard itself rather than individual bots.

  1. Navigate to Settings > General.
  2. Locate the API key field and click SHOW.
  3. Security Check: You will be prompted to enter your dashboard login password to reveal the key.

📘

IMPORTANT

For RCS, the API key remains the same for all bots and is unique to every CPaaS dashboard. You cannot generate a new API key for this channel.

WhatsApp


WhatsApp API management includes specific limits and role-based restrictions.

  1. Navigate to Settings > Business Number.
  2. Locate the Integrate API section.
  3. Click GENERATE API.
  4. Security Check: You must enter your login password to view the generated key.

Key Constraints for WhatsApp:

  • Limit: You can generate a maximum of 3 API keys.
  • Role: Only users with Admin privileges can generate keys.