The API key is an alternative way for users to access the SMS Web API without having to authenticate with a username and password. You can use the API key as part of the header for HTTP requests. Include the X-SMS-API-KEY header in addition to the API Key. You can generate the API key for a local SMS user account.

Procedure

  1. Verify that the role for the selected user account has the Access SMS Web Services capability enabled. Learn more: Create or edit a user role.
  2. Select Admin → Authentication and Authorization → Users.
  3. Select the user account, and click Edit.
  4. Click Regenerate API Key to get a new API key. You can reset the API key for any reason. But when you do, from this point, the previous API key can no longer be used.