sugarcrm-developers / php-rest-client
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
Requires
- php: >=8.2
- michaelj2324/php-rest-client: >=3.1.1
Requires (Dev)
Suggests
None
Provides
None
Conflicts
None
Replaces
None
README
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:
- With PHP installed, navigate to the repo folder (rest-php-client) via terminal.
- Run 'composer install'
Contributing:
See CONTRIBUTING for how you can contribute changes back into this project.