Vtiger REST API PHP Wrapper (webservices) [PSR-4 🆗 ✅]
đź“‚Structure
VtigerAPI-PHP/
├── Controller/
│ └──VtApiClasses/
│ └──Operations/
│ ├──CrmCrudOperations.php
│ └──WebServices/
│ ├──CrmWebService.php
├── Service/
│ └──VtApiServices/
│ └──WebServices/
│ VtigerService.php
├── Model/
│ ├──Const.php
├── View/
│ ├──CreateSingleRecord.php
│ ├──CreateMultiRecord.php
│ ├──Read.php
│ ├──UpdateSingleRecord.php
│ ├──UpdateMultiRecord.php
│ ├──DeleteSingleRecord.php
│ ├──DeleteMultiRecord.php
│ ├──ModuleFieldNames.php
├── .gitignore.swp
├── .README.md
├── .LICENSE.md
đź’ľInstallation
To run this project make sure that curl is installed and active in your php.ini You will Also need Composer to manage classes
▶️Usage
in the main dir of your project open composer and execute composer self-update
followed by composer dump-autoload -o
To use this project you must add/modify your php environment variables to match your CRM information read more about php environment variables and how to set them up for security purposes
<?php
$EndPointUrl = getenv('CRMURL'); // [YOUR CRM URL ENVIRONMENT VARIABLE HERE] YOUR URL MUST END WITH /webservice.php eg(http://example.com/vtigercrm/webservice.php)
$UserName=getenv('CRMUserName'); // [YOUR CRM USER ENVIRONMENT VARIABLE HERE]
$UserAccessKey=getenv('CRMAPIKEY'); // [YOUR CRM USER ACCESS KEY ENVIRONMENT VARIABLE HERE]
?>
đź“śExamples
available in the view folder of this project.
- đź’ŞPRO tip -> to debug your code use the following code to toggle error messages display On/OFF
<?php
ini_set('display_errors', 1);
ini_set('display_startup_errors', 1);
error_reporting(E_ALL);
?>
License
Vtiger REST API PHP Wrapper (webservices) distributed under the GNU