Note: This is a module for Perfex CRM.
Brief description
This module enables you to use REST API through your Perfex CRM.
It includes a variety of useful commands in order to control your Perfex installation remotely, through third party applications.
The Perfex 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.
A REST API defines a set of functions which developers can perform requests and receive responses via HTTP protocol such as GET and POST.
Our item contains a complete documentation – If you are unsure about your coding skills or you do not understand what exactly an API is, feel free to raise a comment with your specific question.
Documentation & Commands
This is a complete API service for Perfex installations, with which, you can implement your own third party service connections.
Keys Management Screenshot:
Sample request/response:
Available actions through API:
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 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
Staff
→ Add New Staff
→ Delete a Staff
→ Request Staff information
→ Search Staff Information
→ Update a Staff
Tasks
→ Add New Task
→ Delete a Task
→ Request Task information
→ Search Tasks Information
→ Update a task
Tickets
→ Add New Ticket
→ Delete a Ticket
→ Request Ticket information
→ Search Ticket Information
→ Update a ticket
Custom Fields
→ Add Custom Fields
→ Delete Custom Fields
→ Request Custom Fields
→ Request Values of Custom Fields
→ Search custom field values’ information
→ Update Custom Fields
Estimates
→ Add New Estimates
→ Delete Estimate
→ Request Estimate information
→ Search Estimate information
→ Update a estimate
Expense category
→ Request Expense category
Expenses
→ Add Expense
→ Delete Expense
→ Request Expense information
→ Search Expenses information
→ Update a Expense
List Taxes
→ Request Taxes
Payment Mode
→ Request Payment Modes
Payments
→ List all Payments
→ Search Payments Information
Proposals
→ Add New Proposals
→ Delete Proposal
→ Request Proposal information
→ Search proposals information
→ Update a proposal
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 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
Source
