jcoaks/vtiger

Vtiger Web Services PHP Client Library

Vtiger Web Services PHP Client Library (vtwsphpclib)

Composer based Vtiger Web Services Client., _(*1)

Build Status

Travis-CI: , _(*2)

Installation

The recommended way to install vtwsphpclib is with Composer. Composer is a dependency management tool for PHP., _(*3)

Specify vtwsphpclib as a dependency in your composer.json file:, _(*4)

{
    "require": {
        "jcoaks/vtiger": "0.1"
    }
}

In case you are new to Composer, you need to include the file /vendor/autoload.php file., _(*5)

Usage

Creating the WSClient object

use Jcoaks\Vtiger\WSClient;

$url = 'http://example.com/';

$config = [
    'auth' => [
        'username' => 'YOURVTIGERUSERNAME',
        'accesskey' => 'YOURVTIGERACCESSKEY'
    ]
];

$wsclient = new WSClient($url, $config);

Retrieving Errors

If an operation fails, the return value will be false. No error will be displayed unless you call, _(*6)

echo $wsclient->getLastError();

Create Object

$create = $wsclient->createObject('Accounts', array('accountname' => 'Test account'));

List Types

Get a list of Vtiger objects that are available when using the API., _(*7)

$availableModules = $wsclient->getAvailableModules();

Other operations

-- Work in progress --, _(*8)

License

Licensed using the MIT license. See LICENSE., _(*9)

Thanks

• Build with Guzzle 4.*
• Inspired by vtwsclib – vtiger CRM Web Services Client Library version 1.4