Module: Enterprise API Gateway v1.4.0
Centralized enterprise API gateway for BIXCRM — API consumers, keys, route registry, request logging, and unified external access
Screen-by-screen guides (each tab explained)
Click a menu item below for step-by-step instructions on that Enterprise API Gateway screen:
- Gateway Dashboard
- API Consumers
- API Keys
- Routes
- Request Logs
- Webhooks
- OAuth Clients
- Analytics
- Bulk Import
- Reports
- Settings
- Security
How to use in BIXCRM (daily operations)
- Sign in to the admin area with a role that includes Enterprise API Gateway permissions.
- Open Enterprise Api Gateway (sidebar) or search for Enterprise API Gateway in the admin menu.
- Start on the Dashboard (if available) to see open tasks, pending approvals, and KPIs.
- Review Settings after upgrades — new options may need defaults for your company.
- Create or import master data first; most modules block transactions until masters exist.
- Run the main business flow (create → submit → approve → post/complete) using the screens listed in Admin menu below.
- Use Reports / Analytics screens to reconcile stock, finance, compliance, or SLA metrics.
- For integrations (API, EDI, gateways, tax), confirm credentials in Settings and monitor logs or webhook delivery screens.
- Train staff with role-based access — give approvers approve permissions only, operators create/edit on their area.
- If something fails overnight, check BIXCRM cron ran and open the module log / failed queue screen if present.
Admin menu — where to work
Open the Enterprise API Gateway section in the admin sidebar. Screens your staff may use (depending on role):
- Analytics
- API Consumers
- API Gateway
- API Keys
- Bulk Import
- Developer Portal
- Gateway Dashboard
- OAuth Clients
- Reports
- Request Logs
- Routes
- Security
- Settings
- Webhooks
Detailed guide — features, workflows, API & FAQ
Features Overview
| Phase | Features |
|---|---|
| ------- | ---------- |
| 1 | Consumers, API keys, routes, request logs, gateway REST, dashboard |
| 2 | Rate limiting, IP blocklist, HMAC, key rotation, JSON schema validation |
| 3 | Webhooks, retry queue, dead letter, circuit breaker, CRM events |
| 4 | OAuth2/JWT, v1/v2 versioning, OpenAPI, Swagger UI, sandbox mocks |
| 5 | Developer portal, analytics, SLA monitoring, bulk import, CSV reports |
Phase 5 — Analytics & Enterprise
| Feature | Description |
|---|---|
| --------- | ------------- |
| Developer Portal | Client-area self-service at /clients/eag |
| Analytics | Requests/day, latency percentiles, error rate charts |
| SLA Monitoring | Automated uptime/P95/error checks with email alerts |
| Bulk Import | CSV upload for consumers and routes |
| Reports | Export request logs and consumer usage CSV |
| Multi-tenant | Optional company_id isolation on consumers |
Developer Portal Setup
- Enable in Settings → Developer Portal
- Link consumer to CRM client (
client_id) - Enable Portal self-service on the consumer
- Client logs in → Developer Portal menu appears
Bulk Import CSV Headers
Consumers: consumer_code,consumer_name,environment,client_id,email,rate_limit_per_minute,status,company_id,is_sandbox,portal_self_service
Routes: route_code,route_name,module_name,http_method,gateway_path,target_path,required_scope,version,is_public,is_active
Permissions
| Feature | Capabilities |
|---|---|
| --------- | ------------- |
eag_analytics | view, edit |
eag_import | view, create |
eag_reports | view |
eag_oauth_clients | view, create, edit, delete |
eag_webhooks | view, create, edit, delete |
See [docs/ROADMAP.md](docs/ROADMAP.md) for full phase history.
Features
Centralized enterprise API gateway for BIXCRM — API consumers, keys, route registry, request logging, and unified external access
See README.md in the module folder for the complete feature list.
Permissions
Granular staff capabilities are registered on activation. Assign them under Setup → Staff → Roles for the Enterprise API Gateway capability group.
Typical capabilities include view, create, edit, delete, plus module-specific actions (approve, export, settings, API access).
Cron Jobs
Background tasks (if enabled) run through BIXCRM's main cron. Example crontab (every 5 minutes):
* * * * * php /path/to/bixcrm/index.php cron/index > /dev/null 2>&1
Check module settings for scheduled jobs (alerts, sync, reports, retention).
After activation — configuration checklist
- Go to Setup → Modules and activate Enterprise API Gateway.
- If prompted, click Upgrade Database or reload admin — migrations run automatically.
- Assign permissions under Setup → Staff → Roles.
- Open the module menu and configure settings.
- BIXCRM 3.0+
- PHP 7.4+ (8.1+ recommended)
- MySQL 5.7+ / MariaDB 10.3+ (InnoDB)
- PHP extensions: mysqli, json, mbstring, curl, fileinfo
One-time setup (first time only)
- Setup → Modules → activate Enterprise API Gateway.
- Setup → Staff → Roles → assign Enterprise API Gateway permissions (view, create, edit, delete, approve, export, settings as needed).
- Open Enterprise API Gateway → Settings and complete company defaults, prefixes, integrations, and notification options.
- Create master data (warehouses, products, templates, accounts, routes, etc.) before processing live transactions.
- Enable BIXCRM cron (
php /path/to/bixcrm/index.php cron/index) for sync, retries, alerts, and scheduled jobs. - Optionally enable REST API / webhooks in module settings if you integrate external systems.
BIXCRM Knowledge Base — usage guide generated from module README and documentation.