aidevops 2.52.1

package/.agent/aidevops/api-integrations.md

@@ -0,0 +1,335 @@
+---
+description: Comprehensive API integration guide
+mode: subagent
+tools:
+  read: true
+  write: false
+  edit: false
+  bash: true
+  glob: true
+  grep: true
+  webfetch: true
+---
+
+# Comprehensive API Integration Guide
+
+<!-- AI-CONTEXT-START -->
+
+## Quick Reference
+
+**Total APIs**: 28+ integrated services
+
+**By Category**:
+- **Hosting**: Hostinger, Hetzner, Closte, Coolify
+- **DNS/Domains**: Cloudflare, Spaceship, 101domains, Route53, Namecheap
+- **Git**: GitHub, GitLab, Gitea
+- **Code Quality**: CodeRabbit, Codacy, SonarCloud, CodeFactor
+- **SEO**: Ahrefs, Google Search Console, Perplexity
+- **Security**: Vaultwarden
+- **Email**: Amazon SES
+- **Dev Tools**: Context7, LocalWP, Pandoc, Agno, Playwright/Selenium
+
+**Pattern**: `configs/[service]-config.json` + `.agent/scripts/[service]-helper.sh`
+
+**API Key Setup**: `bash .agent/scripts/setup-local-api-keys.sh set [service]-api-key YOUR_KEY`
+**Test All APIs**: `bash .agent/scripts/test-all-apis.sh`
+<!-- AI-CONTEXT-END -->
+
+This document provides detailed information about all 28+ API integrations supported by the AI DevOps framework.
+
+## 📊 **API Integration Overview**
+
+Our framework provides standardized access to APIs across all major infrastructure categories, enabling seamless automation and management through consistent interfaces.
+
+## 🏗️ **Infrastructure & Hosting APIs**
+
+### **Hostinger API**
+
+- **Purpose**: Server management, domain operations, hosting control
+- **Authentication**: API Token
+- **Configuration**: `configs/hostinger-config.json`
+- **Helper Script**: `.agent/scripts/hostinger-helper.sh`
+- **Key Features**: VPS management, domain registration, hosting plans
+
+### **Hetzner Cloud API**
+
+- **Purpose**: VPS management, networking, load balancers
+- **Authentication**: API Token
+- **Configuration**: `configs/hetzner-config.json`
+- **Helper Script**: `.agent/scripts/hetzner-helper.sh`
+- **Key Features**: Server creation, networking, snapshots, load balancers
+
+### **Closte API**
+
+- **Purpose**: Managed hosting, application deployment
+- **Authentication**: API Key
+- **Configuration**: `configs/closte-config.json`
+- **Helper Script**: `.agent/scripts/closte-helper.sh`
+- **Key Features**: Application management, deployment automation
+
+### **Coolify API**
+
+- **Purpose**: Self-hosted PaaS, application management
+- **Authentication**: API Token
+- **Configuration**: `configs/coolify-config.json`
+- **Helper Script**: `.agent/scripts/coolify-helper.sh`
+- **Key Features**: Docker deployment, service management, monitoring
+
+## 🌐 **Domain & DNS APIs**
+
+### **Cloudflare API**
+
+- **Purpose**: DNS management, security, performance optimization
+- **Authentication**: API Token (scoped permissions)
+- **Configuration**: `configs/cloudflare-dns-config.json`
+- **Helper Script**: `.agent/scripts/dns-helper.sh`
+- **Key Features**: DNS records, security rules, analytics, caching
+
+### **Spaceship API**
+
+- **Purpose**: Domain registration, management, transfers
+- **Authentication**: API Key
+- **Configuration**: `configs/spaceship-config.json`
+- **Helper Script**: `.agent/scripts/spaceship-helper.sh`
+- **Key Features**: Domain search, registration, WHOIS, transfers
+
+### **101domains API**
+
+- **Purpose**: Domain purchasing, bulk operations, WHOIS
+- **Authentication**: API Credentials
+- **Configuration**: `configs/101domains-config.json`
+- **Helper Script**: `.agent/scripts/101domains-helper.sh`
+- **Key Features**: Bulk domain operations, pricing, availability
+
+### **AWS Route 53 API**
+
+- **Purpose**: DNS management, health checks
+- **Authentication**: AWS Access Keys
+- **Configuration**: `configs/route53-dns-config.json`
+- **Helper Script**: `.agent/scripts/dns-helper.sh`
+- **Key Features**: DNS hosting, health checks, traffic routing
+
+### **Namecheap API**
+
+- **Purpose**: Domain registration, DNS management
+- **Authentication**: API Key + Username
+- **Configuration**: `configs/namecheap-dns-config.json`
+- **Helper Script**: `.agent/scripts/dns-helper.sh`
+- **Key Features**: Domain management, DNS hosting, SSL certificates
+
+## 📧 **Communication APIs**
+
+### **Amazon SES API**
+
+- **Purpose**: Email delivery, bounce handling, analytics
+- **Authentication**: AWS Access Keys
+- **Configuration**: `configs/ses-config.json`
+- **Helper Script**: `.agent/scripts/ses-helper.sh`
+- **Key Features**: Email sending, bounce tracking, reputation monitoring
+
+### **Twilio API**
+
+- **Purpose**: SMS, voice calls, WhatsApp, phone verification, call recording
+- **Authentication**: Account SID + Auth Token
+- **Configuration**: `configs/twilio-config.json`
+- **Helper Script**: `.agent/scripts/twilio-helper.sh`
+- **Key Features**: SMS/MMS, voice calls, WhatsApp Business, Verify (2FA), Lookup, recordings, transcriptions
+- **AUP Compliance**: Must follow Twilio Acceptable Use Policy
+- **Recommended Client**: Telfon app for end-user interface (https://mytelfon.com/)
+
+### **MainWP API**
+
+- **Purpose**: WordPress site management, updates, monitoring
+- **Authentication**: API Key
+- **Configuration**: `configs/mainwp-config.json`
+- **Helper Script**: `.agent/scripts/mainwp-helper.sh`
+- **Key Features**: Site management, updates, backups, monitoring
+
+## 🔐 **Security & Code Quality APIs**
+
+### **Vaultwarden API**
+
+- **Purpose**: Password management, secure credential storage
+- **Authentication**: API Token
+- **Configuration**: `configs/vaultwarden-config.json`
+- **Helper Script**: `.agent/scripts/vaultwarden-helper.sh`
+- **Key Features**: Credential storage, secure sharing, audit logs
+
+### **CodeRabbit API**
+
+- **Purpose**: AI-powered code review, security analysis
+- **Authentication**: API Key
+- **Setup Script**: `.agent/scripts/coderabbit-cli.sh`
+- **Key Features**: Automated code review, security scanning, suggestions
+
+### **Codacy API**
+
+- **Purpose**: Code quality analysis, technical debt tracking
+- **Authentication**: API Token
+- **Setup Script**: `.agent/scripts/codacy-cli.sh`
+- **Key Features**: Quality metrics, security analysis, coverage tracking
+
+### **SonarCloud API**
+
+- **Purpose**: Security scanning, maintainability metrics
+- **Authentication**: API Token
+- **Integration**: GitHub Actions workflow
+- **Key Features**: Security hotspots, code smells, coverage analysis
+
+### **CodeFactor API**
+
+- **Purpose**: Automated code quality grading
+- **Authentication**: GitHub integration
+- **Setup**: Automatic via GitHub
+- **Key Features**: Quality scoring, trend analysis, file-level metrics
+
+## 🔍 **SEO & Analytics APIs**
+
+### **Ahrefs API**
+
+- **Purpose**: SEO analysis, backlink research, keyword tracking
+- **Authentication**: API Key
+- **MCP Integration**: `mcp-server-ahrefs`
+- **Key Features**: Backlink analysis, keyword research, competitor analysis
+
+### **Google Search Console API**
+
+- **Purpose**: Search performance, indexing status
+- **Authentication**: Service Account (Google Cloud)
+- **MCP Integration**: `mcp-server-gsc`
+- **Key Features**: Search analytics, Core Web Vitals, index coverage
+
+### **Perplexity API**
+
+- **Purpose**: AI-powered research and content generation
+- **Authentication**: API Key
+- **MCP Integration**: `perplexity-mcp`
+- **Key Features**: Research queries, content generation, fact-checking
+
+## ⚡ **Development & Git APIs**
+
+### **GitHub API**
+
+- **Purpose**: Repository management, actions, security
+- **Authentication**: Personal Access Token
+- **Helper Script**: `.agent/scripts/git-platforms-helper.sh`
+- **Key Features**: Repository operations, workflow management, security scanning
+
+### **GitLab API**
+
+- **Purpose**: Project management, CI/CD, security scanning
+- **Authentication**: Personal Access Token
+- **Helper Script**: `.agent/scripts/git-platforms-helper.sh`
+- **Key Features**: Project management, pipeline automation, security features
+
+### **Gitea API**
+
+- **Purpose**: Self-hosted Git operations, user management
+- **Authentication**: API Token
+- **Helper Script**: `.agent/scripts/git-platforms-helper.sh`
+- **Key Features**: Repository management, user administration, webhooks
+
+### **Context7 API**
+
+- **Purpose**: Real-time documentation access
+- **Authentication**: API Key
+- **MCP Integration**: `@context7/mcp-server`
+- **Key Features**: Library documentation, code examples, API references
+
+### **LocalWP API**
+
+- **Purpose**: WordPress database operations, site management
+- **Authentication**: Local access
+- **MCP Integration**: Custom MCP server
+- **Key Features**: Database queries, site management, development tools
+
+### **Pandoc Document Conversion**
+
+- **Purpose**: Convert various document formats to markdown for AI processing
+- **Authentication**: Local tool (no API key required)
+- **Helper Script**: `.agent/scripts/pandoc-helper.sh`
+- **Key Features**: Multi-format conversion, batch processing, AI-optimized output
+- **Supported Formats**: Word, PDF, HTML, EPUB, LaTeX, and 20+ other formats
+
+### **Agno AgentOS**
+
+- **Purpose**: Local AI agent operating system for DevOps automation
+- **Authentication**: API keys for LLM providers (OpenAI, Anthropic, etc.)
+- **Setup Script**: `.agent/scripts/agno-setup.sh`
+- **Key Features**: Multi-agent framework, production runtime, complete privacy
+- **Agents**: DevOps Assistant, Code Review Agent, Documentation Agent
+- **Interface**: Agent-UI web interface and REST API
+
+### **Local Browser Automation (Playwright/Selenium)**
+
+- **Purpose**: LOCAL web automation and browser-based task automation (privacy-first)
+- **Authentication**: Website credentials (stored securely in local environment only)
+- **Setup Script**: Included in `.agent/scripts/agno-setup.sh`
+- **Key Features**: LOCAL LinkedIn automation, web scraping, form filling, social media management
+- **Privacy**: Complete local operation - no cloud services or external browsers
+- **Agents**: LinkedIn Automation Assistant (local), Web Automation Assistant (local)
+- **Tools**: LOCAL Playwright, LOCAL Selenium, BeautifulSoup, ethical automation guidelines
+- **Security**: Enterprise-grade privacy with local-only browser instances
+
+## 🔧 **API Integration Features**
+
+### **Standardized Authentication**
+
+- Consistent token management across all APIs
+- Secure credential storage in separate config files
+- Environment variable support for CI/CD
+
+### **Rate Limiting & Error Handling**
+
+- Built-in respect for API limits and quotas
+- Comprehensive error messages and retry logic
+- Graceful degradation when APIs are unavailable
+
+### **Security & Compliance**
+
+- Secure credential storage with proper file permissions
+- Minimal permission scoping for all API keys
+- Complete audit trail of all API operations
+
+### **Monitoring & Logging**
+
+- Comprehensive logging of all API interactions
+- Performance monitoring and analytics
+- Error tracking and alerting
+
+## 🚀 **Getting Started**
+
+### **Quick Setup**
+
+```bash
+# Setup all API integrations
+bash setup.sh
+
+# Configure specific API
+cp configs/[service]-config.json.txt configs/[service]-config.json
+# Edit with your API credentials
+
+# Test API connection
+./.agent/scripts/[service]-helper.sh test-connection
+```
+
+### **API Key Management**
+
+```bash
+# Secure API key setup
+bash .agent/scripts/setup-local-api-keys.sh set [service]-api-key YOUR_API_KEY
+
+# List configured APIs
+bash .agent/scripts/setup-local-api-keys.sh list
+
+# Test all API connections
+bash .agent/scripts/test-all-apis.sh
+```
+
+## 📚 **Additional Resources**
+
+- [MCP Integration Guide](MCP-INTEGRATIONS.md)
+- [Security Best Practices](.agent/spec/security.md)
+- [Configuration Templates](../configs/)
+- [Helper Scripts](../.agent/scripts/)
+- [API Testing Scripts](.agent/scripts/)