API Usage Guidelines

System Capacity Overview

Best Practices for API Integration

1. Implement Rate Limiting

To ensure optimal performance for all users, please implement client-side rate limiting:

2. Avoid Traffic Bursts

Solution: Implement request queuing and throttling

Example pattern:
- Queue your messages locally
- Send at a steady rate of 50-100 requests/second
- Monitor response times and adjust accordingly

3. Optimize Peak Hour Operations

If you need to send large volumes during morning hours:

• Spread the load: Start sending 30-60 minutes before your target completion time
• Batch wisely: Keep batch sizes reasonable (recommend 100-500 items per batch)
• Use asynchronous processing: Implement async patterns where messages don't need immediate confirmation

4. Monitor and Respect HTTP Response Codes

5. Payload Optimization

• Keep individual request payloads under 1 MB when possible
• Compress large payloads when your use case allows
• Remove unnecessary data fields from requests

6. Connection Management

• Use persistent connections (HTTP keep-alive) to reduce overhead
• Implement connection pooling (recommend 5-10 connections per client)
• Set reasonable timeout values (suggest 30 seconds for read timeout)

Recommended Implementation Example

Rate limiter configuration:
- Requests per second: 80-100
- Burst allowance: 150 (short spike tolerance)
- Retry strategy: Exponential backoff starting at 1 second
- Max retries: 3 attempts

Need Higher Capacity?

If your business requirements exceed these guidelines, please contact our tech team to discuss:

• Dedicated infrastructure options
• Custom rate limits

Support Contact

For technical questions or capacity planning assistance, reach out to our technical support team with your:

• Expected request volume
• Peak usage patterns
• Current integration approach

Potential API Response Codes

{
    "smtpId": "<1006462692.13.1775588067812.JavaMail.root@1342438-rs5r8.max.md>",
    "message": "Message sent. Message was sent and saved to INBOX.Sent folder",
    "code": 0,
    "success": true
}

HTTP 200 OK
{
  "code": 999,
  "message": "error"
}