API Documentation

Currently, the API uses CORS origin validation. Requests must come from allowed origins configured in the ALLOWED_ORIGINS environment variable.

For n8n integration, OAuth2 authentication is supported and configured via environment variables.

POST /api/forms/contact

Submit general contact form inquiries.

Request Body

Example Request

POST /api/forms/contact
Content-Type: application/json

{
  "name": "John Doe",
  "email": "john@example.com",
  "subject": "Project Inquiry",
  "message": "I'm interested in learning more about your services.",
  "consent": true
}

Success Response (200)

{
  "success": true,
  "message": "Contact form submitted successfully",
  "data": {
    "referenceId": "CONTACT-1698765432000",
    "debugId": "1698765432000-a1b2c3d4",
    "submittedAt": "2025-10-26T10:30:32.000Z",
    "processingTime": 245
  }
}

Error Response (400)

{
  "error": {
    "message": "Validation failed",
    "code": "VALIDATION_ERROR",
    "status": 400,
    "details": [
      {
        "field": "email",
        "message": "Please provide a valid email address",
        "type": "string.email"
      }
    ]
  }
}

Rate Limiting

3 requests per 15 minutes per email address

POST /api/forms/business-contact

Submit business inquiry with comprehensive information.

Request Body

Example Request

POST /api/forms/business-contact
Content-Type: application/json

{
  "name": "Sarah Johnson",
  "email": "sarah@techcorp.com",
  "phone": "+1-555-0123",
  "businessName": "Tech Corp",
  "businessType": "corporation",
  "websiteUrl": "https://techcorp.com",
  "message": "Interested in partnership opportunities",
  "urgency": "medium",
  "consent": true
}

Success Response (200)

{
  "success": true,
  "message": "Business contact form submitted successfully",
  "data": {
    "referenceId": "BIZ-1698765432000",
    "debugId": "1698765432000-a1b2c3d4",
    "submittedAt": "2025-10-26T10:30:32.000Z",
    "processingTime": 312,
    "estimatedResponseTime": "24-48 hours"
  }
}

Rate Limiting

2 requests per hour per email address

GET /health

Check server health and status.

Response (200)

{
  "status": "healthy",
  "timestamp": "2025-10-26T10:30:32.000Z",
  "environment": "production"
}

GET /api

List all available API routes.

Response (200)

{
  "message": "API Routes",
  "version": "1.0.0",
  "availableRoutes": [
    "GET /api",
    "GET /api/example",
    "POST /api/forms/contact",
    "POST /api/forms/business-contact",
    "POST /api/forms/business-inquiry"
  ]
}

Standard Error Format

All errors follow this format:

{
  "error": {
    "message": "Error description",
    "code": "ERROR_CODE",
    "status": 400,
    "debugId": "1698765432000-a1b2c3d4"
  }
}

Common Error Codes

JavaScript (Fetch API)

async function submitContactForm(formData) {
  try {
    const response = await fetch('https://your-backend.com/api/forms/contact', {
      method: 'POST',
      headers: {
        'Content-Type': 'application/json',
      },
      body: JSON.stringify(formData)
    });

    const result = await response.json();

    if (response.ok) {
      console.log('Success:', result.data.referenceId);
      return result;
    } else {
      console.error('Error:', result.error.message);
      throw new Error(result.error.message);
    }
  } catch (error) {
    console.error('Network error:', error);
    throw error;
  }
}

cURL

curl -X POST https://your-backend.com/api/forms/contact \
  -H "Content-Type: application/json" \
  -d '{
    "name": "John Doe",
    "email": "john@example.com",
    "subject": "Question",
    "message": "Hello",
    "consent": true
  }'

Axios (Node.js)

const axios = require('axios');

async function submitForm(data) {
  try {
    const response = await axios.post(
      'https://your-backend.com/api/forms/contact',
      data,
      {
        headers: {
          'Content-Type': 'application/json'
        }
      }
    );

    console.log('Submitted:', response.data.data.referenceId);
    return response.data;
  } catch (error) {
    if (error.response) {
      console.error('Error:', error.response.data.error.message);
    } else {
      console.error('Network error:', error.message);
    }
    throw error;
  }
}

• ✓
  Always Validate on Frontend

  Validate user input before sending to reduce errors and improve UX
• ✓
  Handle Errors Gracefully

  Display user-friendly error messages and provide clear next steps
• ✓
  Store Debug IDs

  Save the debugId from responses for troubleshooting and support
• ✓
  Respect Rate Limits

  Implement client-side throttling and display countdown timers
• ✓
  Use HTTPS

  Always use HTTPS in production to protect sensitive data