basecrm/basecrm-php

BaseCRM Official API V2 library client for PHP

Maintainers

Details

github.com/zendesk/basecrm-php

Homepage

Source

Issues

Installs: 931 262

Dependents: 0

Suggesters: 0

Security: 0

Stars: 24

Watchers: 45

Forks: 21

Open Issues: 7

v1.4.4 2021-06-29 08:51 UTC

Requires

  • php: >=5.4.0

Requires (Dev)

Apache License 2.0 ffa390eacb3721a435cf88b2c484139b402be4bf

  • Zendesk <opensource.woop@zendesk.com>

httphttp clientapiclientv2base crm

This package is auto-updated.

Last update: 2024-10-29 04:41:54 UTC

README

BaseCRM Official API V2 library client for PHP

Installation

The recommended way to install the client is through Composer.

# Install Composer
curl -sS https://getcomposer.org/installer | php

Next, run the Composer command to install the latest stable version :

composer require basecrm/basecrm-php

After installing, you need to require Composer's autoloader:

require 'vendor/autoload.php';

Usage

require 'vendor/autoload.php';

// Then we instantiate a client (as shown below)

Build a client

Using this api without authentication gives an error

$client = new \BaseCRM\Client(['accessToken' => '<YOUR_PERSONAL_ACCESS_TOKEN>']);

Client Options

The following options are available while instantiating a client:

  • accessToken: Personal access token
  • baseUrl: Base url for the api
  • userAgent: Default user-agent for all requests
  • timeout: Request timeout
  • verbose: Verbose/debug mode
  • verifySSL: Whether to verify SSL or not. Default: true

Architecture

The library follows few architectural principles you should understand before digging deeper.

  1. Interactions with resources are done via service objects.
  2. Service objects are exposed as properties on client instances.
  3. Service objects expose resource-oriented actions.
  4. Actions return associative arrays.

For example, to interact with deals API you will use \BaseCRM\DealsService, which you can get if you call:

$client = new \BaseCRM\Client(['accessToken' => '<YOUR_PERSONAL_ACCESS_TOKEN>']);
$client->deals; // \BaseCRM\DealsService

To retrieve list of resources and use filtering you will call #all method:

$client = new \BaseCRM\Client(['accessToken' => '<YOUR_PERSONAL_ACCESS_TOKEN>']);
$client->deals->all(['organization_id' => google['id'], 'hot' => true]);

To find a resource by it's unique identifier use #get method:

$client = new \BaseCRM\Client(['accessToken' => '<YOUR_PERSONAL_ACCESS_TOKEN>']);
$client->deals->get($id) # => array

When you'd like to create a resource, or update it's attributes you want to use either #create or #update methods. For example if you want to create a new deal you will call:

$client = new \BaseCRM\Client(['accessToken' => '<YOUR_PERSONAL_ACCESS_TOKEN>']);
$deal = $client->deals->create(['name' => 'Website redesign', 'contact_id' => $id]);

To destroy a resource use #destroy method:

$client = new \BaseCRM\Client(['accessToken' => '<YOUR_PERSONAL_ACCESS_TOKEN>']);
$client->deals->destroy($id) // => true

There other non-CRUD operations supported as well. Please contact corresponding service files for in-depth documentation.

Full example

Create a new organization and after that change it's attributes (website).

$client = new \BaseCRM\Client(['accessToken' => '<YOUR_PERSONAL_ACCESS_TOKEN>']);
$lead = $client->leads->create(['organization_name' => 'Design service company']);

$lead['website'] = "http://www.designservices.com"
$client->leads->update($lead['id'], $lead);

Error handling

When you instantiate a client or make any request via service objects, exceptions can be raised for multiple of reasons e.g. a network error, an authentication error, an invalid param error etc.

Sample below shows how to properly handle exceptions:

try
{
  // Instantiate a client.
  $client = new \BaseCRM\Client(['accessToken' => getenv('BASECRM_ACCESS_TOKEN')]);
  $lead = $client->leads->create(['organization_name' => 'Design service company']);

  print_r($lead);
}
catch (\BaseCRM\Errors\ConfigurationError $e)
{
  // Invalid client configuration option
}
catch (\BaseCRM\Errors\ResourceError $e)
{
  // Resource related error
  print('Http status = ' . $e->getHttpStatusCode() . "\n");
  print('Request ID = ' . $e->getRequestId() . "\n");
  foreach ($e->errors as $error)
  {
    print('field = ' . $error['field'] . "\n");
    print('code = ' . $error['code'] . "\n");
    print('message = ' . $error['message'] . "\n");
    print('details = ' . $error['details'] . "\n");
  }
}
catch (\BaseCRM\Errors\RequestError $e)
{
  // Invalid query parameters, authentication error etc.
}
catch (\BaseCRM\Errors\Connectionerror $e)
{
  // Network communication error, curl error is returned
  print('Errno = ' . $e->getErrno() . "\n");
  print('Error message = ' . $e->getErrorMessage() . "\n");
}
catch (Exception $e)
{
  // Other kind of exception
}

Sync API

The following sample code shows how to perform a full synchronization flow using high-level wrapper.

First of all you need an instance of \BaseCRM\Client. High-level \BaseCRM\Sync wrapper uses \BaseCRM\SyncService to interact with the Sync API. In addition to the client instance, you must provide a device’s UUID within $deviceUUID parameter. The device’s UUID must not change between synchronization sessions, otherwise the sync service will not recognize the device and will send all the data again.

$client = new \BaseCRM\Client(['access_token' => '<YOUR_PERSONAL_ACCESS_TOKEN>']);
$sync = new \BaseCRM\Sync($client, '<YOUR_DEVICES_UUID');

Now all you have to do is to call fetch method and pass a block that you might use to store fetched data to a database.

$sync->fetch(function ($meta, $data) {
  $options = [
    'table' => $meta['type'],
    'statement' => $meta['sync']['event_type'],
    'properties' => $data
  ];
  return \DAO::execute($options) ? \BaseCRM\Sync::ACK : \BaseCRM\Sync::NACK;
});

Notice that you must call either #ack or #nack method.

Resources and actions

Documentation for every action can be found in corresponding service files under lib/ directory.

Account

$client = new \BaseCRM\Client(['accessToken' => '<YOUR_PERSONAL_ACCESS_TOKEN>');
$client->accounts // => \BaseCRM\AccountsService

Actions:

  • Retrieve account details - client->accounts->self

AssociatedContact

$client = new \BaseCRM\Client(['accessToken' => '<YOUR_PERSONAL_ACCESS_TOKEN>');
$client->associatedContacts // => \BaseCRM\AssociatedContactsService

Actions:

  • Retrieve deal's associated contacts - client->associatedContacts->all
  • Create an associated contact - client->associatedContacts->create
  • Remove an associated contact - client->associatedContacts->destroy

Contact

$client = new \BaseCRM\Client(['accessToken' => '<YOUR_PERSONAL_ACCESS_TOKEN>');
$client->contacts // => \BaseCRM\ContactsService

Actions:

  • Retrieve all contacts - client->contacts->all
  • Create a contact - client->contacts->create
  • Retrieve a single contact - client->contacts->get
  • Update a contact - client->contacts->update
  • Delete a contact - client->contacts->destroy

Deal

$client = new \BaseCRM\Client(['accessToken' => '<YOUR_PERSONAL_ACCESS_TOKEN>');
$client->deals // => \BaseCRM\DealsService

Actions:

  • Retrieve all deals - client->deals->all
  • Create a deal - client->deals->create
  • Retrieve a single deal - client->deals->get
  • Update a deal - client->deals->update
  • Delete a deal - client->deals->destroy

Note about deal value

You can use either a string or numerical deal value when modifying a deal.

$deal['value'] = 10;
$deal['value'] = 10.10;
$deal['value'] = "10.10";

Deal Source

$client = new \BaseCRM\Client(['accessToken' => '<YOUR_PERSONAL_ACCESS_TOKEN>');
$client->dealSources // => \BaseCRM\DealSourcesService

Actions:

  • Retrieve all deal sources - client->dealSources->all
  • Create a deal source - client->dealSources->create
  • Retrieve a single deal source - client->dealSources->get
  • Update a deal source - client->dealSources->update
  • Delete a deal source - client->dealSources->destroy

Lead

$client = new \BaseCRM\Client(['accessToken' => '<YOUR_PERSONAL_ACCESS_TOKEN>');
$client->leads // => \BaseCRM\LeadsService

Actions:

  • Retrieve all leads - client->leads->all
  • Create a lead - client->leads->create
  • Retrieve a single lead - client->leads->get
  • Update a lead - client->leads->update
  • Delete a lead - client->leads->destroy

Lead Source

$client = new \BaseCRM\Client(['accessToken' => '<YOUR_PERSONAL_ACCESS_TOKEN>');
$client->leadSources // => \BaseCRM\LeadSourcesService

Actions:

  • Retrieve all lead sources - client->leadSources->all
  • Create a lead source - client->leadSources->create
  • Retrieve a single lead source - client->leadSources->get
  • Update a lead source - client->leadSources->update
  • Delete a lead source - client->leadSources->destroy

Line Item

$client = new \BaseCRM\Client(['accessToken' => '<YOUR_PERSONAL_ACCESS_TOKEN>');
$client->lineItems // => \BaseCRM\LineItemsService

Actions:

  • Retrieve all line items - client->lineItems->all
  • Create a line item - client->lineItems->create
  • Retrieve a single line item- client->lineItems->get
  • Update a line item - client->lineItems->update
  • Delete a line item - client->lineItems->destroy

LossReason

$client = new \BaseCRM\Client(['accessToken' => '<YOUR_PERSONAL_ACCESS_TOKEN>');
$client->lossReasons // => \BaseCRM\LossReasonsService

Actions:

  • Retrieve all reasons - client->lossReasons->all
  • Create a loss reason - client->lossReasons->create
  • Retrieve a single reason - client->lossReasons->get
  • Update a loss reason - client->lossReasons->update
  • Delete a reason - client->lossReasons->destroy

Note

$client = new \BaseCRM\Client(['accessToken' => '<YOUR_PERSONAL_ACCESS_TOKEN>');
$client->notes // => \BaseCRM\NotesService

Actions:

  • Retrieve all notes - client->notes->all
  • Create a note - client->notes->create
  • Retrieve a single note - client->notes->get
  • Update a note - client->notes->update
  • Delete a note - client->notes->destroy

Order

$client = new \BaseCRM\Client(['accessToken' => '<YOUR_PERSONAL_ACCESS_TOKEN>');
$client->orders // => \BaseCRM\OrdersService

Actions:

  • Retrieve all orders - client->orders->all
  • Create an order - client->orders->create
  • Retrieve a single order - client->orders->get
  • Update an order - client->orders->update
  • Delete an order - client->orders->destroy

Pipeline

$client = new \BaseCRM\Client(['accessToken' => '<YOUR_PERSONAL_ACCESS_TOKEN>');
$client->pipelines // => \BaseCRM\PipelinesService

Actions:

  • Retrieve all pipelines - client->pipelines->all

Product

$client = new \BaseCRM\Client(['accessToken' => '<YOUR_PERSONAL_ACCESS_TOKEN>');
$client->products // => \BaseCRM\ProductsService

Actions:

  • Retrieve all products - client->products->all
  • Create a product - client->products->create
  • Retrieve a single product - client->products->get
  • Update a product - client->products->update
  • Delete a product - client->products->destroy

Source (Deprecated! Use Lead Source, Deal Source instead)

$client = new \BaseCRM\Client(['accessToken' => '<YOUR_PERSONAL_ACCESS_TOKEN>');
$client->sources // => \BaseCRM\SourcesService

Actions:

  • Retrieve all sources - client->sources->all
  • Create a source - client->sources->create
  • Retrieve a single source - client->sources->get
  • Update a source - client->sources->update
  • Delete a source - client->sources->destroy

Stage

$client = new \BaseCRM\Client(['accessToken' => '<YOUR_PERSONAL_ACCESS_TOKEN>');
$client->stages // => \BaseCRM\StagesService

Actions:

  • Retrieve all stages - client->stages->all

Tag

$client = new \BaseCRM\Client(['accessToken' => '<YOUR_PERSONAL_ACCESS_TOKEN>');
$client->tags // => \BaseCRM\TagsService

Actions:

  • Retrieve all tags - client->tags->all
  • Create a tag - client->tags->create
  • Retrieve a single tag - client->tags->get
  • Update a tag - client->tags->update
  • Delete a tag - client->tags->destroy

Task

$client = new \BaseCRM\Client(['accessToken' => '<YOUR_PERSONAL_ACCESS_TOKEN>');
$client->tasks // => \BaseCRM\TasksService

Actions:

  • Retrieve all tasks - client->tasks->all
  • Create a task - client->tasks->create
  • Retrieve a single task - client->tasks->get
  • Update a task - client->tasks->update
  • Delete a task - client->tasks->destroy

TextMessage

$client = new \BaseCRM\Client(['accessToken' => '<YOUR_PERSONAL_ACCESS_TOKEN>');
$client->textMessages // => \BaseCRM\TextMessagesService

Actions:

  • Retrieve text messages - client->textMessages->all
  • Retrieve a single text message - client->textMessages->get

User

$client = new \BaseCRM\Client(['accessToken' => '<YOUR_PERSONAL_ACCESS_TOKEN>');
$client->users // => \BaseCRM\UsersService

Actions:

  • Retrieve all users - client->users->all
  • Retrieve a single user - client->users->get
  • Retrieve an authenticating user - client->users->self

Visit

$client = new \BaseCRM\Client(['accessToken' => '<YOUR_PERSONAL_ACCESS_TOKEN>');
$client->visits // => \BaseCRM\VisitsService

Actions:

  • Retrieve visits - client->visits->all

VisitOutcome

$client = new \BaseCRM\Client(['accessToken' => '<YOUR_PERSONAL_ACCESS_TOKEN>');
$client->visitOutcomes // => \BaseCRM\VisitOutcomesService

Actions:

  • Retrieve visit outcomes - client->visitOutcomes->all

Tests

Install PHPUnit via Composer:

$ composer install

To run all test suites:

$ BASECRM_ACCESS_TOKEN=<your-token-here> ./vendor/bin/phpunit

And to run a single suite:

$ BASECRM_ACCESS_TOKEN=<your-token-here> ./vendor/bin/phpunit --filter testUpdate tests/LeadsServiceTest.php

Bug Reports

Report here.

Copyright and license

Copyright 2015 Zendesk

Licensed under the Apache License, Version 2.0