API Integration Manager Module for Perfex CRM

Note: This is a add-on module for Perfex CRM. It is not a standalone script and requires Perfex CRM to function.

Overview

The API Integration Manager (AIM) Module for Perfex CRM delivers a complete no-code framework for connecting external APIs, automating data exchange, and building dynamic API-driven forms inside your CRM. With its visual builder and flexible configuration options, administrators can send data to APIs, fetch and display external records, map parameters, and create advanced workflows — all without writing a single line of code.

AIM supports both Send Forms and Receive Forms, allowing teams to design submission forms, generate list views powered by API responses, build dynamic edit forms, and prefill fields directly from external systems. It handles JSON, Form-URL-Encoded, and Multipart requests, file uploads, structured parameters (path, query, body), authentication and custom headers, and custom response processing — making it compatible with almost any REST API.

Each form operates independently or can be linked together to create multistep workflows such as add → list → edit → update cycles.

The module comes with full Import & Export capabilities, allowing you to export any API configuration as a clean JSON file and import it instantly into another Perfex installation. This makes it extremely easy to transfer forms between environments, clone setups, or share configurations across projects without rebuilding anything manually.

The module integrates seamlessly with Postman, offering a fully Postman-friendly workflow. You can import existing Postman collections directly into the system to instantly recreate endpoints, headers, parameters, and body configurations without manual re-entry.

Likewise, API configurations created inside the module can be exported and imported into Postman for advanced testing and debugging. This two-way import/export capability ensures smooth collaboration between development and CRM environments, making it easy to test endpoints in Postman and deploy them inside Perfex CRM with complete accuracy.

Designed for Perfex CRM (v3.1.0 and above), AIM installs effortlessly, requires no core file changes, and blends perfectly into the existing UI. With clean permissions, logging options, a unified form builder, and fully dynamic parameter mapping, the module provides a powerful and future-proof integration layer right inside Perfex CRM.

Demo

Admin Login: https://perfex.codeonstring.com/admin
Email: admin@example.com
Password: 123456789

Staff Login: https://perfex.codeonstring.com/admin
Email: staff@example.com
Password: 123456789

How to Use

• Navigate to the API Integration Manager section from the Perfex CRM admin sidebar.
• Create a new form and select whether it will be a Send Form (submit data to an API) or a Receive Form (fetch and display API data).
• Configure your endpoint, method, headers, and parameter mappings (path, query, or body) based on your API requirements.
• Build your form fields using the visual builder — including text inputs, selects, checkboxes, files, and more.
• If creating a Receive Form, choose the display mode (Table or Edit Form) and optionally map an Edit or Update API.
• Save the form and access it directly from the sidebar (if enabled) or embed it into your CRM workflow.
• Users can view API-fetched data in tables, open edit pages, or submit new entries depending on the configuration.
• Admins can manage API forms, adjust mappings, review logs, and modify workflows anytime without touching code.

Important Notes:

• Please test the module thoroughly before purchasing to ensure it matches your integration needs.
• Feel free to ask any questions — this is a highly advanced module, and we are happy to clarify any technical details.
• In the demo version, header keys are intentionally hidden for security reasons.

Features

• Seamless integration with Perfex CRM (v3.1.0 and above)
• Perfex-native interface with zero core file modifications
• Create and manage unlimited API-based forms
• Supports both Send Forms (submit to API) and Receive Forms (fetch from API)
• Dynamic table view and edit form view for Receive forms
• Automatic field prefill for edit/update forms using API response data
• Fully visual form builder with support for:
  • Text, number, email, date
  • Select, radio, checkbox
  • Textarea fields
  • File uploads (Multipart / Base64)
• Complete Import & Export support:
  • Export API configuration as JSON
  • Import configurations from JSON
  • Perfect for transferring between environments or sharing setups
• Works flawlessly with Postman:
  • Export API configuration into Postman-ready structure
  • Use Postman to test endpoints before importing into the module
  • Match headers, body types, and parameters exactly like Postman
• Dynamic endpoint parameter mapping: path parameters, query parameters, and body parameters
• Flexible body formats: JSON, Form-URL-Encoded, Multipart
• Custom header support — including Bearer Tokens, API Keys, and Authorization headers
• Auto-generated field names from labels for consistent API mapping
• Ability to map Receive Table rows to Edit forms via dynamic URLs
• Built-in API execution engine for sending/receiving data
• Optional Response Logs for debugging real API traffic
• Editable root path selector to target nested API response objects
• Public form support with optional Google reCAPTCHA
• Permission control for Staff
• Server-side logging of API errors with status codes and raw responses
• API Error Logging:
  • Status Codes, Errors, Raw Responses
  • Useful for debugging and API monitoring
• Fast installation with no dependencies — fully modular and update-safe

What’s Included

• API Integration Manager Module
• Documentation
• Free lifetime updates and 6 months support

Requirements

• Perfex CRM version 3.1.0 or higher

Documentation

For detailed instructions on installation and configuration, please refer to the online documentation at: https://perfex.codeonstring.com/aim-documentation

Support

Comprehensive documentation is included. For further assistance, feel free to reach out to us at codeonstring@gmail.com

Change Log

 Version 1.0.0     - Initial Release