XINGAPI 0.1.0

XINGAPI 0.1.0

TestsTested
LangLanguage Obj-CObjective C
License MIT
ReleasedLast Release Dec 2014

Maintained by Unclaimed.


Downloads

Total7
Week0
Month0

Installs

Apps2
powered by Segment

GitHub

Stars43
Watchers27
Forks25
Issues12
Contributors22
Pull Requests0

Code

Files34
LOCLines of Code 1,788


 
Depends on:
AFNetworking~> 1.3.0
SSKeychain= 1.2.0
AFOAuth1Client= 0.3.1
 

XINGAPI 0.1.0

  • By
  • XING iOS Team

The official Objective-C XING API Client

Build Status

XNGAPIClient is the official client to access the XING API. In order to access the API, you only need an account on https://xing.com and an oauth consumer key and secret which can be obtained at https://dev.xing.com. Both is totally free and only takes a minute!

XNGAPIClient is built on top of AFNetworking, so it takes full advantage of blocks. We also included an example project that takes care of storing your oauth token in the keychain to get you started even quicker. At the moment only iOS is supported. Not tested yet on Mac OS X.

Getting started

Option 1

If you use CocoaPods, you can add the XINGAPIClient pod to your Podfile. Then run pod install, and the XING API Client will be available in your project.

Option 2

Clone & Watch our repository by visiting https://github.com/xing/XNGAPIClient

Optain a consumer key

You can optain a consumer key and consumer secret by visiting https://dev.xing.com/applications and pressing the create app button.

Set callback URL for OAuth authentication

To authenticate the user via OAuth we switch to Safari. You need to register a callback URL that we can redirect to after successful login. Using the XING API Client your callback URL scheme will be xingapp<YOUR CONSUMER KEY>://. An example would be xingapp4a568854ef676b://

Step 1

Register your callback URL on https://dev.xing.com/applications by clicking on the settings icon next to the app you just created and entering the callback URL scheme (as described above) in OAuth Dialogue / Callback domain field.

Step 2

Register the same URL scheme in your apps Info.plist:

▾ URL Types (Array) ▾ Item 0 (Dictionary) URL Identifier (String) com.xing.xingapi ▾ URL Schemes (Array) (1 item) Item 0 (String)

Configure your App Delegate

  1. Import #import XNGAPIClient.h in your Application Delegate
  2. Add following method to your Application Delegate:
- (BOOL)application:(UIApplication *)application
            openURL:(NSURL *)url
  sourceApplication:(NSString *)sourceApplication
         annotation:(id)annotation
{
    if ([[XNGAPIClient sharedClient] handleOpenURL:url]) {
        return YES;
    } else {
        //insert your own handling
    }

    return NO;
}

Example Usage

register your consumer key and secret with the shared client:

XNGAPIClient *client = [XNGAPIClient sharedClient];
client.consumerKey = @"xXxXxXxXxXxXxXxXxXxXxX";
client.consumerSecret = @"xXxXxXxXxXxXxXxXxXxXxXxXxXxXxXxXxXxXxXxX";

login with oauth:

[client loginOAuthWithSuccess:^{
                // handle success
              }
              failure:^(NSError *error) {
                 // handle failure
              }];

make a call to load your own profile:

[client getUserWithID:@"me"
           userFields:nil
              success:^{
                // handle success
              }
              failure:^(NSError *error) {
                 // handle failure
              }];

Contact

XING AG

License

XNGAPIClient is available under the MIT license. See the LICENSE file for more info.