Salesforce/Force.com REST API client for Laravel. While it acts as more of a wrapper of the API methods, it should provide you with all the flexibility you will need to interact with the REST service.
Currently the only support is for Laravel and Lumen.
Interested in Eloquent Salesforce Models? Check out @roblesterjr04's EloquentSalesForce project that utilizes Forrest as it's API layer.
If you are upgrading to Version 2.0, be sure to re-publish your config file.
Forrest can be installed through composer. Open your composer.json
file and add the following to the require
key:
"omniphx/forrest": "2.*"
Next run composer update
from the command line to install the package.
The package will automatically register the service provider and Forrest
alias for Laravel >=5.5
. For earlier versions, add the service provider and alias to your config/app.php
file:
Omniphx\Forrest\Providers\Laravel\ForrestServiceProvider::class
'Forrest' => Omniphx\Forrest\Providers\Laravel\Facades\Forrest::class
For Laravel 4, add
Omniphx\Forrest\Providers\Laravel4\ForrestServiceProvider
inapp/config/app.php
. Alias will remain the same.
class_alias('Omniphx\Forrest\Providers\Laravel\Facades\Forrest', 'Forrest');
$app->register(Omniphx\Forrest\Providers\Lumen\ForrestServiceProvider::class);
$app->configure('forrest');
$app->withFacades();
Then you'll utilize the Lumen service provider by registering it in the bootstrap/app.php
file.
You will need a configuration file to add your credentials. Publish a config file using the artisan
command:
php artisan vendor:publish
This will publish a config/forrest.php
file that can switch between authentication types as well as other settings.
After adding the config file, update your .env
to include the following values (details for getting a consumer key and secret are outlined below):
CONSUMER_KEY=123455
CONSUMER_SECRET=ABCDEF
CALLBACK_URI=https://test.app/callback
LOGIN_URL=https://login.salesforce.com
[email protected]
PASSWORD=password123
For Lumen, you should copy the config file from
src/config/config.php
and add it to aforrest.php
configuration file under a config directory in the root of your application.
For Laravel 4, run
php artisan config:publish omniphx/forrest
which createapp/config/omniphx/forrest/config.php
- Log into to your Salesforce org
- Click on Setup in the upper right-hand menu
- Under Build click
Create > Apps
- Scroll to the bottom and click
New
under Connected Apps. - Enter the following details for the remote application:
- Connected App Name
- API Name
- Contact Email
- Enable OAuth Settings under the API dropdown
- Callback URL
- Select access scope (If you need a refresh token, specify it here)
- Click
Save
After saving, you will now be given a Consumer Key and Consumer Secret. Update your config file with values for consumerKey
, consumerSecret
, loginURL
and callbackURI
.
Creating authentication routes
Route::get('/authenticate', function()
{
return Forrest::authenticate();
});
Route::get('/callback', function()
{
Forrest::callback();
return Redirect::to('/');
});
With the Username Password flow, you can directly authenticate with the Forrest::authenticate()
method.
To use this authentication you must add your username, and password to the config file. Security token might need to be ammended to your password unless your IP address is whitelisted.
Route::get('/authenticate', function()
{
Forrest::authenticate();
return Redirect::to('/');
});
(When you cannot create a connected App in Salesforce)
- Salesforce allows individual logins via a SOAP Login
- The Bearer access token returned from the SOAP login can be used similar to Oauth key
- Update your config file and set the
authentication
value toUserPasswordSoap
- Update your config file with values for
loginURL
,username
, andpassword
. With the Username Password SOAP flow, you can directly authenticate with theForrest::authenticate()
method.
To use this authentication you can add your username, and password to the config file. Security token might need to be ammended to your password unless your IP address is whitelisted.
Route::get('/authenticate', function()
{
Forrest::authenticate();
return Redirect::to('/');
});
If your application requires logging in to salesforce as different users, you can alternatively pass in the login url, username, and password to the Forrest::authenticateUser()
method.
Security token might need to be ammended to your password unless your IP address is whitelisted.
Route::Post('/authenticate', function(Request $request)
{
Forrest::authenticateUser('https://login.salesforce.com',$request->username, $request->password);
return Redirect::to('/');
});
Sometimes users will need to connect to a sandbox or custom url. To do this, simply pass the url as an argument for the authenticatation method:
Route::get('/authenticate', function()
{
$loginURL = 'https://test.salesforce.com';
return Forrest::authenticate($loginURL);
});
Note: You can specify a default login URL in your config file.
After authentication, your app will store an encrypted authentication token which can be used to make API requests.
Forrest::query('SELECT Id FROM Account');
Sample result:
{
"totalSize": 2,
"done": true,
"records": [
{
"attributes": {
"type": "Account",
"url": "\/services\/data\/v30.0\/sobjects\/Account\/001i000000xxx"
},
"Id": "001i000000xxx"
},
{
"attributes": {
"type": "Account",
"url": "\/services\/data\/v30.0\/sobjects\/Account\/001i000000xxx"
},
"Id": "001i000000xxx"
}
]
}
If you are querying more than 2000 records, you response will include:
{
"nextRecordsUrl" : "/services/data/v20.0/query/01gD0000002HU6KIAW-2000"
}
Simply, call Forrest::next($nextRecordsUrl)
to return the next 2000 records.
Records can be created using the following format.
Forrest::sobjects('Account',[
'method' => 'post',
'body' => ['Name' => 'Dunder Mifflin']
]);
Update a record with the PUT method.
Forrest::sobjects('Account/001i000000xxx',[
'method' => 'put',
'body' => [
'Name' => 'Dunder Mifflin',
'Phone' => '555-555-5555'
]
]);
Update a record with the PATCH method and if the external Id doesn't exist, it will insert a new record.
$externalId = 'XYZ1234';
Forrest::sobjects('Account/External_Id__c/' + $externalId, [
'method' => 'patch',
'body' => [
'Name' => 'Dunder Mifflin',
'Phone' => '555-555-5555'
]
]);
Delete a record with the DELETE method.
Forrest::sobjects('Account/001i000000xxx', ['method' => 'delete']);
Sometimes you need the ability to set custom headers (e.g., creating a Lead with an assignment rule)
Forrest::sobjects('Lead',[
'method' => 'post',
'body' => [
'Company' => 'Dunder Mifflin',
'LastName' => 'Scott'
],
'headers' => [
'Sforce-Auto-Assign' => '01Q1N000000yMQZUA2'
]
]);
To disable assignment rules, use
'Sforce-Auto-Assign' => 'false'
Change the request/response format to XML with the format
key or make it default in your config file.
Forrest::sobjects('Account',['format'=>'xml']);
With the exception of the search
and query
resources, all resources are requested dynamically using method overloading.
You can determine which resources you have access to by calling with the resource method
Forrest::resources();
This sample output shows the resourses available to call via the API:
Array
(
[sobjects] => /services/data/v30.0/sobjects
[connect] => /services/data/v30.0/connect
[query] => /services/data/v30.0/query
[theme] => /services/data/v30.0/theme
[queryAll] => /services/data/v30.0/queryAll
[tooling] => /services/data/v30.0/tooling
[chatter] => /services/data/v30.0/chatter
[analytics] => /services/data/v30.0/analytics
[recent] => /services/data/v30.0/recent
[process] => /services/data/v30.0/process
[identity] => https://login.salesforce.com/id/00Di0000000XXXXXX/005i0000000aaaaAAA
[flexiPage] => /services/data/v30.0/flexiPage
[search] => /services/data/v30.0/search
[quickActions] => /services/data/v30.0/quickActions
[appMenu] => /services/data/v30.0/appMenu
)
From the list above, I can call resources by referring to the specified key.
Forrest::theme();
Or...
Forrest::appMenu();
Additional resource url parameters can also be passed in
Forrest::sobjects('Account/describe/approvalLayouts/');
As well as new formatting options, headers or other configurations
Forrest::theme(['format'=>'xml']);
Bulk API requests are especially handy when you need to quickly load large amounts of data into your Salesforce org. The key differences is that it requires at least three separate requests (Create, Add, Close), and the data being loaded is sent in a CSV format.
To illustrate, following are three requests to upsert a CSV of Contacts
records.
Create a bulk upload job with the POST method, the body contains the following job properties:
object
is the type of objects you're loading (they must all be the same type per job)externalIdFieldName
is the external ID, if this exists it'll update and if it doesn't a new record will be inserted. Only needed for upsert operations.contentType
is CSV, this is currently the only valid value.operation
is set toupsert
to both add and update records.
We're storing the response in $bulkJob
in order to reference the unique Job ID in the Add and Close requests below.
See Create a Job for the full list of options available here.
$bulkJob = Forrest::jobs('ingest', [
'method' => 'post',
'body' => [
"object" => "Contact",
"externalIdFieldName" => "externalId",
"contentType" => "CSV",
"operation" => "upsert"
]
]);
Using the Job ID from the Create POST request, you then send the CSV data to be processed using a PUT request. This assumes you've loaded your CSV contents to $csv
See Prepare CSV Files for details on how it should be formatted.
Forrest::jobs('ingest/' . $bulkJob['id'] . '/batches', [
'method' => 'put',
'headers' => [
'Content-Type' => 'text/csv'
],
'body' => $csv
]);
You must close the job before the records can be processed, to do so you send an UploadComplete
state using a PATCH request to the Job ID.
See Close or Abort a Job for more options and details on how to abort a job.
$response = Forrest::jobs('ingest/' . $bulkJob['id'] . '/', [
'method' => 'patch',
'body' => [
"state" => "UploadComplete"
]
]);
Bulk API 2.0 is available in API version 41.0 and later. For more information on Salesforce Bulk API, check out the official documentation and this tutorial on how to perform a successful Bulk Upload.
If a refresh token is set, the server can refresh the access token on the user's behalf. Refresh tokens are only for the Web Server flow.
Forrest::refresh();
If you need a refresh token, be sure to specify this under
access scope
in your Connected App. You can also specify this in your configuration file by adding'scope' => 'full refresh_token'
. Setting scope access in the config file is optional, the default scope access is determined by your Salesforce org.
This will revoke the authorization token. The session will continue to store a token, but it will become invalid.
Forrest::revoke();
Returns all currently supported versions. Includes the verison, label and link to each version's root:
Forrest::versions();
Returns list of available resources based on the logged in user's permission and API version.
Forrest::resources();
Returns information about the logged-in user.
Forrest::identity();
For a complete listing of API resources, refer to the Force.com REST API Developer's Guide
If you create a custom API using Apex, you can use the custom()
method for consuming them.
Forrest::custom('/myEndpoint');
Additional options and parameters can be passed in like this:
Forrest::custom('/myEndpoint', [
'method' => 'post',
'body' => ['foo' => 'bar'],
'parameters' => ['flim' => 'flam']]);
Read Creating REST APIs using Apex REST for more information.
If needed, you can make raw requests to an endpoint of your choice.
Forrest::get('/services/data/v20.0/endpoint');
Forrest::head('/services/data/v20.0/endpoint');
Forrest::post('/services/data/v20.0/endpoint', ['my'=>'param']);
Forrest::put('/services/data/v20.0/endpoint', ['my'=>'param']);
Forrest::patch('/services/data/v20.0/endpoint', ['my'=>'param']);
Forrest::delete('/services/data/v20.0/endpoint');
By default, this package will return the body of a response as either a deserialized JSON object or a SimpleXMLElement object.
There might be times, when you would rather handle this differently. To do this, simply use any format other than 'json' or 'xml' and the code will return a Guzzle response object.
$response = Forrest::sobjects($resource, ['format'=> 'none']);
$content = (string) $response->getBody(); // Guzzle response
This package makes use of Guzzle's event listers
Event::listen('forrest.response', function($request, $response) {
dd((string) $response);
});
For more information about Guzzle responses and event listeners, refer to their documentation.