Email API Authentication
The Email API uses parameter-based authentication, requiring all requests to include your credentials as request parameters.
Required Parameters
Every Email API request must include the following parameters:
| Parameter | Description | Example |
|---|---|---|
| apiUser | Your API_USER | mycompany_api |
| apiKey | Your API_KEY | abc123def456... |
Important: These parameters must be included directly in the request parameters, not passed through HTTPS basic authentication or request headers.
Request Examples
GET request example:
curl "https://api.aurorasendcloud.com/email/send?apiUser=mycompany_api&apiKey=abc123def456&[email protected]&[email protected]&subject=Hello"POST request example:
curl -X POST "https://api.aurorasendcloud.com/email/send" \
-d "apiUser=mycompany_api" \
-d "apiKey=abc123def456" \
-d "[email protected]" \
-d "[email protected]" \
-d "subject=Hello World"Managing Email API Credentials
Where to find your credentials:
- Log into your Aurora SendCloud account dashboard
- Navigate to Email API from the main menu
- Select the API_USER Management section
Available actions:
- ✅ Create new API_USER (following platform naming conventions)
- 🔑 Generate associated API_KEY for users
- 🔄 Reset existing API_KEY
Email API_KEY Reset Process
When resetting API_KEY for the Email API, Aurora SendCloud provides a secure 15-minute grace period:
- ⏰ 15-minute grace period: After reset, the old key remains valid for 15 minutes
- 🔄 Smooth transition: Provides ample time to update integration configurations
- ⚡ Automatic expiration: The old key automatically expires after the grace period
Best practices for key reset:
- Reset the key in your dashboard
- Update your application configuration with the new key
- Ensure the update is completed within 15 minutes
- Monitor your application for successful authentication
