Integration GuidesΒΆ
Welcome to the ReputeAPI integration guides! These guides will help you quickly integrate email security validation into your applications using your preferred language or tool.
Available GuidesΒΆ
Quick Start GuidesΒΆ
-
π Python Guide
Complete Python integration with requests, error handling, and best practices
-
π JavaScript Guide
Browser and Node.js examples with async/await and fetch API
-
π¬ Postman Collection
Ready-to-import Postman collection for testing and exploration
-
π» cURL Examples
Command-line examples for quick testing and shell scripting
Advanced GuidesΒΆ
- Integration Patterns - Architecture patterns for different use cases
- Best Practices - Performance optimization, caching, and error handling
Choose Your LanguageΒΆ
Python:
import requests
def validate_domain(domain, api_key):
url = "https://api.reputeapi.com/api/v1/check"
headers = {"X-API-Key": api_key}
params = {"domain": domain}
response = requests.get(url, headers=headers, params=params)
return response.json()
# Usage
result = validate_domain("example.com", "your-api-key")
print(f"Security Score: {result['score']}/100")
JavaScript:
async function validateDomain(domain, apiKey) {
const url = `https://api.reputeapi.com/api/v1/check?domain=${domain}`;
const response = await fetch(url, {
headers: {
'X-API-Key': apiKey
}
});
return await response.json();
}
// Usage
const result = await validateDomain('example.com', 'your-api-key');
console.log(`Security Score: ${result.score}/100`);
View full JavaScript guide β
cURL:
curl -X GET "https://api.reputeapi.com/api/v1/check?domain=example.com" \
-H "X-API-Key: your-api-key"
What You'll LearnΒΆ
In These GuidesΒΆ
- Authentication - How to properly use your API key
- Making Requests - GET and POST request examples
- Error Handling - Handling rate limits, timeouts, and errors
- Response Parsing - Extracting and using validation results
- Best Practices - Caching, retry logic, and performance tips
API CapabilitiesΒΆ
- Validate SPF, DKIM, and DMARC records
- Get 0-100 mailflow security scores
- Receive prioritized recommendations
- Get ready-to-use DNS configuration snippets
- Track usage and monitor quotas
Common Use CasesΒΆ
1. Email Service Provider IntegrationΒΆ
Validate customer domains during onboarding:
def onboard_customer(customer_email_domain):
result = validate_domain(customer_email_domain)
if result['score'] < 50:
# Show critical issues to customer
return {
'status': 'needs_attention',
'issues': result['issues'],
'recommendations': result['recommendations']
}
return {'status': 'ok', 'score': result['score']}
2. Security Monitoring DashboardΒΆ
Build a dashboard to monitor multiple domains:
async function checkAllDomains(domains) {
const results = await Promise.all(
domains.map(domain => validateDomain(domain))
);
return results.map((result, index) => ({
domain: domains[index],
score: result.score,
critical_issues: result.issues.filter(i => i.severity === 'critical')
}));
}
View bulk validation examples β
3. Automated Email Security AuditsΒΆ
Schedule regular audits of your domains:
import schedule
import time
def audit_domains():
domains = get_company_domains()
for domain in domains:
result = validate_domain(domain)
store_result(domain, result)
if result['score'] < 70:
send_alert(domain, result)
# Run every day at 9 AM
schedule.every().day.at("09:00").do(audit_domains)
Next StepsΒΆ
- Choose a guide based on your preferred language or tool
- Get your API key from reputeapi.com
- Follow the quick start in your chosen guide
- Explore advanced patterns in our integration guides
Need Help?ΒΆ
- Can't find your language? Check our API Reference for language-agnostic HTTP examples
- Running into issues? See our Common Errors guide
- Have questions? Read the FAQ or contact support
Community ExamplesΒΆ
Have you built something cool with our API? We'd love to feature your integration!
- Submit examples via GitHub
- Share integration patterns with the community
- Contribute to our documentation