api

API Documentation

WFM Archive provides a comprehensive REST API for document management operations and system integration.

Quick Links

• REST Endpoints - Complete API reference
• Authentication - Security and authentication setup
• Examples - Practical usage examples
• Error Codes - Error handling guide

API Overview

Base URL

Development: http://localhost:8080/api
Production: https://wfmarchive.yourdomain.com/api

Authentication

The API uses JWT tokens for authentication. See Authentication Guide for details.

Content Types

• Request: application/json
• Response: application/json
• File Upload: multipart/form-data
• File Download: application/octet-stream

Available APIs

Document Management API

Core operations for document archiving and retrieval:

• Archive documents with metadata
• Retrieve documents by ID
• Search documents
• Delete documents
• Bulk operations

Administrative API

System configuration and management:

• User management
• Organization management
• Document type configuration
• Workflow management

Integration API

External system integration endpoints:

• Webhook endpoints
• Event notifications
• Data synchronization

Quick Start

1. Authenticate

curl -X POST https://api.example.com/auth/login \
  -H "Content-Type: application/json" \
  -d '{"username":"user","password":"pass"}'

2. Archive a Document

curl -X POST https://api.example.com/documents/default/A10 \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -F "documenttype=INVOICE" \
  -F "metadata={\"invoiceNumber\":\"INV-001\"}" \
  -F "file=@invoice.pdf"

3. Retrieve a Document

curl -X GET https://api.example.com/documents/default/A10/DOC123 \
  -H "Authorization: Bearer YOUR_TOKEN"

API Standards

HTTP Methods

• GET: Retrieve resources
• POST: Create new resources
• PUT: Update existing resources
• DELETE: Remove resources
• PATCH: Partial updates

Response Codes

• 200 OK: Successful operation
• 201 Created: Resource created
• 400 Bad Request: Invalid input
• 401 Unauthorized: Authentication required
• 403 Forbidden: Access denied
• 404 Not Found: Resource not found
• 500 Internal Server Error: Server error

Pagination

{
  "data": [...],
  "pagination": {
    "page": 1,
    "pageSize": 20,
    "totalItems": 100,
    "totalPages": 5
  }
}

Rate Limiting

API requests are rate-limited to ensure fair usage:

• Default: 1000 requests per hour
• Bulk Operations: 100 requests per hour
• File Upload: 500 requests per hour

Next Steps

• Read the REST Endpoints reference
• Learn about Authentication
• Try the API Examples