Using PHP to call an Apex Web Service
April 5th, 2009
I had the ‘pleasure’ the other day of integrating Drupal with Salesforce.com using PHP. I didn’t want to write all of my SOQL queries and business logic in my PHP scripts so I whipped up a quick Apex class and exposed it as a web service. I found a great blog post by Scott Hemmeter that really helped me out calling the service with PHP so I thought I would share the code and other observations.
First you will need to download the PHP Toolkit. The toolkit contains all of the PHP code necessary to make web service calls against your org. Please note that the contained Partner and Enterprise WSDLs are for Production/Developer orgs, so if you are running against a Sandbox, you will need to download the appropriate WSDL from that Sandbox.
For this example, I took my Person wrapper class and exposed it as a web serivce. It exposes a method that allows you to search for Contacts and Leads by email address and returns a List of generic Person objects.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 |
global class PersonService {
global class Person {
webservice String id;
webservice String firstName;
webservice String lastName;
webservice String company;
webservice String email;
webservice String phone;
webservice String sObjectType;
}
webService static List<person> searchByEmail(String email) {
// list of Person objects to return
List<person> people = new List<person>();
// issue the sosl search
List<list<sobject>> searchResults = [FIND :email IN EMAIL FIELDS RETURNING
Contact (Id, Account.Name, Email, Phone, FirstName, LastName),
Lead (Id, Company, FirstName, LastName, Email, Phone)];
// cast the results by sObjec type
List<contact> contacts = ((List<contact>)searchResults[0]);
List<lead> leads = ((List<lead>)searchResults[1]);
// a each contact found as a Person
for (Integer i=0;i<contacts.size();i++) {
Person p = new Person();
p.id = contacts[i].Id;
p.firstName = contacts[i].FirstName;
p.lastName = contacts[i].LastName;
p.company = contacts[i].Account.Name;
p.email = contacts[i].Email;
p.phone = contacts[i].Phone;
p.sObjectType = 'Contact';
people.add(p);
}
// a each lead found as a Person
for (Integer i=0;i<leads.size();i++) {
Person p = new Person();
p.id = leads[i].Id;
p.firstName = leads[i].FirstName;
p.lastName = leads[i].LastName;
p.company = leads[i].Company;
p.email = leads[i].Email;
p.phone = leads[i].Phone;
p.sObjectType = 'Lead';
people.add(p);
}
System.debug('Returning people: '+people);
return people;
}
} |
Log into Salesforce.com and donwload the WSDL file for the PersonService class (Setup -> Develop -> Apex Classes). Also, make sure the profile calling the Web servcie has access to this class.
The PHP page looks like the following:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 |
<?PHP
require_once ('sfdc/SforcePartnerClient.php');
require_once ('sfdc/SforceHeaderOptions.php');
// Salesforce.com credentials
$sfdcUsername = "YOUR-USERNAME";
$sfdcPassword = "YOUR-PASSWORD";
$sfdcToken = "YOUR-SECURITYTOKEN";
// the email address to search for. could also use a post/get variable
$searchEmail = 'phpblogtest@noemail.com';
$sfdc = new SforcePartnerClient();
// create a connection using the partner wsdl
$SoapClient = $sfdc->createConnection("sfdc/partner.wsdl.xml");
$loginResult = false;
try {
// log in with username, password and security token if required
$loginResult = $sfdc->login($sfdcUsername, $sfdcPassword.$sfdcToken);
} catch (Exception $e) {
global $errors;
$errors = $e->faultstring;
echo "Fatal Login Error <b>" . $errors . "</b>";
die;
}
// setup the SOAP client modify the headers
$parsedURL = parse_url($sfdc->getLocation());
define ("_SFDC_SERVER_", substr($parsedURL['host'],0,strpos($parsedURL['host'], '.')));
define ("_WS_NAME_", "PersonService");
define ("_WS_WSDL_", "sfdc/" . _WS_NAME_ . ".wsdl.xml");
define ("_WS_ENDPOINT_", 'https://' . _SFDC_SERVER_ . '.salesforce.com/services/wsdl/class/' . _WS_NAME_);
define ("_WS_NAMESPACE_", 'http://soap.sforce.com/schemas/class/' . _WS_NAME_);
$client = new SoapClient(_WS_WSDL_);
$sforce_header = new SoapHeader(_WS_NAMESPACE_, "SessionHeader", array("sessionId" => $sfdc->getSessionId()));
$client->__setSoapHeaders(array($sforce_header));
echo _SFDC_SERVER_."br";
echo _WS_NAME_."br";
echo _WS_WSDL_."br";
echo _WS_ENDPOINT_."br";
echo _WS_NAMESPACE_."p";
try {
// call the web service via post
$wsParams=array('email'=>$searchEmail);
$response = $client->searchByEmail($wsParams);
// dump the response to the browser
print_r($response);
// this is really bad.
} catch (Exception $e) {
global $errors;
$errors = $e->faultstring;
echo "Ooop! Error: <b>" . $errors . "</b>";
die;
}
?> |
The PHP page should look something like the following:
Categories: Apex, Code Sample, PHP, Salesforce
[...] Solved. Using PHP to call an Apex Web Service Jeff Douglas – Technology, Coding and Bears… OH MY… 1: include the necessary files from the PHP toolkit 2: Login 3: take data from your previous login [...]
I use your code ,but needed some update for instance:
1. I had to change the path “sfdc/….” to “soapclient/…” due to my version of php toolkit
2.I had to move my wsdl to the sopclient folder,and it was not specify here,so a little precision for those you will use the code.
3. Another thing that i would like to specify is to enable your soap.dll and ssl.dll to be able to use soap in php.
Thank you for posting your code.
I am implementing oAuth in my developer account and i tried to call the SFDC Webservice through oAuth. How can i implement this scenario? Is any other way to call the webservice through oAuth from other outside web application(Like PHP).