Britixo CRMBritixo CRMEnterprise Help Centre
Ctrl K
Setup, administrator access and schema readiness

Activate the API Gateway

Follow this guide to run install.php and verify module tables and Utilities/Tools child menu. The guide then takes you through the correct route, the checks to complete before making changes, the workflow in order, and the evidence to review afterwards.

Audience: CRM administrators, integration developers, external portal backend teams and security reviewersPermission: AdministratorModule v1.0.0
Jump to steps
Where to goAdmin Area → Setup → Modules → Proplix API Gateway → Activate
Before you start
  • Verify the module is active and use the exact navigation shown above.
  • Use an account with the stated module and core CRM permissions.
  • Use known test records when changing statuses, visibility, saved filters or global navigation.

What you’ll accomplish

Run install.php and verify module tables and Utilities/Tools child menu. The instructions below follow the supplied module’s live menu, controller, form, model and JavaScript flow.

Follow these steps

  1. Go to Admin Area → Setup → Modules → Proplix API Gateway → Activate.
  2. Find the record, endpoint, field or action used to activate the api gateway.
  3. Complete the displayed values exactly as described in this guide.
  4. Select the available save, submit, send, upload, create, update or confirm action.
  5. Return to the related register, portal, activity log or API response and verify the expected result.

Fields and options to review

Workspace or endpointAdmin Area → Setup → Modules → Proplix API Gateway → Activate
PurposeRun install.php and verify module tables and Utilities/Tools child menu.

Rules the system enforces

  • The action is available only where the supplied module exposes it and the signed-in user or API client meets the stated access conditions.
  • Internal helpers are documented under the visible workflow or endpoint they support rather than presented as invented menu pages.

How to confirm it worked

  • The activate the api gateway workflow completes without a validation, permission, ownership or availability error.
  • The related record, portal view, activity entry, notification log or API response shows the expected state.
  • Client-visible, public and API data remains limited to the code-backed ownership and visibility rules.

Security, privacy and operational checks

  • Use controlled test records and non-production credentials before wider rollout.
  • Grant least privilege and protect secure links, personal data, uploaded files, signatures, API tokens, allowed origins and server IPs.
Check the CRM requirementOpen API GatewaySetup, administrator access and schema readinessBrowse all Proplix Secure API Gateway guidesEnterprise integrationsClient portal overviewApply API request throttlingUnderstand one-way API-token storageManage API-token lifecycle metadataData, privacy and security