API Integration Guide

API Integration Guide

The LION Report Tool provides a comprehensive REST API that allows developers to integrate with other applications and services.

Authentication

API requests require authentication using an API key:

Authorization: Bearer lion_your_api_key_here

API keys can be generated in the Company Configuration section by company owners or administrators.

Rate Limits

• Free Plan: 100 requests per day
• Paid Plan: 1,000 requests per hour
• Annual Plan: 1,000 requests per hour

Key Endpoints

Reports

• GET /api/v1/reports - List reports with optional filtering
• GET /api/v1/reports/{report_id} - Get detailed report information
• POST /api/v1/reports/generate - Generate a report from journal entries

Journal Entries

• GET /api/v1/journal/entries - List journal entries with date filtering
• POST /api/v1/journal/entries - Create a new journal entry
• GET /api/v1/journal/entries/{entry_id} - Get a specific journal entry

Users

• GET /api/v1/users - List users in your company
• GET /api/v1/users/{user_id} - Get user details

Training

• GET /api/v1/training - List training records
• GET /api/v1/training/stats - Get training statistics

Webhooks

Configure webhooks to receive notifications about events:

• report.submitted - When a new report is submitted
• report.updated - When a report is modified
• journal.created - When a new journal entry is created
• user.created - When a new user is added

Sample Integration Scenarios

Time Tracking Integration

Use the API to automatically create journal entries based on time tracking data:

1. Export daily activities from your time tracking system
2. Transform the data into journal entry format
3. Use the POST /api/v1/journal/entries endpoint to create entries

Performance Dashboard Integration

Pull report data into your business intelligence platform:

1. Schedule regular API calls to GET /api/v1/reports
2. Extract key metrics from report data
3. Incorporate these metrics into your BI dashboards

API Documentation

Comprehensive API documentation is available at:

https://api.lion.report/docs

The documentation includes interactive examples, request and response schemas, and detailed explanations of all available endpoints.