XNGAPIClient 2.4.0

XNGAPIClient 2.4.0

测试已测试
语言语言 Obj-CObjective C
许可 MIT
发布最后发布2016年10月

Piet BrauerMatthias MännichRenzo CrisóstomoMartin Kim Dung-Pham维护。



  • 作者:
  • XING iOS团队

官方Objective-C XING API客户端

注意

Pod的第一个版本名为XINGAPI。这让大家感到困惑,因此我们决定将其重命名,并命名为XNGAPIClient

请注意,鉴于新XNGAPIClient的推出,XINGAPI pod将不再更新。请将您的代码库切换到未来版本。

如果您有任何问题,请打开一个问题。

Dependency Status Reference Status

XNGAPIClient是可以访问XING API的官方客户端。要访问API,您只需要在https://xing.com上有一个账户以及可以于https://dev.xing.com获得的oauth消费者密钥和密钥,这一切都是完全免费的,并且只需一分钟!

XNGAPIClient基于AFNetworking构建,因此充分利用了块。我们还提供了一个示例项目,该项目负责在密钥链中存储您的oauth令牌,以帮助您更快地开始。目前仅支持iOS。尚未在Mac OS X上测试。

入门

选项1

如果您使用CocoaPods,可以将XNGAPIClient pod添加到您的Podfile中。然后运行pod install,XING API客户端即可在您的项目中使用。

选项2

通过访问https://github.com/xing/XNGAPIClient来克隆并监视我们的仓库

获得消费者密钥

您可以通过访问https://dev.xing.com/applications并点击创建应用按钮来获得消费者密钥和消费者密钥。

为OAuth身份验证设置回调URL

您需要设置回调URL,该URL可以在用户通过Safari成功登录后调用。使用XING API客户端,您的回调URL方案将为xingapp<YOUR CONSUMER KEY>。一个示例将是xingapp4a568854ef676b

设置它只需要以下步骤

  1. 点击您的项目文件。
  2. 请确保您已选择主要目标。
  3. 点击“信息”按钮。
  4. 展开“URL 类型”部分。
  5. 按下+按钮。
  6. 以上述描述的样式添加您的方案

配置您的 App Delegate

  1. 在您的 Application Delegate 中导入 #import XNGAPI.h
  2. 向您的 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;
}

示例用法

将消费者密钥和密钥与共享客户端一起注册

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

使用 oauth 登录

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

调用加载您的个人资料

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

联系信息

XING AG

许可证

XNGAPIClient 在 MIT 许可证下可用。有关更多信息,请参阅 LICENSE 文件。