What is php-sdk-for-XING?

PHP SDK for XING is a client library for connecting to the Xing ReSTful API, created and maintained by Björn Schotte.

This is no official package from XING AG!

You can find more information about the XING API at https://dev.xing.com/

Requirements

PHP SDK for XING requires at least PHP 5.3 and the following packages:

symfony/http-foundation V2.2.*@dev
guzzle/guzzle V3.1 or up

To use the package, you have to register at 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.

The Xing API currently uses OAuth 1.0 as authentication/authorisation protocol.

Installation

The best way to install php-sdk-for-XING is through composer:

Download the composer.phar executable or use the installer.
```
$ curl -sS https://getcomposer.org/installer | php
```

add the following to your composer.json

{
    "require": {
    	"bjoernschotte/php-sdk-for-XING": "dev-master"
    }
}

Run Composer: php composer.phar install

And you should be done.

Example usage

<?php
// OAuth application configuration
$conf = array(
    'consumer_key' => '<insert your consumer key>',
    'consumer_secret' => '<insert your consumer secret>',
    'token' => false,
    'token_secret' => false,
    'callback' => '<insert http(s) callback url>',
);

/* ... */

// request token and authorize
$client = \BjoernSchotte\XingClient::factory($conf);
$client->XingRequestToken();

For a full working example, please refer to https://github.com/BjoernSchotte/php-sdk-for-XING-example

License

This work is licensed under Apache 2.0 license.

Bug tracker

Have a bug or a feature request? Please open a new issue. Before opening any issue, please search for existing issues and read the Issue Guidelines, written by Nicolas Gallagher.

Contributing

If you want to contribute:

fork this repo, clone into & configure your upstreams
create a branch feature/featurename or bug/bugname (see details at the generic Contributing Guidelines)
code & commit
send a pull request to the master branch of this repo and adhere to the license
bug me until your PR gets incorporated :-)

TODOs

The package is currently in heavy development state. At least the following things are open:

add more commands from Xing API
define client.json better (currently Guzzle returns full arrays although client.json isn't fully specified, not sure if this is valid)
create example application
write short tutorial and put it to gh-pages
refactor OAuth authentication/authorisation process

raph-ael/php-sdk-for-XING