Ringotel API Key gives developers full access to make changes to a Ringotel account through the Admin API and communicate with Ringotel users via Messaging API.
Important:
Keep your API Key safe, and don't share it publicly. You can deactivate your API key and generate a new one at any time.
Access your API Key
In your Ringotel account, open the Account menu on the left sidebar navigation, then select Settings.
In the account settings, navigate to the API Settings section to generate the API Key.
If no API Key is created yet, you need to provide a Webhook URL and then click Create key button to generate a new API Key for your Ringotel account.
Webhook URL
The Webhook URL is configured at the account level. If SMS via API is enabled in an organisation’s connection settings, Ringotel will send messages and notifications sent from Ringotel users.
Tip:
If you don't need to receive notifications from Ringotel, you can specify any valid URL in the Webhook URL field to generate an API key.
Is it possible to configure a Webhook per organization?
While you can use Webhook integration configured per organisation to sync call activity details, for messages notifications you can specify only one Webhook URL per account. However, you can specify a $domain$ variable in the Webhook URL which will take the value of the organisation's domain related to the event. In this way, you can resolve multiple subdomains to different API endpoints unique to each Ringotel organization. For example: https://$domain$.ringotel.co/api.
Rotate API Key
Rotating an API Key will deactivate an existing key and generate a new one.
Note:
API Key gives full access to your Ringotel account. For added security, we recommend to frequently rotate your Ringotel API Key.
To rotate your existing Ringotel API Key:
In your Ringotel account, open the Account menu on the left sidebar navigation, then select Settings.
In the account settings, navigate to the API Settings section to rotate the API Key.
Click Rotate key button and confirm the action when prompted.
Deactivate API Key
Deactivating your API Key will not create a new key. API calls using the deactivated Ringotel API Key will fail, and any application using the key will no longer be able to use Ringotel APIs.
To deactivate your API Key:
In your Ringotel account, open the Account menu on the left sidebar navigation, then select Settings.
In the account settings, navigate to the API Settings section to deactivate the API Key.
Click Deactivate key button and confirm the action when prompted.