API Overview

API Overview

The Illustrata API provides endpoints for generating PDF illustrations for various annuity products.

Available Endpoints

PDF Generation

Method	Endpoint	Description
POST	/api/pdf/DemoMYGA	Generate MYGA PDF illustration
POST	/api/pdf/DemoFIA	Generate FIA PDF illustration

System

Method	Endpoint	Description
GET	/health	Check API health and service status

Base URLs

Production: https://api.illustrata.com
Development: http://localhost:3001

Request Format

All POST requests must include:

• Content-Type: application/json header
• Valid JSON body
• Authentication via API key

Response Format

All responses return JSON with this structure:

Success Response

{
  "success": true,
  "message": "Operation successful",
  "data": {
    // Response data
  }
}

Error Response

{
  "error": "Error type",
  "message": "Human-readable error message",
  "details": [
    // Optional validation details
  ]
}

HTTP Status Codes

Code	Description
200	Success
400	Bad Request - Invalid input
401	Unauthorized - Invalid or missing API key
403	Forbidden - Insufficient permissions
429	Too Many Requests - Rate limit exceeded
500	Internal Server Error
503	Service Unavailable

Rate Limiting

• Default: 100 requests per 15-minute window
• Headers included in response:
  • X-RateLimit-Limit: Maximum requests allowed
  • X-RateLimit-Remaining: Requests remaining
  • X-RateLimit-Reset: Time when limit resets

Versioning

The API currently uses URL path versioning. All endpoints are prefixed with /api/.

Future versions will be indicated in the path (e.g., /api/v2/).

Support

For API support, feature requests, or to report issues:

• Contact our support team
• Include your API key prefix (first 8 characters only)
• Provide request/response examples when reporting issues