Introduction

This documentation provides complete guidance on installing, configuring, and using the API Integration Manager (AIM) Module for Perfex CRM. This powerful module allows administrators to connect external APIs, build dynamic forms, map request and response parameters, and automate data exchange — all without writing a single line of code.

Using AIM, you can create flexible Send Forms (to submit data to APIs) and Receive Forms (to fetch, list, and edit data from APIs). The system supports a visual form builder, dynamic endpoint parameters, multiple body formats (JSON, Form-URL-Encoded, Multipart), file uploads, conditional mapping, and API-driven table & edit interfaces. Each form can operate independently or be linked together for advanced workflows.

On the Receive side, the module allows you to display external API data in table format, generate dynamic edit forms, and auto-prefill fields based on API responses. On the Send side, you can fully design request bodies, headers, authentication details, and payload structures — enabling seamless integration with almost any third-party REST API.

Designed as a fully plug-and-play extension, the API Integration Manager removes all complexity typically associated with external system integrations. No coding, no creating database tables, and no modifying core files. Everything — including field mapping, endpoint structure, edit actions, logs, and permissions — is handled from a clean, intuitive interface inside Perfex CRM.

System Requirements

• Perfex CRM v3.1.0 or higher

Installation

Installing the module is quick and simple, It takes just a few minutes :

• Extract the main .zip file and locate the api_integration_manager.zip file.
• Log in to the Perfex CRM admin panel as an administrator and go to Setup → Modules.
• Click Choose File and select the api_integration_manager.zip
• Click Install to complete the process.

Once the module is installed, it will appear in the list of available modules below. Simply click the Activate button to enable it.

Usage

Once the API Integration Manager Module is installed and activated, follow these steps to use it effectively:

Accessing the API Integration Manager Panel

• • After logging in as an admin or staff user (with appropriate permissions), navigate to the API Integration Manager section from the left sidebar.
  • 
• When you click on Create, you will have the option to enter the module name and select an icon.
• On the table list, you will see several options:
• • Manage Form: View the list of forms mapped to the module.
  • Export Module: Export the module and its forms in JSON format.
  • Edit
  • Delete

Form Configuration Overview

• • 
• • Name: The display name of the form.
  • Form Type: Choose between:
    • Send – Used to submit data to an external API.
    • Receive – Used to fetch and display data from an external API.
  • Receive Form Options: When Form Type = Receive, additional settings become available:
    • Display Type:
      • Table – Shows API response in a tabular layout.
      • Edit Form – Generates a form to edit fetched API records. When selected, the module will show Select Update API instead of Select Edit API.
    • Root Path: Defines the JSON navigation path (e.g., data->job_application) to extract data for table or form.
    • Select Edit API: Mapped API that will be used when clicking the Edit button in the table view.
    • Select Create API: Defines the Submit API for insert operations.
    • Edit Parameters: A dynamic repeater used to call the mapped edit API, retrieve its data, and automatically populate the edit form page.
  • Status: Enable or disable the form.
  • Save Response: If enabled, API responses will be logged into the Response Log (optional feature).
  • Show on Sidebar: If enabled, the form will appear as a menu item in the sidebar.
  • Form Fields: Managed via a dynamic repeater supporting:
    • Label
    • Field Type
    • Required
    • Size

    Note: The system automatically generates the field name based on the Label. Example: Full Name → full_name

  • Endpoint: URL of the external API you want to connect to.
  • Endpoint Parameters: A dynamic repeater that maps form fields to API parameters. Each parameter supports:
    • Path – Included inside the URL path.
      Example: domain.com/job-application/{id}
    • Query – Appended to the URL as query string.
      Example: domain.com/job-application?id=1
    • Body – Added inside the request payload during submission.
  • API Method: Choose request type: POST, GET, PUT, or PATCH.
  • Body Type: Format of the API request body:
    • JSON
    • Form (URL Encoded)
    • Multipart (Form Data)
  • Timeout: Maximum time (in seconds) to wait for API response.
  • Headers: A repeater allowing you to add custom headers.
    Example:
    • Key: Authorization Bearer :
    • Value: _token_
  • Public Form Options: If the form is enabled for public access:
    • You can enable reCAPTCHA for spam protection.

Notes

• Manage Permission is the primary permission that overrides all others. This means that if you want to grant the Create permission, you must first enable the Manage permission for the table view.
• The API View Page will not have any permissions.
• The API View Page will only be visible if edit api is mapped.
• Response and error logs will only be accessible to admins, as they may contain sensitive data.
• reCAPTCHA will appear on public forms only when valid Google reCAPTCHA credentials are configured in the Perfex CRM settings and the option is enabled for that specific form.

Support

For support, please reach out to us at codeonstring@gmail.com. We will respond as soon as possible, typically within one working day.

Changelog

VERSION 1.0.0 – Initial Release