Regenerating an API key on SMSGatewayCenter updates your authentication credentials, which can impact existing integrations. Here’s what happens and how to manage it:
Consequences of Regenerating an API Key #
- Invalidates the Old Key: The previous API key will no longer work, and any API requests using it will fail.
- Disrupts Integrations: Existing integrations (e.g., CRM systems, apps) using the old key will stop functioning until updated with the new key.
Steps to Manage the Transition #
- Regenerate the Key: Follow the steps to regenerate your API key in the Generate API Key Settings section (see FAQ on regenerating API keys).
- Copy the New Key: Note down the newly generated API key (it may be masked for security, so use the reveal functionality).
- Update Integrations: Replace the old API key with the new one in all your applications or systems using the SMSGatewayCenter API.
- Example: Update your API request header to
Authorization: Bearer new_api_key.
- Example: Update your API request header to
- Test the New Key: Make a test API request to ensure the new key works.
Best Practices #
- Schedule the regeneration during a low-activity period to minimize disruption.
- Notify your development team in advance to ensure all integrations are updated promptly.
Properly managing the transition after regenerating your API key ensures uninterrupted API usage on SMSGatewayCenter. For assistance, contact our support team.