Ringotel API

Owned by Alex | Ringotel Team
Last updated: May 28, 2024
2 min read

With Ringotel Shell APIs, developers can integrate Ringotel account administration, user messaging or notification functionality into existing applications.

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.

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

  1. In your Ringotel account, click on the Menu button in the top right corner and select Integrations.

  2. If no API Key is created yet, you would need to provide a Webhook URL and then click Create key button to generate a new API Key for your Ringotel account.

  3. Confirm the action when prompted.

  4. When an API Key has been generated, click Copy to Clipboard to provide the key to your developers to build integration.

Rotate API Key

Rotating an API Key will deactivate an existing key and generate a new one.

API Key gives full access to your Ringotel account. For added security, we recommend rotating your Ringotel API Key every 6 months.

To rotate your existing Ringotel API Key:

  1. In your Ringotel account, click on the Menu button in the top right corner and select Integrations.

  2. 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:

  1. In your Ringotel account, click on the Menu button in the top right corner and select Integrations.

  2. Click Deactivate key button and confirm the action when prompted.

 

Â