A simple library for interacting with the Salesforce REST API.
Methods for setting up a connection, requesting an access token, refreshing the access token, saving the access token, and making calls against the API.
Installation: The package should be installed through composer and locked to a major version
composer require karronoli/salesforce-api:~1.0
Getting an OAuth Token:
With User interaction: You need to fetch an access token for a user, all followup requests will be performed against this user.
$sfClient = \Karronoli\Salesforce\Client::create('https://test.salesforce.com/', 'clientid', 'clientsecret', 'v37.0');
if ( ! isset($_GET['code'])) {
$url = $sfClient->getLoginUrl('http://example.com/sf-login');
header('Location: '.$url);
exit();
} else {
$token = $sfClient->authorizeConfirm($_GET['code'], 'http://example.com/sf-login');
}When having the username and password: To use this method you also need the security token to be appended to the password. Keep in mind this method is to be used as a replacement for the old API Key workflow.
$sfClient = \Karronoli\Salesforce\Client::create('https://test.salesforce.com/', 'clientid', 'clientsecret');
$sfClient->login('username', 'passwordAndSecurityTokenAppended');Performing an action: Once you have an access token you can perform requests against the API.
$sfClient = \Karronoli\Salesforce\Client::create('https://test.salesforce.com/', 'clientid', 'clientsecret');
$tokenGenerator = new \Karronoli\Salesforce\AccessTokenGenerator();
$accessToken = $tokenGenerator->createFromJson($_SESSION['accessToken']);
$sfClient->setAccessToken($accessToken);
$results = $sfClient->search('SELECT Name, Email FROM Lead Limit 10');
print_r($results);The token will expire after an hour so you should make sure you're checking the expiry time and refreshing accordingly.
The client can be configured in two ways, you can call the static create method above passing in the login url and oauth details or you can use a configuration object as in the example below. This is useful when you need to resolve the client out of an ioc container.
The configuration data for the client is passed in through a config file which must implement \Karronoli\Salesforce\ClientConfigInterface
For example
class SalesforceConfig implements \Karronoli\Salesforce\ClientConfigInterface {
/**
* @return string
*/
public function getLoginUrl()
{
return 'https://test.salesforce.com/';
}
/**
* @return string
*/
public function getClientId()
{
return 'clientid';
}
/**
* @return string
*/
public function getClientSecret()
{
return 'clientsecret';
}
/**
* Version of the API you wish to use
* @return string
*/
public function getVersion()
{
return 'v37.0';
}
}A config class is provided and can be used if needed. \Karronoli\Salesforce\ClientConfig
The Salesforce client can then be instantiated with the config object and an instance of the Guzzle v4 client.
$sfConfig = new SalesforceConfig();
$sfClient = new \Karronoli\Salesforce\Client($sfConfig, new GuzzleHttp\Client());Authentication happens via oauth2 and the login url can be generated using the getLoginUrl method, you should pass this your return url for the send stage of the oauth process.
$url = $sfClient->getLoginUrl('http://exmaple.com/sf-login');You should redirect the user to this returned url, on completion they will be redirected back with a code in the query string.
The second stage of the authentication can then be completed.
$token = $sfClient->authorizeConfirm($_GET['code'], 'http://exmaple.com/sf-login');The token returned from here is the raw data and can be passed to the access token generator to make an AccessToken.
$tokenGenerator = new \Karronoli\Salesforce\AccessTokenGenerator();
$accessToken = $tokenGenerator->createFromSalesforceResponse($token);This access token should be stored. A method to store this on the file system is provided but this isn't required.
The example above uses the php session to achieve the same result.
The LocalFileStore object needs to be instantiated with access to the token generator and a config class which implements \Karronoli\Salesforce\TokenStore\LocalFileConfigInterface
class SFLocalFileStoreConfig implements \Karronoli\Salesforce\TokenStore\LocalFileConfigInterface {
/**
* The path where the file will be stored, no trailing slash, must be writable
*
* @return string
*/
public function getFilePath()
{
return __DIR__;
}
}The token store can then be created and used to save the access token to the local file system as well as fetching a previously saved token.
$tokenStore = new \Karronoli\Salesforce\TokenStore\LocalFile(new \Karronoli\Salesforce\AccessTokenGenerator, new SFLocalFileStoreConfig);
//Save a token
$tokenStore->saveAccessToken($accessToken);
//Fetch a token
$accessToken = $tokenStore->fetchAccessToken();The access token only lasts 1 hour before expiring so you should regularly check its status and refresh it accordingly.
$accessToken = $tokenStore->fetchAccessToken();
if ($accessToken->needsRefresh()) {
$accessToken = $sfClient->refreshToken();
$tokenStore->saveAccessToken($accessToken);
}Before making a request you should instantiate the client as above and then assign the access token to it.
$sfConfig = new SalesforceConfig();
$sfClient = new \Karronoli\Salesforce\Client($sfConfig, new \GuzzleHttp\Client());
$sfClient->setAccessToken($accessToken);This is a powerful option for performing general queries against your salesforce data. Simply pass a valid query to the search method and the resulting data will be returned.
$data = $sfClient->search('SELECT Email, Name FROM Lead LIMIT 10');If you know the id and type of a record you can fetch a set of fields from it.
$data = $sfClient->getRecord('Lead', '00WL0000008wVl1MDE', ['name', 'email', 'phone']);The process for creating and updating records is very similar and can be performed as follows. The createRecord method will return the id of the newly created record.
$data = $sfClient->createRecord('Lead', ['email' => 'foo@example.com', 'Company' => 'New test', 'lastName' => 'John Doe']);
$sfClient->updateRecord('Lead', '00WL0000008wVl1MDE', ['lastName' => 'Steve Jobs']);
// or with the above freshly created client
$sfClient->updateRecord('Lead', $data, ['lastName' => 'Steve Jobs']);Records can be deleted based on their id and type.
$sfClient->deleteRecord('Lead', '00WL0000008wVl1MDE');If something goes wrong the library will throw an exception.
If its an authentication exception such as an expired token this will be as Karronoli\Salesforce\Exceptions\AuthenticationException,
you can get the exact details using the methods getMessage and getErrorCode.
All other errors will be Karronoli\Salesforce\Exceptions\RequestException, the salesforce error will be in the message
try {
$results = $sfClient->search('SELECT Name, Email FROM Lead Limit 10');
print_r($results);
} catch (\Karronoli\Salesforce\Exceptions\RequestException $e) {
echo $e->getMessage();
echo $e->getErrorCode();
} catch (\Karronoli\Salesforce\Exceptions\AuthenticationException $e) {
echo $e->getErrorCode();
}