Changelog¶

All notable changes to the ReputeAPI are documented on this page. We follow Semantic Versioning for our releases.

Version History¶

v1.2.0 (2025-03-15)¶

New Features

Bulk Validation Endpoint - Added /api/v1/bulk-validate endpoint for validating multiple domains in a single request
Historical Tracking - New /api/v1/history endpoint provides historical snapshots of domain security scores
Enhanced DNS Snippets - Added support for Cloudflare-specific DNS configuration snippets
Usage Analytics - Introduced /api/v1/usage endpoint for detailed API usage statistics and quota tracking

Improvements

Faster DNS Resolution - Reduced average DNS query time by 40% through optimized resolver selection
Score Calculation Refinement - Updated scoring algorithm to better weight DMARC policy configurations
Enhanced Error Messages - More descriptive error responses with suggested remediation steps
Rate Limit Headers - Added X-RateLimit-Remaining and X-RateLimit-Reset headers to all API responses

Bug Fixes

Fixed issue where DKIM validation failed for domains with multiple selectors
Resolved incorrect DMARC parsing for records with custom reporting URIs
Fixed SPF record validation for domains using include mechanisms with IPv6 addresses
Corrected score calculation edge case when all security records are missing

Security

Updated DNS resolution libraries to address potential cache poisoning vulnerabilities
Enhanced API key validation to prevent timing attacks
Implemented additional rate limiting checks for abuse prevention

Documentation

Added comprehensive Python integration guide with real-world examples
Published JavaScript/Node.js guide with async/await patterns
Created Postman collection with pre-configured requests
Expanded troubleshooting section with common DNS configuration issues

v1.1.0 (2025-02-10)¶

New Features

Recommendation Prioritization - Added /api/v1/recommendations endpoint that provides prioritized, actionable security improvements
Multi-Selector DKIM Support - Enhanced DKIM validation to check multiple selectors automatically
DNS Configuration Snippets - Included copy-paste DNS configurations for Route53, Cloudflare, and generic providers
Score Breakdown - Enhanced response format with detailed score breakdown showing deductions by severity

Improvements

Faster Response Times - Implemented intelligent caching layer reducing average response time from 850ms to 320ms
Better SPF Parsing - Improved SPF record parsing to handle complex include chains and macros
DMARC Policy Analysis - Enhanced DMARC validation with detailed policy recommendations
Error Handling - More granular error codes for easier troubleshooting

Bug Fixes

Fixed timeout issues for domains with slow DNS responses
Resolved edge case where DMARC validation failed on valid aggregate reporting URIs
Corrected handling of internationalized domain names (IDN)
Fixed incorrect score calculation for domains with SPF records exceeding DNS lookup limits

Performance

Reduced memory usage by 35% through optimized DNS record caching
Improved API response compression reducing bandwidth by 25%
Optimized database queries for historical data retrieval

Breaking Changes

API Response Format Update

The response format for /api/v1/check has been enhanced with a new score_breakdown field. The overall structure remains backward compatible, but clients may need updates to leverage the new detailed breakdown.

v1.0.0 (2025-01-20)¶

Initial Public Release

Core Validation Engine - Complete SPF, DKIM, and DMARC validation with DNS record analysis
Mailflow Security Score - Proprietary 0-100 scoring algorithm based on industry best practices
RESTful API - Clean, developer-friendly JSON API with comprehensive error handling
Rate Limiting - Tiered rate limiting system with Free, Basic, and Premium plans
Authentication - API key-based authentication with secure key management
OpenAPI Specification - Complete OpenAPI 3.0 documentation with interactive Swagger UI

Supported Features

SPF record validation with lookup limit checking
DKIM record validation with key strength analysis
DMARC policy validation with alignment checking
DNS query optimization with fallback resolvers
Detailed issue reporting with severity ratings
Copy-paste DNS configuration snippets
Request deduplication and caching
Comprehensive error codes and messages

Rate Limits

Plan	Requests/Minute	Monthly Quota
Free	10	1,000
Basic	60	10,000
Premium	120	50,000

Documentation

Getting started guide with quick start tutorial
Complete API reference with examples
Integration guides for Python, JavaScript, and cURL
Conceptual documentation for SPF, DKIM, and DMARC
Troubleshooting guide with common scenarios

Release Notes Format¶

Each release includes:

New Features - New endpoints, capabilities, or functionality
Improvements - Enhancements to existing features
Bug Fixes - Resolved issues and corrections
Security - Security-related updates and patches
Performance - Optimization and speed improvements
Documentation - Documentation updates and additions
Breaking Changes - Changes that may require client updates

Upgrade Guide¶

Migrating to v1.2.0¶

No breaking changes. All v1.1.0 integrations remain fully compatible. Consider leveraging:

New bulk validation endpoint for batch processing
Historical data endpoint for trend analysis
Enhanced usage analytics for monitoring

Migrating to v1.1.0¶

The score_breakdown field has been added to the /api/v1/check response. Existing clients will continue to work, but updating to parse this new field will provide better insights into score calculation.

Before (v1.0.0):

{
  "domain": "example.com",
  "score": 85,
  "issues": [...]
}

After (v1.1.0+):

{
  "domain": "example.com",
  "score": 85,
  "score_breakdown": {
    "current_score": 85,
    "max_score": 100,
    "total_deductions": 15,
    "potential_score_if_fixed": 100,
    "issues_by_severity": {
      "critical": 0,
      "high": 1,
      "medium": 2,
      "low": 1
    }
  },
  "issues": [...]
}

Deprecation Policy¶

We follow these principles for API changes:

Backward Compatibility - We strive to maintain backward compatibility across minor and patch versions
Deprecation Notice - Features are marked as deprecated at least 90 days before removal
Migration Path - We provide clear migration guides for deprecated features
Version Support - Major versions are supported for at least 12 months after a new major version release