Proplix Secure API Gateway
Configure the visible Client Portal API, authenticate external backends, expose only authorised client sections, use supported module adapters and understand the advanced generic v1/v2 resource framework.
Browse Proplix Secure API Gateway by workflow
Start with the area that matches the actual menu, report, saved template, permission, navigation change or issue in the CRM.
Setup, administrator access and schema readiness
Activate the gateway, use the Utilities/Tools child menu and resolve schema readiness without inventing a root menu or bespoke permission.
Client Portal API profiles and one-time tokens
Create, secure, review and revoke one token per external portal with sections, domain, server IP and rate limits.
Master-token and short-lived client sessions
Exchange a private master token for a signed client session and validate TTL, identity, IP and rate limits.
Portal login, registration and password reset
Use code-backed email/password login, client registration and forgotten-password endpoints.
Client data sections and pagination
Fetch only the selected profile, contact, invoice, payment, estimate, proposal, project, ticket, contract, file and subscription data.
Automatic enabled-module adapters
Use installed adapters for Service Journeys, Licence Applications, Compliance Monitor, HMO Manager and Real Estate Management.
Service Journey API workspaces
Fetch owned journey records and related client-visible activities, tasks, messages and documents.
Property, tenancy and compliance workspaces
Fetch linked properties, tenancies, compliance summaries, property requests, maintenance and authorised certificates.
Protected document upload and download
Upload and download authorised client evidence with strict extension, MIME, ownership, visibility, path and size checks.
Advanced generic API v1 sources and keys
Understand source definitions, one-way keys and filtered table access exposed by controller/model capabilities.
Advanced generic API v2 resources and profiles
Understand module resources, public/restricted modes, profiles, scopes, safe columns and bounded queries.
Security, one-way tokens, IP and rate controls
Protect master tokens, signed sessions, server IPs, domains, sensitive fields and request limits.
Request logs, response codes and troubleshooting
Interpret logs and resolve methods, credentials, ownership, section, resource, rate, schema and file failures.
Deployment, compatibility routes and limitations
Implement server-side integration, understand visible versus advanced UI coverage and verify production behaviour.