Quick Start Guide

This brief guide should have LinkedIn connectivity up and running in a few short minutes.

Sign-up for a LinkedIn Application Key

Before starting, you'll need an application token (a key pair) from LinkedIn. You can apply for a key here; be sure to keep this key pair handy - you'll need in in a few moments.

Downloading the Required Files

• Download the latest version of the script, demo scripts and support image from the 'Downloads' page;
• Download the stand-alone OAuth library from Google Code.

Installing the Files

Once you have the needed files, unzip them and place them on your web server in a location that can be accessed by your user-facing PHP scripts.

By default, the Simple-LinkedIn class file will look for the OAuth class in the same directory - should you need to change this, simply change the following line, found near the top of the Simple-LinkedIn class file as needed:

require_once('OAuth.php');

Verifying the Install

As the library includes a set of demonstration scripts, once you have dropped the files on your server you can then use them to verify that communications are working.

1. From the Simple-LinkedIn .zip file, unzip the demonstration files to a location on your web server that is accessible via a browser;
2. Modify each of the demonstration files, first changing the require_once() line, pointing them at the recently installed Simple-LinkedIn class: require_once('linkedin_X.X.X.class.php');
3. Now, insert your LinkedIn application key pair into the $API_CONFIG configuration array: $API_CONFIG = array( 'appKey' => '<your application key here>', 'appSecret' => '<your application secret here>', 'callbackUrl' => NULL );
4. Finally, point your browser at the demo scripts and authorize yourself against LinkedIn with your new application. Once authorized, the demo scripts will become functional, and the install will have been validated.

Including Simple-LinkedIn in your Project

Now that you've signed up for application keys, and downloaded, installed and verified the library, you can now start building your LinkedIn API application.

Following the example of the demo scripts, include the Simple-LinkedIn class file in your PHP file/class. You can use relative or absolute paths, as with any PHP include/require:

require_once('/path/to/linkedin_X.X.X.class.php');

Then, instantiate the LinkedIn object by using the same configuration array from the demo scripts that contains your LinkedIn API key pair:

$API_CONFIG = array( 'appKey' => '<your application key here>', 'appSecret' => '<your application secret here>', 'callbackUrl' => NULL ); $linkedin = new LinkedIn($API_CONFIG);

The final step is to authorize the viewer - the demo scripts contain an example of how to achieve this, but in essence you want to store the user's access token locally so that you can make repeated calls on their behalf to the LinkedIn platform.

Latest Changes, Notes

With the basics up and running, be sure to check the Release Notes for the latest information on the current version of the Simple-LinkedIn class. Additionally, the Change Log details all changes from version to version.

Spread the Word

Now that you are using the class, indicate it on Ohloh and help spread the word about this free open-source library by clicking the 'I Use It' button below!

<wiki:gadget url="http://www.ohloh.net/p/588064/widgets/project_users_logo.xml" height="43" border="0"/>