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. This is exactly what you will get from our product. Nothing less, nothing more. 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
You can take a look at the online documentation and its detailed command replies here: Documentation and Commands of Perfex REST API This is a complete API service for Perfex installations, with which, you can implement your own third party service connections.
Available actions through API:
Customers → Add New Customer → Delete a Customer → Request customer information → Search Customer Information → Update a Customer
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
Keys Management Screenshot:
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.0d / February 2020
JWT token enhancements
Version 1.0c / January 2020
JWT security enhancements
Version 1.0b / January 2020
Minor bugfixes in Delete Lead command
Version 1.0 / December 2019
Initial version (1.0x), fully compatible with the latest version of Perfex CRM and PHP 7.2/PHP 7.3