PIXNET SDK for iOS

这个 SDK 可以让您快速将 PIXNET 的相关数据整合到您的 iOS 项目中。详细的 API 信息请参考 http://developer.pixnet.pro/

这个开源库允许您将 PIXNET 集成到您的 iOS APP 中。更多信息请参考 http://developer.pixnet.pro/

安装 - Installation

强烈建议使用 CocoaPods 搜索并安装 pixnet-ios-sdk

PIXNET iOS SDK 支持 Xcode 5.0 及以上，iOS 6.0 及以上版本，并且只支持 ARC

使用 - Usage

在使用之前，请先至 PIXNET Developer 注册新的 APP。

http://developer.pixnet.pro/#!/apps

注册完成后会得到以下两把钥匙

1. 客户端密钥(client_id)
2. 客户端密钥

请使用以下代码将东西丢在您的项目中即可开始使用，通常写在 - application:didFinishLaunchingWithOptions: 中

#import "PIXNETSDK.h"

[PIXNETSDK setConsumerKey:@"Consumer Key" consumerSecret:@"Consumer Secret"];

初学者

请安装后，在需要使用的类中

#import "PIXNETSDK.h"

就可以开始使用简单功能。每个 method 都会使用 block 的方式通知您 query 后的结果，只要 succed 为 YES，result 一定不为 nil，error 必为 nil；相反的，当 succed 为 NO 时，result 一定为 nil，而 error 一定有内容。

错误处理

您可以直接使用 error.localizedDescription 告诉用户发生了什么错误，或者您也可以根据 error.code 来定制您的错误信息呈现方式。 错误代码的完整说明在这里。

高级用户

这个 SDK 总共分为三层，

• 最外层的是 PIXNETSDK.h，这里包含了所有的 method，但 method 里的参数是简化过的，方便开发者快速开发大多数的功能。
• 第二层是 PIXNET 所有开放出来的功能(例如部落格(PIXBlog.h)、相簿(PIXAlbum.h))，里面的每个 method 都有完整的参数。
• 第三层是 PIXApiHandler.h，这里提供的是将 OAuth1 及 OAuth2 包装过的各项网络连接功能。
• 每个 method 的说明里都会放 Restful API 的说明网页链接，方便您比对及查找 API 及 method 之间的关系。

示例 - Sample Code

无需认证的情况下

获取用户个人资料：

[[PIXNETSDK new] getUserWithUserName:@"UserName" completion:
 ^(BOOL succeed, id result, NSError *error) {
     if (succeed) {
         //做要做的東西
     }else{
         [[[UIAlertView alloc] initWithTitle:@"Ooops!"
                                     message:error.localizedDescription
                                    delegate:self
                           cancelButtonTitle:@"確定"
                           otherButtonTitles:nil, nil] show];
     }
 }];

认证/登录

UIWebView *webView = [[UIWebView alloc] initWithFrame:self.view.bounds];
[self.view addSubview:webView];
[PIXNETSDK loginByOAuth2OpenIDOnlyWithLoginView:webView completion:^(BOOL succeed, id result, NSError *error) {
    if (succeed) {
        // 使用者登入成功了, 接下來您可以呼叫需要認證才能使用的 method 了
        [webView removeFromSuperview];
    } else {
        // 使用者未登入成功
    }
    done();
}];

登录后即可使用需认证后才能使用的 Method。

登出

[PIXNETSDK logout];

即可登出。

详细说明文件

请参考 CocoaDocs PIXNET-iOS-SDK 说明文件

联系我们

Email: [email protected] Twitter: @pixnetapi

授权

PIXNET SDK采用BSD授权。我们还提供额外的专利许可。