Free API Sample Module for Perfex CRM — REST, GraphQL & Webhook Integration Guide

From Documentation to Working Code in 5 Minutes

You’ve read the Data Builder API documentation. You understand the endpoints. But there’s always a gap between reading docs and writing production-ready integration code.

API Data Builder Sample bridges that gap. It’s a free, open-source Perfex CRM module that gives you interactive, working demos of every Data Builder API feature — right inside your admin panel.

Install it. Click around. Copy the code. Build your integration.

> Download Free on GitHub →

REST API — Full CRUD Demos

The REST API tab provides a complete interactive playground for Data Builder’s REST endpoints:

GET    /api/v1/projects         → List projects with pagination
GET    /api/v1/projects/42      → Single project details
POST   /api/v1/staff            → Create a new staff member
PUT    /api/v1/invoices/15      → Update an invoice
DELETE /api/v1/payments/7       → Remove a payment record

Switch between resources using the dropdown — Projects, Staff, Payments, Invoices, Tasks, Clients, and more. Every request shows:

Raw JSON response with syntax highlighting
HTTP status codes and response timing
Auto-generated PHP sample code you can copy directly

Advanced features like sparse fieldsets (?fields=id,total,status), pagination (?page=2&per_page=10), and sorting (?sort=-total) are all demonstrated with live controls.

GraphQL Playground

For teams building modern frontends, the GraphQL tab offers a full query editor:

{
  projects(limit: 10) {
    id
    name
    status
    start_date
  }
}

Pre-built templates get you started instantly:

Queries: Projects list, Tasks by project, Staff directory, Invoice summary, Connection ping
Mutations: Create Task, Create Staff, Delete Invoice

Each template includes variables support for parameterized queries. Results display in both a structured table and raw JSON view.

The module auto-generates PHP code for every query you run — ready to paste into your application.

Webhook Listener

The Webhooks tab demonstrates how to receive and process real-time events from Data Builder:

Event types: table.create, table.update, table.delete
Payload inspector: See the exact JSON structure your receiver will get
Integration templates: Ready-to-use patterns for connecting to third-party services

Connection Settings

Configure your API connection from a dedicated settings panel:

API Base URL — Point to any Perfex CRM site running Data Builder
API Token — Authenticate with a Bearer token
HMAC Secret — Enable HMAC-SHA256 request signing for production security
Connection Test — One-click verification with response timing

Standalone Client

This module does not need to be installed on the same Perfex CRM instance as Data Builder. It’s a standalone API client that can query any remote site running Data Builder. This makes it ideal for:

Development environments — Install the sample module on your dev server, point it to your production Data Builder API
Client demos — Show customers how their data is accessible via API
Learning — Explore the API without modifying your production system

Browser-Side Fetch

All API calls use browser-side fetch() instead of server-side cURL. This avoids cURL loopback deadlocks when both modules run on the same server, and gives you realistic CORS behavior for testing.

Robust Error Handling

The module gracefully handles non-JSON responses (HTML error pages, 500 errors) and provides clear diagnostic messages instead of cryptic parse errors.

Method 1: Direct Copy

Method 2: ZIP Upload

Configure

Perfex CRM 3.0.0 or later
Data Builder v2.0.0+ installed on the target site (not necessarily the same server)
A valid API Token created in Data Builder –> API Tokens

api_data_builder_sample/
├── api_data_builder_sample.php      # Module registration & sidebar menu
├── install.php                       # Activation hook
├── controllers/
│   └── Api_data_builder_sample.php   # Admin controller
├── helpers/
│   └── api_sample_helper.php         # Helper functions
└── views/admin/
    ├── dashboard.php                 # Overview & connection status
    ├── rest.php                      # REST API interactive demos
    ├── graphql.php                   # GraphQL playground
    ├── webhooks.php                  # Webhook listener & inspector
    └── settings.php                  # API connection settings

For Developers

Reference implementation — See exactly how to authenticate, paginate, filter, and sort Data Builder API responses
Code generation — Every request produces copy-paste PHP code
Testing ground — Validate your API token permissions before writing integration code

For Project Managers

API evaluation — Demonstrate Data Builder’s API capabilities to stakeholders
Proof of concept — Show how CRM data flows to external applications
Training tool — Onboard new developers with interactive examples

For Business Owners

Integration assessment — Understand what’s possible with your CRM data
Vendor evaluation — Compare Data Builder’s API to competing solutions
ROI justification — See the development time saved with pre-built API infrastructure

API Data Builder Sample is completely free and open-source under the MIT License. Install it, explore the API, and start building integrations in minutes.