Search Knowledge Base Articles

Enterprise API Gateway — How to Install

← Back to Enterprise API Gateway overview

How to Install — Enterprise API Gateway

Module folder: modules/enterprise_api_gateway/   Version: v1.0.0

Centralized enterprise API gateway for Perfex CRM — API consumers, keys, route registry, request logging, and unified external access

Before you begin

  • Backup your database (Setup → Backup or your host backup tool).
  • Use a staff account with Modules / Settings access.
  • PHP version and Perfex CRM version should match the module README requirements when listed.
  • Keep the module folder name exactly enterprise_api_gateway.

Step-by-step installation

  1. Upload the enterprise_api_gateway folder into your CRM modules/ directory (FTP, cPanel, or Setup → Modules → Upload when available).
  2. Log in to Admin.
  3. Go to Setup → Modules.
  4. Find Enterprise API Gateway and click Activate (or Upgrade if already installed).
  5. Wait for migrations/tables to finish — do not refresh mid-activation.
  6. Go to Setup → Staff → Roles and assign permissions for this module.
  7. Open Enterprise API Gateway → Settings and save defaults.

Install notes from README

Installation

  1. Upload the enterprise_api_gateway folder to modules/ in your Perfex CRM installation.
  2. Go to Setup → Modules and activate Enterprise API Gateway.
  3. Assign capabilities under Setup → Staff → Roles.

Uninstall

Deactivate the module, then use Uninstall from Setup → Modules. All module tables, options, and files under uploads/enterprise_api_gateway/ are removed.

After activation — configuration checklist

  1. Go to Setup → Modules and activate Enterprise API Gateway.
  2. If prompted, click Upgrade Database or reload admin — migrations run automatically.
  3. Assign permissions under Setup → Staff → Roles.
  4. Open the sidebar menu API Gateway and configure Settings.
  5. Perfex CRM 2.3+ (3.x recommended)
  6. PHP 7.4+ (8.1+ recommended)
  7. MySQL 5.7+ / MariaDB 10.3+ (InnoDB)
  8. PHP extensions: mysqli, json, mbstring, curl, fileinfo
  9. Perfex cron configured (recommended)

Official documentation — Installation

Installation

  1. Upload the enterprise_api_gateway folder to modules/ in your Perfex CRM installation.
  2. Go to Setup → Modules and activate Enterprise API Gateway.
  3. If prompted, click Upgrade Database or reload admin — migrations run automatically.
  4. Assign permissions under Setup → Staff → Roles.
  5. Open the sidebar menu API Gateway and configure Settings.

No core CRM files are modified. All tables and options are created on activation (DB schema 100).

Requirements

  • Perfex CRM 2.3+ (3.x recommended)
  • PHP 7.4+ (8.1+ recommended)
  • MySQL 5.7+ / MariaDB 10.3+ (InnoDB)
  • PHP extensions: mysqli, json, mbstring, curl, fileinfo
  • Perfex cron configured (recommended)

Staff permissions (from module)

Assign under Setup → Staff → Roles. Each feature can expose different actions:

FeatureActions
Gateway Dashboard
eag_dashboard		view
API Consumers
eag_consumers		view, create, edit, delete
API Keys
eag_api_keys		view, create, edit, delete
Routes
eag_routes		view, create, edit, delete
Request Logs
eag_request_logs		view, delete
Webhooks
eag_webhooks		view, create, edit, delete
OAuth Clients
eag_oauth_clients		view, create, edit, delete
Analytics
eag_analytics		view, edit
Bulk Import
eag_import		view, create
Reports
eag_reports		view
Settings
eag_settings		view, edit

Verify installation (checklist)

  1. Setup → Modules shows Enterprise API Gateway as Active.
  2. Admin sidebar shows the Enterprise API Gateway menu for an admin user.
  3. Setup → Staff → Roles lists this module's permission groups.
  4. Opening Enterprise API Gateway → Settings loads without PHP errors.
  5. Creating one sample record succeeds and appears in the list/table.
  6. (If used) Cron-dependent features have Perfex CRM cron enabled on the server.

After install — first actions

  1. Create master data required by this module.
  2. Create one sample record and walk it through approve/complete if applicable.
  3. Train staff using the Quick Start Guide.

Related: Features · Quick Start · FAQ · Version & Changelog

Did you find this article useful?

Related Articles