Portal SDK & PHP Kit

┌──────────────────────────┐      ┌────────────────────────┐
│   PHP Portal Kit         │      │   OptiCRM Core         │
│   (Implementor's code)   │─────▶│   (Your closed code)   │
│                          │ REST │                        │
│   portal.opticrm.app     │ API  │   school.opticrm.app   │
└──────────────────────────┘      └────────────────────────┘
         ↑                                    ↑
   Parent/Student                      Staff/Admin
   browser                            browser

POST https://{slug}.opticrm.app/api/portal/auth
Content-Type: application/json

{
  "slug": "rashtrothana",
  "email": "parent@example.com",
  "password": "their-password"
}

{
  "token": "eyJhbGciOiJIUzI1NiJ9...",
  "expiresIn": "24h",
  "contact": {
    "id": "clx...",
    "firstName": "Rajesh",
    "lastName": "Sharma",
    "email": "parent@example.com",
    "contactType": "CONTACT_PARENT"
  },
  "institution": {
    "id": "clx...",
    "name": "Rashtrothana Vidhya Kendra",
    "slug": "rashtrothana"
  },
  "students": [
    {
      "id": "clx...",
      "firstName": "Aarav",
      "lastName": "Sharma",
      "studentCode": "STU001",
      "relation": "FATHER"
    }
  ]
}

GET https://{slug}.opticrm.app/api/portal/auth
Authorization: Bearer {token}

github.com/hemanthopti/opticrm-portal

git clone https://github.com/hemanthopti/opticrm-portal.git
cd opticrm-portal
cp .env.example .env
# Edit .env — set OPTICRM_DOMAIN=opticrm.app
php -S localhost:8080 -t public
# Open http://localhost:8080

opticrm-portal/
├── public/
│   ├── index.php          ← Front controller (routes all requests)
│   └── .htaccess          ← Apache URL rewriting
├── app/
│   ├── config.php         ← Loads .env, defines constants
│   ├── Router.php         ← Maps URLs to controllers
│   ├── Controller.php     ← Base class (render, redirect, SDK)
│   ├── Middleware.php      ← Session auth check
│   ├── models/
│   │   └── OptiCRM.php    ← SDK (API client, single file)
│   ├── controllers/
│   │   ├── AuthController.php
│   │   ├── DashboardController.php
│   │   ├── FeesController.php
│   │   ├── AttendanceController.php
│   │   ├── TimetableController.php
│   │   ├── ResultsController.php
│   │   ├── ProfileController.php
│   │   ├── GrievanceController.php
│   │   └── AnnouncementController.php
│   └── views/
│       ├── layout.php     ← Base layout (header + sidebar + content)
│       ├── dashboard.php
│       ├── fees.php
│       ├── attendance.php
│       └── partials/
│           ├── header.php
│           ├── sidebar.php
│           └── student-picker.php
├── .env.example
├── Dockerfile             ← For Docker/Coolify deployment
└── README.md

OPTICRM_DOMAIN=opticrm.app
APP_NAME=OptiCRM Portal
APP_PRIMARY_COLOR=#2563eb

// Authentication
$result = $this->crm->login($email, $password);
$valid = $this->crm->verify();
 
// Student data
$fees = $this->crm->getFees($studentId);
$attendance = $this->crm->getAttendance($studentId);
$timetable = $this->crm->getTimetable($studentId);
$results = $this->crm->getResults($studentId);
$transport = $this->crm->getTransport($studentId);
$health = $this->crm->getHealth($studentId);
 
// Portal actions
$this->crm->submitGrievance(['title' => '...', 'description' => '...']);
$this->crm->changePassword($currentPassword, $newPassword);
$this->crm->updateProfile(['mobile' => '9876543210']);
 
// OptiQL queries
$result = $this->crm->query("SELECT firstName, lastName FROM Student LIMIT 10");
 
// Generic API calls
$data = $this->crm->get('/api/portal/any-endpoint', ['param' => 'value']);
$result = $this->crm->post('/api/portal/any-endpoint', ['key' => 'value']);

// In the view (my-form.php):
<form method="POST" action="/my-form">
    <input type="text" name="title" placeholder="Title" required>
    <textarea name="description" placeholder="Description"></textarea>
    <button type="submit">Submit</button>
</form>
 
// In the controller:
public function submit(): void
{
    $result = $this->crm->post('/api/portal/grievances', [
        'title' => $_POST['title'],
        'description' => $_POST['description'],
    ]);
 
    if (isset($result['error'])) {
        $_SESSION['flash_error'] = $result['error'];
    } else {
        $_SESSION['flash_success'] = 'Submitted successfully!';
    }
 
    $this->redirect('/my-form');
}

// Any controller can run OptiQL queries
$fees = $this->crm->query("
    SELECT feeHeadName, SUM(paidAmount) as collected, COUNT(id) as count
    FROM Invoice
    WHERE status IN ('PAID', 'PARTIAL')
    GROUP BY feeHeadName
    ORDER BY collected DESC
");
 
$overdue = $this->crm->query("
    SELECT invoiceNo, studentName, totalAmount, dueDate
    FROM Invoice
    WHERE status = 'OVERDUE' AND totalAmount > 1000000
    ORDER BY totalAmount DESC
    LIMIT 20
");

server {
    listen 80;
    server_name portal.yourschool.com;
    root /var/www/opticrm-portal/public;
    index index.php;
 
    location / {
        try_files $uri $uri/ /index.php?$query_string;
    }
 
    location ~ \.php$ {
        fastcgi_pass unix:/var/run/php/php8.1-fpm.sock;
        fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name;
        include fastcgi_params;
    }
}