AuroraSendCloud API Overview

Get started with AuroraSendCloud's powerful APIs to send emails, manage contacts, track performance, and integrate seamlessly with your applications. This comprehensive guide will help you make your first API call in minutes.

Quick Start Checklist

Before you begin, ensure you have:

• ✅ An active AuroraSendCloud account (Sign up here)
• ✅ Your API Key and API User from API Key Management
• ✅ A supported HTTP client (cURL, Postman, Python, Node.js, etc.)
• ✅ Your account region (Singapore, US, or CN) for optimal performance

Regional Base URLs & Endpoints

Email APIs & SMTP Servers (Multi-Region)

Choose the base URL and SMTP server that matches your account's region for email services, contact management, templates, and other core services. All REST API requests must use HTTPS, and responses are returned in JSON format.

REST API Endpoints

SMTP Servers

⚠️

Important: Your account is tied to a specific region. Using a non-matching base URL or SMTP server will cause authentication failures. Verify your region in account settings.

SMS API (Single Global Endpoint)

The SMS API uses a unified global endpoint regardless of your account region:

• Base URL: https://api.aurorasendcloud.com/

Authentication

All API and SMTP requests require authentication using these parameters:

• api_user: Your AuroraSendCloud API username
• api_key: Your AuroraSendCloud API key

🔐

Security Best Practice: Never expose API credentials in client-side code. Use server-side implementations and rotate keys regularly.

Email Integration Options

AuroraSendCloud offers two methods for sending emails: REST API for advanced features and programmatic control, and SMTP for simple integration with existing email clients and applications.

REST API - Send an Email

curl -X POST "https://api.aurorasendcloud.com/api/mail/send" \
  -d "api_user=YOUR_API_USER" \
  -d "api_key=YOUR_API_KEY" \
  -d "[email protected]" \
  -d "fromName=Your Name" \
  -d "[email protected]" \
  -d "subject=Welcome to AuroraSendCloud" \
  -d "html=<h1>Hello World!</h1><p>Your first email via AuroraSendCloud API</p>"

SMTP Integration

For applications requiring SMTP integration, use our regional SMTP servers with standard authentication. SMTP provides a simple way to integrate email sending into existing applications.

SMTP Configuration

• Username: Your API username (api_user)
• Password: Your API key (api_key)
• Ports: 25, 2525, 587 (standard SMTP ports)
• Authentication: Required for all connections
• Security: STARTTLS supported on port 587

SMTP Code Examples

import smtplib
from email.mime.text import MIMEText
from email.mime.multipart import MIMEMultipart

# Configuration - Use regional SMTP server
smtp_server = "smtp.aurorasendcloud.com"  # Singapore
# smtp_server = "smtp-us.aurorasendcloud.com"  # US
# smtp_server = "smtp-hk.aurorasendcloud.com"  # CN
smtp_port = 587  # STARTTLS
username = "YOUR_API_USER"
password = "YOUR_API_KEY"

# Create message
msg = MIMEMultipart()
msg['From'] = "[email protected]"
msg['To'] = "[email protected]"
msg['Subject'] = "Test Email via SMTP"

body = "Hello from AuroraSendCloud SMTP!"
msg.attach(MIMEText(body, 'plain'))

# Send email with STARTTLS
try:
    server = smtplib.SMTP(smtp_server, smtp_port)
    server.starttls()  # Enable security
    server.login(username, password)
    text = msg.as_string()
    server.sendmail("[email protected]", "[email protected]", text)
    server.quit()
    print("Email sent successfully!")
except Exception as e:
    print(f"Error: {e}")

SMTP vs REST API Comparison

SMS Integration

curl -X POST "https://api.aurorasendcloud.com/smsapi/send" \
  -d "smsUser=YOUR_SMS_USER" \
  -d "smsKey=YOUR_SMS_KEY" \
  -d "templateId=123456" \
  -d "phone=+1234567890" \
  -d "vars={\"code\":\"123456\"}"

API Response Format

All API responses follow a consistent JSON structure:

Success Response

{
  "result": true,
  "statusCode": 200,
  "message": "request was successful",
  "info": {
    "emailIdList": ["email_id_123"]
  }
}

Error Response

{
  "result": false,
  "statusCode": 40005,
  "message": "authentication failed",
  "info": {}
}

Response Fields

• result: Boolean indicating success (true) or failure (false)
• statusCode: Numeric status code (see complete reference below)
• message: Human-readable description of the result
• info: Contains response data on success, empty object on failure

Complete Status Code Reference

Common Status Codes

Parameter Validation Errors (40001-40017)

Label Management (40100-40113)

Template Management (40201-40229)

Address List Management (40501-40522)

Email Sending Parameters (40801-40880)

Email Sending Results (40901-40913)

Domain & API User Management (41001-41119)

System & Server Errors (49901-50001)

Best Practices

Account Management & Quotas

Daily Request Quota

Your account has a daily request quota that varies based on account type and reputation:

• Free users: 50 emails/day after email verification
• Paid users: Base quota of 3,000 emails/day, automatically adjusted based on reputation

Reputation System

AuroraSendCloud uses a reputation scoring system that affects your daily quota:

• Positive factors: High delivery rates, open rates, click rates
• Negative factors: Invalid addresses, spam reports, unsubscribes
• Critical: Rapid increases in invalid addresses or spam reports can suspend sending

Variables in Email Content

Use variables in your email content for personalization:

Hi %name%,
Welcome to AuroraSendCloud! Your verification code is: %active_code%

Variables can be used in:

• Email subject lines
• HTML and plain text content
• Template content with X-SMTPAPI substitution

Next Steps

Now that you understand the basics:

1. Set up your domain - Configure SPF, DKIM, and DMARC records
2. Create templates - Build reusable email templates for common scenarios
3. Implement webhooks - Get real-time notifications for email events
4. Monitor performance - Track delivery rates and optimize your sending

Ready to start building? Choose between REST API for advanced features or SMTP for simple integrations - both use the same authentication credentials and regional optimization!