Generating an API Key

To generate an API Key, follow these steps:

  1. Navigate to the “API Keys” page. Refer to this section "Navigating to the "API Keys" page.
  2. Click on the “Generate API Key” button.

Clicking on the "Generate API Key" button

  1. You will be redirected to the “Create API Key” page

The "Create API Key" page

  1. Type the name of the API key in the name field.
📘

You can enter up to 512 characters.

  1. Choose the expiration date for the API key. The default is today's date next year.

Choosing the expiration date for the API key

  1. Choose the specific APIs for which you intend to use this key. Your options include:
  • WhatsApp: Use this API to send and receive messages through WhatsApp.
  • Viber: Use this API to send and receive text messages via Viber.
  • RCS (Rich Communication Services): Use RCS for an advanced messaging protocol that supports rich media and interactive features.
  • SMS: Use this API to send standard text messages to mobile phones worldwide via the SMS.
  • SMS-Get: Use this API to receive incoming SMS messages from users, enabling two-way text communication.
  • Instagram: Use this API to send and receive messages via Instagram.
  1. Click on the "Save" button to save your changes.

Clicking on the "Save" button

  1. After clicking on the "Save" button, the following will appear:

a. A confirmation message indicating that “The API key generated successfully. b. a pop-up will appear displaying the generated API key details:

  1. Key Name: The name you provided.
  2. Key APIs: The APIs you selected.
  3. Expires On: The expiration date you set.
  4. API Key: The generated API key, with a "Copy to Clipboard" button for easy copying.
  5. Important Note: This note indicates that the API key is displayed only once. It's advisable to copy it and securely store it in a safe location.

The generated API key pop up

  1. Click on the "Copy to Clipboard" button to copy the API key.
Figure 108: The " Copy to Clipboard " button.

The " Copy to Clipboard " button.

  1. Check the checkbox acknowledging that you have stored the key securely.
Figure 109: Checking the checkbox.

Checking the checkbox.

  1. Click on the "Done" button, then the API key will be listed in the API keys list.

The list of API Keys