API Documentation

Comprehensive REST API reference for ARC integration

API Sections

Base URL

https://api.arc-apex.com/v1

Authentication

ARC API uses API keys for authentication. Include your API key in the Authorization header.

curl -H "Authorization: Bearer YOUR_API_KEY" \ -H "Content-Type: application/json" \ https://api.arc-apex.com/v1/reports
Security Note: Keep your API key secure. Never expose it in client-side code.

Reports

GET/reports

Retrieve a list of all reports

Parameters

ParameterTypeDescription
pageintegerPage number (default: 1)
limitintegerItems per page (max: 100)
statusstringFilter by status: active, draft, archived

Response

{
  "reports": [
    {
      "id": "rpt_123",
      "name": "Monthly Sales Report",
      "template_id": "tpl_456", 
      "status": "active",
      "created_at": "2024-01-15T10:30:00Z",
      "updated_at": "2024-01-20T14:22:00Z"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 45,
    "total_pages": 3
  }
}
POST/reports/generate

Generate a new report

Request Body

{
  "template_id": "tpl_456",
  "format": "pdf",
  "parameters": {
    "start_date": "2024-01-01",
    "end_date": "2024-01-31",
    "region": "EMEA"
  },
  "async": true
}

Response

{
  "job_id": "job_789",
  "status": "processing",
  "estimated_completion": "2024-01-20T14:25:00Z",
  "download_url": null
}

SDKs & Libraries

JavaScript/Node.js

Official JavaScript SDK for web and Node.js applications

npm install @arc-apex/sdk
Download SDK →

Python

Python SDK for server-side integrations

pip install arc-apex-sdk
Download SDK →