Note: This is a module for Perfex CRM.

Brief description

This module allows you to enable REST API functionality at your your Perfex CRM installation. It includes a variety of useful commands in order to control your Perfex installation remotely, build third party connections and access Perfex’s information in real-time!

Seamlessly integrate your CRM with third-party applications, automate processes, and revolutionize your workflow. With our API module, you can harness the true potential of a custom connection without the need for any additional custom work.

Perfex REST API operates over HTTPS and uses JSON as its data format. The API is a RESTful API and utilizes HTTP methods and HTTP status codes to specify requests and responses. It defines a set of functions which someone can perform requests and receive responses via HTTP protocol (GET / POST / DELETE / UPDATE etc.)

Documentation & Commands

Our REST API contains a complete documentation to help you build your own connections, however, if you are not familiar with APIs, its highly advised to consider hiring an expert for having your connections created.

Currently Available Endpoints of the API (please check Documentation for complete Request-Response examples):

Customers Add New Customer Delete a Customer List All Contacts of a Customer Request Customer Information Search Customer Information Update a Customer     Contacts Add New Contact Delete Contact Request Contact Information Search Contact Information Update Contact Information     Invoices Add New Invoice Delete Invoice Request Invoice Information Search Invoice Information Update an Invoice     Leads Add New Lead Delete a Lead Request Lead Information Search Lead Information Update a Lead     Milestones Add New Milestone Delete a Milestone Request Milestones Information Search Milestones Information Update a Milestone     Projects Add New Project Delete a Project Request Project Information Search Project Information Update a Project     Payment Modes Request Payment Modes     Taxes List all Taxes     Staff Members Add New Staff Member Delete a Staff Member Request Staff Information Search Staff Information Update a Staff Member

 

• Custom Fields

  • Add New Custom Field
  • Delete a Custom Field
  • Request Custom Fields
  • Request Values of a Custom Field
  • Search Custom Field Values’ Information
  • Update Custom Fields
     
 

• Estimates

  • Add New Estimate
  • Delete an Estimate
  • Request Estimate Information
  • Search Estimate Information
  • Update an estimate
     
 

• Contracts

  • Add New Contract
  • Delete a Contract
  • Request Contract Information
     
 

• Expenses

  • Add New Expense
  • Delete an Expense
  • Request Expense Information
  • Search Expenses Information
  • Update an Expense
     
 

• Expense Categories

  • Request Expense category
     
 

• Tasks

  • Add New Task
  • Delete a Task
  • Request Task Information
  • Search Tasks Information
  • Update a Task
     
 

• Payments

  • List All Payments
  • Search Payments Information
     
 

• Proposals

  • Add New Proposal
  • Delete Proposal
  • Request Proposal Information
  • Search Proposals Information
  • Update a Proposal
     
 

• Tickets

  • Add New Ticket
  • Delete a Ticket
  • Request Ticket Information
  • Search Ticket Information
  • Update a Ticket

Unlimited Integrations

Our REST API module empowers you to:

Automate Workflows: Connect Perfex CRM with other tools, such as accounting software, project management platforms, or email marketing systems. Streamline your operations and eliminate manual data entry by automating data synchronization, creating new leads, updating contact details, and more.

Extend Functionality: Enhance the capabilities of your CRM by integrating it with external applications. Leverage additional features, such as geolocation, SMS notifications, payment gateways, or any other service that your business relies on. Our Rest API Module allows you to create a tailored CRM experience that perfectly fits your unique requirements.

Improve Efficiency: Say goodbye to siloed systems and duplicate efforts. Our Rest API Module enables seamless data flow between Perfex CRM and other platforms, ensuring accurate and up-to-date information across all your integrated tools. This integration eliminates data inconsistencies, reduces manual errors, and boosts overall operational efficiency.

Foster Collaboration: Connect Perfex CRM with collaboration tools, such as project management or team communication platforms, to foster better collaboration within your organization. Share CRM data with relevant team members, sync task progress, and maintain a centralized hub for all your business operations.

Drive Business Growth: By leveraging the power of our Rest API Module, you can create a unified ecosystem of applications that work together harmoniously. This integration enables you to make data-driven decisions, deliver exceptional customer experiences, and drive business growth with increased productivity and streamlined processes.

Check out below, a sample connection with Zapier, under a contributed video of a customer:

Our API is a complete API service for Perfex CRM installations, with which, you can implement your own third party service connections (Zapier, IFTTT, and every other service out there!).

Possibilities are really unlimited – the only prerequisite is that you are familiar with REST APIs. In case you are unsure about the way your custom connection has to be done, its highly advised to consider hiring an expert for it, as support for this item is limited at its functionality working state and according to CodeCanyon’s support policy.

Support

It takes only a few seconds to be installed, activated and have a fully working API for Perfex.

If you have any questions, feel free to raise a support ticket at our support area.
Guys from support department will get back to you as soon as possible with a reply.

Version 2.0.1

-Added permissions feature for API tokens

Version 2.0

-Added support for Contracts
-Ensuring compatibility with PHP 8
-Minimum PHP version required: 7.4
-Documentation updated

Version 1.0.3a

-Small adjustments at API model

Version 1.0.3

-Added support for Estimates
-Added support for Expenses
-Added support for Taxes
-Added support for Payments
-Added support for Payment methods
-Added support for Proposals

Version 1.0.2

-Added support for Custom Fields, for all controllers
-Added extra Custom Fields controller in order to handle available information separately
-Documentation update for Custom Fields
-Fixed minor issue at Contacts controller, causing contacts' data not being fully parsed
-Fixed minor issue at Tasks controller, causing is_public attribute not to be active when requested
-Fixed expiration date not showing at Edit API key screen (admin area)

Version 1.0.1

-Fixed verified bug, causing lastname to be empty during PUT(update) of a staff member

Version 1.0.0

-Support for Invoices (Add,Delete,Request,Search,Update)
-Support for Contacts (Add,Delete,Request,Search,Update)
-New command for Customers (List all contacts of a customer)

Version 0.5

-Ensuring compatibility with latest version of Perfex CRM

Version 0.4

-JWT token enhancements

Version 0.3

-JWT security enhancements

Version 0.2

-Minor bugfixes in Delete Lead command

Version 0.1

-Initial version (1.0x), fully compatible with the latest version of Perfex CRM and PHP 7.2/PHP 7.3