Skip to content

API Documentation Index

Welcome to the CyferWall Engage Backend API documentation hub.

📁 Available APIs

📋 API Reference Overview

Main API overview with authentication, response formats, and system health endpoints.

💬 Contact Form API

Complete documentation for the contact form submission and management system. - Public contact form submission - Staff management tools - Customer notifications - Priority routing

🎫 Support Case API

Comprehensive support case management documentation. - Case creation and tracking - Status checking and escalation - Internal statistics - Staff tools

🚀 Getting Started

  1. API Reference - Start here for authentication and base URL information
  2. Choose your API - Select Contact or Support based on your needs
  3. Review Examples - Each API includes comprehensive examples
  4. Use Type Definitions - Import TypeScript types for better development

📊 Implementation Status

View Complete Implementation Status

  • ✅ Contact Form API - Production ready with public endpoints
  • ✅ Support Case API - Production ready with comprehensive tooling
  • 📋 Admin/Staff Tools - Available as documented TODOs for on-demand implementation

🔧 Developer Resources

  • TypeScript Types: All APIs include full type definitions
  • Request/Response Examples: Complete examples for every endpoint
  • Error Handling: Comprehensive error code documentation
  • Integration Examples: Frontend integration patterns

📞 Need Help?