README

This package used to integrate with the new Zoho CRM

Requirements

Get yourself a Zoho CRM account.
Register your application
PHP >= 7.2
Laravel >= 6.*

Installation

Add Zoho CRM to your composer file via the composer require command:

$ composer require asciisd/zoho

Or add it to composer.json manually:

"require": {
    "asciisd/zoho": "^1.0"
}

Zoho CRM service providers will be automatically registered using Laravel's auto-discovery feature.

Configuration

The default configuration settings set in config/zoho.php. Copy this file to your own config directory to modify the values. You can publish the config using this command:

$ php artisan zoho:install

You'll need to add the following variables to your .env file. Use the credentials previously obtained registering your application.

ZOHO_CLIENT_ID=
ZOHO_CLIENT_SECRET=
ZOHO_REDIRECT_URI=
ZOHO_CURRENT_USER_EMAIL=

Then, follow the next steps:

Go to Zoho CRM Developer Console.
ADD CLIENT Server-based Applications.
Enter Client Name Any name you want
Enter Homepage URL your base home url
Enter Authorized Redirect URIs config('app.url') . /zoho/oauth2callback
Go to your project location on terminal and enter
```
php artisan zoho:authentication
```
Copy the generated link and past it in the browser to complete the oAuth process.

Now Zoho CRM is ready to use.

Testing

before testing make sure to create file ZCRMClientLibrary.log on

tests/Fixture/Storage/oauth/logs/ZCRMClientLibrary.log

and put your zcrm_oauthtokens.txt on

tests/Fixture/Storage/oauth/tokens/zcrm_oauthtokens.txt

finally put your Env keys

ZOHO_CLIENT_ID=
ZOHO_CLIENT_SECRET=
ZOHO_REDIRECT_URI=
ZOHO_CURRENT_USER_EMAIL=

How to use

use ZOHO Facade like this

use Asciisd\Zoho\Facades\ZohoManager;

// we can now deals with leads module
$leads = ZohoManager::useModule('Leads');

this will return an instance of ZohoModules

Model Can be used like this:-

Available only starting from v1.1.0

add Zohoable as extended class like this:-

use Asciisd\Zoho\Zohoable;
use Asciisd\Zoho\CriteriaBuilder;

class Invoice extends Zohoable {
    
    // this is your Zoho module API Name
    protected $zoho_module_name = 'Payments';

    public function searchCriteria(){
        // you should return string of criteria that you want to find current record in crm with.
        //EX:
        return CriteriaBuilder::where('PaymentID', $this->payment_id)
                              ->andWhere('Order_ID', $this->order_id)
                              ->toString();
    }

    public function zohoMandatoryFields() {
        // you should return array of mandatory fields to create module from this model
        // EX:
        return ['Base_Currency' => $this->currency];
    }
}

so now you can use invoice like this

$invoice = \App\Invoice::find(1);

// to check if has zoho id stored on local database or not
$invoice->hasZohoId();

// to return the stored zoho id
$invoice->zohoId();

// that will search on zoho with provided criteria to find the record and associated your model with returned id if exist
// if you provided an `id` that will be used instead of searching on Zoho
$invoice->createOrUpdateZohoId($id = null);

// you can also send current model to zoho
// that wil use `zohoMandatoryFields` method to Serialize model to zohoObject
// Also you can pass additional fields as array to this method
$invoice->createAsZohoable($options = []);

Note: To use the Invoice like this, you must have the invoices table in your database just like you would for any Laravel model. This allows you to save data to the database and also be able to link it to the zohos table and use all the functions in Zohoable. Use the CRUD functions below if you do not intend to use the Zohoable model this way.

CRUD Can be used like this:-

READ

use Asciisd\Zoho\Facades\ZohoManager;

// we can now deals with leads module
$leads = ZohoManager::useModule('Leads');

// find record by it's ID
$lead = $leads->getRecord('3582074000002383003');

UPDATE

// find record by it's ID
$lead = $leads->getRecord('3582074000002383003');

// Set field with new value
$lead->setFieldValue('Last_Name', 'Ahmed');

// Then call update() method
$lead = $lead->update()->getData();

CREATE

// initiating a new empty instance of leads
$record = $leads->getRecordInstance();

// fill this instance with data
$record->setFieldValue('First_Name', 'Amr');
$record->setFieldValue('Last_Name', 'Emad');
$record->setFieldValue('Email', 'test@asciisd.com');
$record->setFieldValue('Phone', '012345678910');

// create the record into zoho crm then get the created instance data
$lead = $record->create()->getData();

DELETE

// find record by it's ID
$lead = $leads->getRecord('3582074000002383003');

$lead->delete();

SEARCH

Word

use Asciisd\Zoho\Facades\ZohoManager;

$records = ZohoManager::useModule('Leads')->searchRecordsByWord('word to be searched');
$first_record = $records[0];

Phone

use Asciisd\Zoho\Facades\ZohoManager;

$records = ZohoManager::useModule('Leads')->searchRecordsByPhone('12345678910');
$first_record = $records[0];

Email

use Asciisd\Zoho\Facades\ZohoManager;

$records = ZohoManager::useModule('Leads')->searchRecordsByEmail('nobody@asciisd.com');
$first_record = $records[0];

Criteria

use Asciisd\Zoho\Facades\ZohoManager;

$records = ZohoManager::useModule('Leads')->searchRecordsByCriteria('(City:equals:NY) and (State:equals:Alden)');
$first_record = $records[0];

Custom

use Asciisd\Zoho\Facades\ZohoManager;

$records = ZohoManager::useModule('Leads')
                    ->where('City', 'NY')
                    ->andWhere('State','Alden')
                    ->search();

$first_record = $records[0];

you can also make CriteriaBuilder like this

use Asciisd\Zoho\CriteriaBuilder;
use Asciisd\Zoho\Facades\ZohoManager;

$builder = CriteriaBuilder::where('City', 'NY')->andWhere('State','Alden')->startsWith('City', 'N');
ZohoManager::useModule('Leads')->searchRecordsByCriteria($builder->toString());

International Versions

If you're using zoho.com, you don't have to change anything.

If you're using zoho.eu, add to .env:

ZOHO_ACCOUNTS_URL=https://accounts.zoho.eu
ZOHO_API_BASE_URL=www.zohoapis.eu

If you're using zoho.com.cn, add to .env:

ZOHO_ACCOUNTS_URL=https://accounts.zoho.com.cn
ZOHO_API_BASE_URL=www.zohoapis.com.cn

License

Support

Contact:
asciisd.com
aemad@asciisd.com
+2-010-1144-1444

mkwsra / zoho

Maintainers

Details