Search by

sugarcrm-developers / php-rest-client

MichaelJ2324

An SDK for interacting with Sugar's REST v10+ API.

Package info

github.com/sugarcrm-developers/php-rest-client

pkg:composer/sugarcrm-developers/php-rest-client

Statistics

Installs: 14 103

Dependents: 0

Suggesters: 0

Stars: 5

Open Issues: 1

1.2.0 2026-11-18 16:48 UTC

This package is auto-updated.

Last update: 2026-11-18 18:41:30 UTC


README

Coverage Status Packagist Downloads Packagist Version

SugarCRM PHP REST Client

Overview

A simple and intuitive Library for accessing a SugarCRM's REST v10+ API. Allows for Object Oriented design around accessing data from a SugarCRM system, so you can easily get your integration project underway.

Usage

Add to any project using composer:

"require": {
    "sugarcrm-developers/php-rest-client": "^1.*"
}

TLS certificate verification

TLS certificates are verified by default. To disable verification for a local development instance only, pass false as the third constructor argument. To trust a custom CA bundle, pass its file path:

$client = new \Sugarcrm\REST\Client\SugarApi($server, $credentials);                 // verifies (default)
$client = new \Sugarcrm\REST\Client\SugarApi($server, $credentials, false);          // verification off (dev only)
$client = new \Sugarcrm\REST\Client\SugarApi($server, $credentials, '/path/ca.pem'); // custom CA bundle

Existing instances can use setVerifyTls() / getVerifyTls().

Check out the Wiki for detailed information on

  • Installation
  • Usage
  • Customization
  • Included endpoints
  • Architecture overview

Developing the PHP REST Client

Requirements:

Steps:

  1. With PHP installed, navigate to the repo folder (rest-php-client) via terminal.
  2. Run 'composer install'

Contributing:

See CONTRIBUTING for how you can contribute changes back into this project.