api.md

API Reference

← Back to Main Documentation

Table of Contents

1. Authentication
2. Equipment API
   • Log Equipment Use
   • Process Payment
3. Resource API
   • Create Resource
   • Transfer Resource
4. Board API
   • Create Workflow
   • Update Stage
5. Error Responses
6. Rate Limiting

Authentication

↑ Back to Top

POST /api/auth/token/
Content-Type: application/json

{
    "username": "user",
    "password": "pass"
}

Response:

{
    "token": "9944b09199c62bcf9418ad846dd0e4bbdfc6ee4b"
}

Equipment API

↑ Back to Top

Log Equipment Use

POST /api/equipment/log-use/
Authorization: Token <token>
Content-Type: application/json

{
    "equipment_id": "123",
    "hours": 2.5,
    "technician_id": "456",
    "notes": "Regular use"
}

Process Payment

POST /api/equipment/payment/
Authorization: Token <token>
Content-Type: application/json

{
    "use_id": "789",
    "payment_method": "cash",
    "amount": 50.00
}

Resource API

↑ Back to Top

Create Resource

POST /api/resources/
Authorization: Token <token>
Content-Type: application/json

{
    "type": "herb",
    "quantity": 100,
    "unit": "kg",
    "location": "warehouse-1"
}

Transfer Resource

POST /api/resources/transfer/
Authorization: Token <token>
Content-Type: application/json

{
    "resource_id": "123",
    "to_location": "warehouse-2",
    "quantity": 50
}

Board API

↑ Back to Top

Create Workflow

POST /api/boards/workflow/
Authorization: Token <token>
Content-Type: application/json

{
    "name": "Herb Processing",
    "stages": ["drying", "packaging", "storage"]
}

Update Stage

PUT /api/boards/stage/{stage_id}/
Authorization: Token <token>
Content-Type: application/json

{
    "status": "completed",
    "notes": "Process finished"
}

Error Responses

↑ Back to Top

401 Unauthorized

{
    "detail": "Invalid token"
}

404 Not Found

{
    "detail": "Resource not found"
}

400 Bad Request

{
    "error": "Invalid input",
    "details": {
        "field": ["Error message"]
    }
}

Rate Limiting

↑ Back to Top

• 1000 requests per hour per user
• Rate limit headers included in response:

  X-RateLimit-Limit: 1000
  X-RateLimit-Remaining: 999
  X-RateLimit-Reset: 1609459200