API Documentation

Revolutionary PDF Processing API

Fill any PDF form without PDFtk dependencies. Pure PHP implementation with guaranteed results.

🔐 Authentication

All API requests require authentication using Bearer tokens:

curl -X POST https://api.mayapdffiller.com/pdf/fill \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

POST /api/pdf/fill

Fill PDF form with provided data

Request Body:
{
  "template_pdf": "base64_encoded_pdf_content",
  "data": {
    "customer_name": "Maya Inc",
    "invoice_date": "01/15/2024",
    "invoice_number": "INV-2024-001",
    "items": [
      {
        "description": "WebPrint Pro License",
        "quantity": 1,
        "price": 30.00
      }
    ],
    "total_amount": "$30.00"
  },
  "format": "json",
  "options": {
    "method": "merge_if_possible_else_generate",
    "return_base64": true
  }
}
Response:
{
  "success": true,
  "filled_pdf": "base64_encoded_completed_pdf",
  "method_used": "direct_merge",
  "processing_time": "0.8s",
  "file_size": 245760,
  "timestamp": "2024-01-15T10:30:00Z"
}
Parameters:
Parameter Type Required Description
template_pdf string Yes Base64 encoded PDF template
data object Yes Form data to fill
format string No Data format: json, xml, csv, dbf, excel, form-data
options object No Processing options

POST /api/pdf/analyze

Extract form fields from PDF template

Request Body:
{
  "template_pdf": "base64_encoded_pdf_content",
  "extract_options": {
    "include_positions": true,
    "include_types": true,
    "export_formats": ["json", "xml", "csv"]
  }
}
Response:
{
  "success": true,
  "form_fields": [
    {
      "name": "customer_name",
      "type": "text",
      "required": true,
      "max_length": 100,
      "position": {"x": 120, "y": 200, "width": 200, "height": 20}
    },
    {
      "name": "invoice_date",
      "type": "date",
      "format": "MM/DD/YYYY",
      "position": {"x": 350, "y": 200, "width": 100, "height": 20}
    }
  ],
  "total_fields": 15,
  "processing_time": "0.3s"
}

GET /api/usage

Get current usage statistics

Response:
{
  "success": true,
  "usage": {
    "current_month": {
      "pdfs_processed": 245,
      "remaining": 755,
      "limit": 1000
    },
    "subscription": {
      "plan": "starter",
      "status": "active",
      "next_billing": "2024-02-15"
    },
    "rate_limit": {
      "requests_this_hour": 15,
      "hourly_limit": 1000
    }
  }
}

⚠️ Error Handling

All errors return a consistent format:

{
  "success": false,
  "error": "Invalid API key",
  "error_code": "AUTH_INVALID",
  "timestamp": "2024-01-15T10:30:00Z"
}
Common Error Codes:
Code HTTP Status Description
AUTH_INVALID 401 Invalid or missing API key
QUOTA_EXCEEDED 429 Monthly quota exceeded
RATE_LIMITED 429 Too many requests per hour
INVALID_PDF 400 Invalid or corrupted PDF file
PROCESSING_FAILED 500 PDF processing error

🚦 Rate Limits

Plan Requests/Hour Monthly PDFs Price
Free Trial 100 100 Free
Starter 1,000 1,000 $29.99
Business 5,000 5,000 $69.99
Professional 10,000 10,000 $99.99
Enterprise 50,000 Unlimited $199.99

📊 Supported Data Formats

✅ Core Formats (Available Now)
  • JSON - Modern web APIs Ready
  • XML - Enterprise systems Ready
  • CSV - Spreadsheet data Ready
🚀 Professional Formats (Available Now)
  • DBF - xBase/dBase systems Pro
  • Excel - .xlsx spreadsheets Pro
  • Form-Data - HTTP multipart Pro
⚡ On-Demand Formats (24hr Implementation)
  • YAML - DevOps configs 24hr
  • Protobuf - Google services 24hr
  • TOML - Rust configs 24hr
  • EDI/EDIFACT - Business transactions 24hr
  • Fixed-Width - Mainframe data 24hr
💰 On-Demand Implementation:
$99 setup fee + regular usage charges
Contact sales for custom enterprise formats
📝 Format Examples
{
  "format": "json",
  "data": {
    "customer_name": "Maya Inc",
    "invoice_date": "2024-01-15",
    "items": [
      {"description": "Service", "amount": 100.00}
    ]
  }
}
{
  "format": "dbf",
  "data": {
    "dbf_file": "base64_encoded_dbf_content",
    "record_mapping": {
      "CUSTNAME": "customer_name",
      "INVDATE": "invoice_date", 
      "AMOUNT": "total_amount"
    }
  }
}
Perfect for xHarbour, Clipper, and FoxPro systems 
{
  "format": "excel",
  "data": {
    "excel_file": "base64_encoded_xlsx_content",
    "sheet_name": "InvoiceData",
    "header_row": 1,
    "column_mapping": {
      "A": "customer_name",
      "B": "invoice_date",
      "C": "total_amount"
    }
  }
}
Direct Excel file processing for business users 
POST /api/pdf/fill
Content-Type: multipart/form-data
Authorization: Bearer YOUR_API_KEY

--boundary
Content-Disposition: form-data; name="template_pdf"; filename="invoice.pdf"
Content-Type: application/pdf

[PDF file content]
--boundary
Content-Disposition: form-data; name="customer_name"

Maya Inc
--boundary
Content-Disposition: form-data; name="total_amount"

$1,250.00
Standard HTML form submissions

🛠️ SDK Examples

JavaScript/Node.js

const MayaPdfFiller = require('maya-pdf-filler');

const client = new MayaPdfFiller('YOUR_API_KEY');

const result = await client.fillPdf({
  template: fs.readFileSync('template.pdf'),
  data: {
    customer_name: 'Maya Inc',
    invoice_total: '$1,250.00'
  }
});

fs.writeFileSync('filled.pdf', result.pdfBuffer);

PHP

$client = new MayaPdfFiller('YOUR_API_KEY');

$result = $client->fillPdf([
    'template_pdf' => base64_encode(file_get_contents('template.pdf')),
    'data' => [
        'customer_name' => 'Maya Inc',
        'invoice_total' => '$1,250.00'
    ]
]);

file_put_contents('filled.pdf', base64_decode($result['filled_pdf']));

Python

from maya_pdf_filler import MayaPdfFiller

client = MayaPdfFiller('YOUR_API_KEY')

with open('template.pdf', 'rb') as f:
    result = client.fill_pdf(
        template=f.read(),
        data={
            'customer_name': 'Maya Inc',
            'invoice_total': '$1,250.00'
        }
    )

with open('filled.pdf', 'wb') as f:
    f.write(result['pdf_bytes'])