bahuma/xing-php-sdk

A PHP wrapper for the XING api

Xing PHP SDK

This is a PHP Wrapper for the Xing API based on guzzle 6. It simplifies the process of authenticating and requesting permission., _(*1)

Installation

The best way to install Xing SDK is through composer:, _(*2)

The best way to install php-sdk-for-XING is through composer:, _(*3)

1. Download the composer.phar executable or use the installer., _(*4)

   sh $ curl -sS https://getcomposer.org/installer | php, _(*5)

2. add the following to your composer.json, _(*6)

   ``` javascript { "require": { "bahuma/xing-php-sdk": "dev-master" } }, <sub>(*7)</sub>

   
   or just run
   
   ``` sh
   $ composer require bahuma/xing-php-sdk
   

3. Run Composer: php composer.phar install, <sub>(*8)</sub>

And you should be done., <sub>(*9)</sub>

Example

You can find an advanced example in the file sample.php., <sub>(*10)</sub>

I recommend open this file and then read on., <sub>(*11)</sub>

Obtaining an Access Token

To get an access token you first have to register your application. Head over to https://dev.xing.com and register yourself for a Xing application to get the consumer key/secret which you have to use with this package., <sub>(*12)</sub>

Then you have to call the following functions in this order:, <sub>(*13)</sub>

1. getRequestToken, <sub>(*14)</sub>

   Insert your consumer_key and your consumer_secret into the config array., <sub>(*15)</sub>

   Leave the token and token_secret blank., <sub>(*16)</sub>

   Then create a new XingSdk Object with this config., <sub>(*17)</sub>

   ``` php $config = [ 'consumer_key' => CONSUMER_KEY, 'consumer_secret' => CONSUMER_SECRET, 'token' => '', 'token_secret' => '', ];, <sub>(*18)</sub>

   $xingSdk = new XingSDK($config);, <sub>(*19)</sub>

   
   Then call the function with an url where the users are being redirected to after accepting the
   permissions. This URL is the callback-url.
   
   ``` php
   $result = $xing_api->getRequestToken("http://dev.bahuma.io/xing2?page=redirect");
   

   The function returns an array with three values., <sub>(*20)</sub>

   Save request_token and request_token_secret temporary. You'll need them in the next step., <sub>(*21)</sub>

   Redirect the user to the authorize_url. This is the page where the user clicks "accept"., <sub>(*22)</sub>

2. getAccessToken, <sub>(*23)</sub>

   This function should be executed at the callback-url., <sub>(*24)</sub>

   Insert your consumer_key and your consumer_secret into the config array., <sub>(*25)</sub>

   Insert the request_token and request_token_secret from the previous field into the config array., <sub>(*26)</sub>

   Then create a new XingSdk Object with this config., <sub>(*27)</sub>

   ``` php $config = [ 'consumer_key' => CONSUMER_KEY, 'consumer_secret' => CONSUMER_SECRET, 'token' => $the_temporary_saved_request_token, 'token_secret' => $the_temporary_saved_request_token_secret, ];, <sub>(*28)</sub>

   $xingSdk = new XingSDK($config); ```, <sub>(*29)</sub>

   Then call the function using the value of the GET-Parameter oauth_verifier, which has been set by XING., <sub>(*30)</sub>

   php $result = $xing_api->getAccessToken($_GET['oauth_verifier']);, <sub>(*31)</sub>

   The function returns an array containing the access_token and the access_token_secret for the user, which has logged in. Save these values in your database or somewhere else where you can access them later., <sub>(*32)</sub>

Making calls to the XING-API

Now that you have obtained an access token, you can call the API. For example let's get the profile details of the user, which has logged in., <sub>(*33)</sub>

1. Insert your consumer_key and your consumer_secret into the config array. Insert the access_token and access_token_secret from the user, which you have saved in your database,into the config array., <sub>(*34)</sub>

   php $config = array( 'consumer_key' => 'abc123456789xyz', 'consumer_secret' => 'abc123456789xyz', 'token' => $access_token_from_my_database, 'token_secret' => $access_token_secret_from_my_database, );, <sub>(*35)</sub>

2. Create a new XingSDK Object. php $xingSdk = new XingSDK($config);, <sub>(*36)</sub>

3. Get the Guzzle Client from the XingSDK Object. php $xingClient = $xingSDK->getClient();, <sub>(*37)</sub>

4. Make the request. php // "users/me" is the endpoint of the Xing-API. See https://dev.xing.com/docs/resources $response = $xingClient->get('users/me');, <sub>(*38)</sub>

5. Bonus: Get the request in a usable format. php $beautiful_response = XingSDK::decodeResponse($response); print_r($beautiful_response);, <sub>(*39)</sub>

And that's it., <sub>(*40)</sub>

For help how to use other request methods (GET/POST/PUT/DELETE/PATCH) or send content with your request, see the Guzzle Documentation., <sub>(*41)</sub>