Adding an API key is crucial for integrating your account with our platform. Follow these steps to generate and use your API key effectively.
Why Add an API Key?
- Security: API keys keep your interactions with the platform secure.
- Automation: Enable automated processing and sending of emails.
- Access Control: Manage what features and data can be accessed by applications using the key.
Prerequisites
Before adding an API key, ensure you have:
- Administrative access to your Sendses account.
- A verified domain on the platform.
Step-by-Step Guide
Step 1: Access the API Key Settings
- Login to Your Account: Use your administrative credentials to sign in to your SaaS account.
- Navigate to API Keys: Go to the 'Settings' menu and select 'API Keys.'
Step 2: Create an API Key
- Click 'Add Key': Find and click the 'Add Key' button.
- Enter Details: In the popup, enter a name for your API key and select the domain it will be associated with.
- Generate Key: Click 'Continue' to generate your API key.
Step 3: Secure and Store Your Key
- Copy Key: Once the key is generated, copy and store it securely. It will only be visible once.
- Implement Key: Use this key in your application or scripts where needed to interact with the platform.
Troubleshooting
Common Issues
- Key Not Working: Ensure you are using the correct key and that it hasn't been revoked.
- Permission Errors: Double-check that your API key has the necessary permissions for the actions you are attempting.
Getting Help
If you encounter issues, contact our support team with the following details:
- Account email
- API key name (not the key itself)
- Error messages received during API calls
Final Steps
After setting up your API key:
- Integrate with Applications: Use the API key to integrate with your applications and automate your processes.
- Monitor Usage: Regularly check your API key usage for any anomalies.
FAQs
How Do I Regenerate an API Key?
To regenerate an API key, delete the existing key and create a new one using the steps above.
Can I Restrict API Key Permissions?
Yes, you can set permissions for each API key during creation to control access levels.
How Do I Delete an API Key?
To delete an API key, navigate to 'API Keys' in the 'Settings' menu, select the key you wish to remove, and click 'Delete.' Confirm the deletion when prompted.
By following these instructions, you can successfully integrate and utilize API keys within your application.
For more detailed documentation on how to use API Keys, visit our documentation.