Category

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.

14 connected guidesLive filterPermission-aware instructions
14 guides
Workflow

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.

Open guide →
Workflow

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.

Open guide →
Workflow

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.

Open guide →
Workflow

Portal login, registration and password reset

Use code-backed email/password login, client registration and forgotten-password endpoints.

Open guide →
Workflow

Client data sections and pagination

Fetch only the selected profile, contact, invoice, payment, estimate, proposal, project, ticket, contract, file and subscription data.

Open guide →
Workflow

Automatic enabled-module adapters

Use installed adapters for Service Journeys, Licence Applications, Compliance Monitor, HMO Manager and Real Estate Management.

Open guide →
Workflow

Service Journey API workspaces

Fetch owned journey records and related client-visible activities, tasks, messages and documents.

Open guide →
Workflow

Property, tenancy and compliance workspaces

Fetch linked properties, tenancies, compliance summaries, property requests, maintenance and authorised certificates.

Open guide →
Workflow

Protected document upload and download

Upload and download authorised client evidence with strict extension, MIME, ownership, visibility, path and size checks.

Open guide →
Workflow

Advanced generic API v1 sources and keys

Understand source definitions, one-way keys and filtered table access exposed by controller/model capabilities.

Open guide →
Workflow

Advanced generic API v2 resources and profiles

Understand module resources, public/restricted modes, profiles, scopes, safe columns and bounded queries.

Open guide →
Workflow

Security, one-way tokens, IP and rate controls

Protect master tokens, signed sessions, server IPs, domains, sensitive fields and request limits.

Open guide →
Workflow

Request logs, response codes and troubleshooting

Interpret logs and resolve methods, credentials, ownership, section, resource, rate, schema and file failures.

Open guide →
Workflow

Deployment, compatibility routes and limitations

Implement server-side integration, understand visible versus advanced UI coverage and verify production behaviour.

Open guide →