maidmaid/zoho

Zoho CRM client library

v0.3.0 2018-04-17 05:19 UTC

Requires

• php: >=5.6
• guzzlehttp/guzzle: ^6.0
• symfony/serializer: ^2.3|^3.0

Requires (Dev)

• phpunit/phpunit: ^5.7

mit

• Dany Maillard

README

Zoho client library. Require PHP >= 5.6.

Installation

composer require maidmaid/zoho

Usage

Constructor

use Maidmaid\Zoho\Client;

$client = new Client('your_authtoken');

See Using Authentication Token in official doc for more infos.

Insert records

To insert records into the required Zoho CRM module.

$records = $client->insertRecords($module = 'Contacts', $data = [
    10 => [
        'Last Name' => 'Holmes',
        'First Name' => 'Sherlock',
    ]
);

See insertRecords Method in official doc for more infos.

Update records

To update or modify the records in Zoho CRM

$records = $client->updateRecords($module, $data = [
    10 => [
        'Id' => 'the_ID',
        'First Name' => 'Sherlock',
    ]
]);

See updateRecords Method in official doc for more infos.

Delete records

To delete the selected records.

$client->deleteRecords($module = 'Contacts', 'the_ID');

See deleteMethod Method in official doc for more infos.

Get record by ID

To retrieve individual records by record ID

$records = $client->getRecordById($module = 'Contacts', ['the_ID_1', 'the_ID_2'])

See getRecordById Method in official doc for more infos.

Get records

To retrieve all users data specified in the API request.

Fetch data from first page:

$records = $client->getRecords($module = 'Contacts')

Fetch data with pagination:

$page = 0;
while ($records = $client->getRecords($module = 'Contacts', ++$page)) {

}

See getRecords Method in official doc for more infos.

Search records

To retrieve the records that match your search criteria.

$records = $client->searchRecords($module = 'Contacts', $criteria = '(Last Name:Holmes)');

See searchRecords Method in official doc for more infos.

Get fields

To retrieve details of fields available in a module.

$fields = $client->getFields($module = 'Contacts');

See getFields Method in official doc for more infos.

Generic call

$result = $client->call($module, $method, $params, $data)

Check errors

You can get last errors on failed process records:

$errors = $client->getLastErrors();

All calls thrown an exception if global response fails (e.g. if API key is wrong):

try {
    $results = $client->updateRecords('Contacts', $updates = []);
} catch (ZohoCRMException $e) {
}

Licence

Zoho client library is licensed under the MIT License - see the LICENSE file for details.