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.

12 connected guidesLive filterPermission-aware instructions
12 guides
Category

Proplix Secure API Gateway

Open guide →
Guide

Understand the Proplix Secure API Gateway

Review the visible Client Portal API flow, short-lived sessions, client data, module workspaces, documents and advanced generic APIs.

Open guide →
Guide

Check the CRM requirement

Confirm the module targets CRM 2.3.*.

Open guide →
Guide

Activate the API Gateway

Run install.php and verify module tables and Utilities/Tools child menu.

Open guide →
Guide

Open API Gateway

Use the child item under Utilities or Tools; no separate root sidebar item is registered.

Open guide →
Guide

Understand administrator access

The administrator controller requires is_admin(); the source registers no bespoke staff capability.

Open guide →
Guide

Understand the Portal API schema check

The page checks profile_type and allowed_sections fields before enabling profile creation.

Open guide →
Guide

Resolve Portal API schema pending

Deactivate and reactivate the module so install.php creates or updates module-owned fields.

Open guide →
Guide

Understand the five module tables

Sources, keys, logs, resources and profiles store visible and advanced API configuration/evidence.

Open guide →
Guide

Understand admin-only gateway assets

The module CSS loads only on admin/proplix_api_gateway routes.

Open guide →
Guide

Understand menu portability

The child is registered under both internal utilities and tools parent slugs for theme portability.

Open guide →
Guide

Verify initial installation

Open the page, confirm schema readiness, create a test portal profile and call session/me from a server-side test client.

Open guide →