Authentication

Authenticate API requests using an Active API Key retrieved from the Preferences section. For developers building integrations that access platform account data.

You authenticate in the Authentication & Connect API using an API Key. The API Key is encrypted and contains information specific to your account. When you have an API Key, the platform considers you a valid user or request.

  • Active API Key — To obtain an Active API Key, you go to the Preferences section in the Communications Platform's user interface (UI). You select the API tab and access your designated API Key. You use this API Key to create APIs that interact with information in your platform account. For more information, go to the Access your API Key section.
📘

NOTE

If you do not have the Admin role, you request the API Key from your Admin user. You do not request it from the support team or the commercial representative.