Skip to content

API Documentation ​

This section covers the API endpoints and integration points for the Imperium Maledictum application.

Overview ​

The application provides RESTful APIs through Cloudflare Workers for cloud synchronization and data management. All API endpoints require token-based authentication.

API Sections ​

Core APIs ​

  • Characters API - CRUD operations for character management
  • Journal API - Managing character journal entries
  • Sync API - Data synchronization between local and cloud storage

Authentication ​

  • Authentication - Token-based authentication system
  • Token management and security best practices

Data Formats ​

  • Data Structures - JSON schemas for characters, journal entries, and equipment
  • Request/response formats
  • Error handling conventions

Quick Start ​

All API requests require an Authorization header:

http
Authorization: Bearer YOUR_TOKEN

Base URL ​

Production: https://imperium-maledictum.workers.dev/api

Common Endpoints ​

  • GET /api/characters - List all characters
  • GET /api/characters/:id - Get specific character
  • POST /api/characters - Create new character
  • PUT /api/characters/:id - Update character
  • DELETE /api/characters/:id - Delete character

Response Format ​

All API responses follow a consistent format:

json
{
  "success": true,
  "data": { ... },
  "error": null
}

Rate Limiting ​

API requests are subject to Cloudflare Workers rate limits. See Rate Limiting for details.