Introduction
Overview of the Total Access platform, modules, and developer tools.
Introduction
Total Access is an integrated business platform with 15+ modules covering finance, automation, CRM, workforce management, fleet, communications, and more. The developer portal gives you programmatic access to all of it.
Platform architecture
Total Access runs on a microservices architecture:
| Service | Technology | Purpose |
|---|---|---|
| Next.js frontend | Next.js 16, React 19, Tailwind CSS | Client zone, marketing pages, admin hub |
| Fastify API gateway | Node.js, Fastify | REST API, authentication, rate limiting |
| WebSocket server | Node.js, ws | Real-time notifications, live updates |
| PostgreSQL | PostgreSQL 17.5 | Primary database (double-entry ledger, CRM, HR data) |
| MongoDB | MongoDB 7.0 | Document storage, audit logs, analytics |
| Haraka email server | Haraka + LMTP | Inbound/outbound email processing, DKIM signing |
| FreeSWITCH | FreeSWITCH + Docker | VoIP, SIP trunking, call recording |
| LiveKit | LiveKit + SIP bridge | WebRTC, real-time audio/video |
| BullMQ | Node.js + Redis | Background job queue (video rendering, email processing) |
| Cloud storage | Node.js + NAS NFS | File uploads, cold storage mirror |
| Secret manager | Node.js + AES-256 | Centralized secret storage with rotation |
| Firewall manager | Node.js + iptables/ipset | SIP protection, fail2ban, threat intel feeds |
Modules
| Module | Key | Description |
|---|---|---|
| Total Finance | finance | Invoicing, bills, payments, bank reconciliation, SARS VAT, accounting export |
| Total Operations | operations | Jobs, tasks, projects, work items, SLA tracking |
| Total CRM | connect | Contacts, deals, pipelines, leads, complaints |
| Total Workforce | hr | Employees, departments, leave, training, performance |
| Time & Attendance | time_attendance | Clock in/out, shifts, geofences, biometrics, timesheets |
| Total Fleet | fleet | Vehicles, routes, deliveries, fuel, travel |
| Total Inventory | inventory | Products, stock movements, warehouses, assets |
| Total Forms | forms | Form builder, submissions, surveys, polls, PDF generation |
| Total Integration | all | Webhooks, API keys, automations, WhatsApp, IoT |
| Total Automation | — | Document capture, AI extraction, supplier matching |
| Total AI | — | AI operations, specialized participants, thread solutions |
Integration options
| Method | Use case | Auth | Docs |
|---|---|---|---|
| REST API | CRUD operations on any module | API key or JWT | API Reference |
| Outbound Webhooks | Receive events when data changes | HMAC / Bearer / Basic | Webhooks |
| Inbound Webhooks | Push data into Total Access from external systems | API key / HMAC | Webhooks |
| Public Data API | Expose specific data to external apps | API key (X-API-Key) | Public Data API |
| AI Agent & MCP Bridge | Expose Total Access actions to AI agents via MCP | API key (X-API-Key) | AI Agent & MCP Bridge |
| WhatsApp Integration | Send/receive WhatsApp messages | WhatsApp Business API / QR | WhatsApp Guide |
| Accounting Export | Sync to Xero / QuickBooks / Sage | OAuth / API key | Accounting Export |
Authentication
Total Access supports two authentication methods:
- API Keys — Long-lived tokens for server-to-server integrations. Scoped to specific modules. Generate from the Total Integration module. See API Keys.
- JWT tokens — Short-lived access tokens (15 min) with refresh tokens (7 days). Single-use refresh with reuse detection. Use for user-facing applications. See Authentication.
Environments
| Environment | Sandbox URL | Live API URL | Frontend URL |
|---|---|---|---|
| Production | https://developer.totalaccess.co.za/api/v1 | https://totalaccess.co.za/api/v1 | https://app.totalaccess.co.za |
| Development | https://dev-developer.totalaccess.co.za/api/v1 | https://dev-next.totalaccess.co.za/api/v1 | https://dev-next.totalaccess.co.za |
Rate limiting
| Tier | Requests/min | Burst |
|---|---|---|
| Free | 60 | 100 |
| Business | 200 | 300 |
| Professional | 500 | 750 |
| Enterprise | Custom | Custom |
Rate limit headers are included in every response:
X-RateLimit-Limit: 200
X-RateLimit-Remaining: 187
X-RateLimit-Reset: 1700000000Need higher limits? Contact your account manager or upgrade your plan.
Next steps
- Architecture — Deep-dive into the platform infrastructure
- Authentication — API keys, JWT tokens, and scopes
- Webhooks — Real-time event notifications
- Event Catalog — Complete list of all webhook events
- Guides — Step-by-step integration tutorials
Postman collection
A pre-built Postman collection is available, auto-generated from the OpenAPI spec. It includes all endpoints organized by module, pre-configured request bodies, test scripts, and environment variable templates.
Download:
Quick start:
- Download the collection and environment files above
- Import both into Postman (File → Import)
- Select the environment (Production or Sandbox)
- Set your
api_keyvariable in the environment - Start exploring the API endpoints
The Postman collection is auto-regenerated from the OpenAPI spec on every change, so it's always up to date.