Olapic iOS SDK v2.0

Olapic 的 iOS SDK V2.0 包含了利用 Olapic 平台在 iOS 应用中操作的代码示例和文档。SDK 降低了 iOS 开发者构建可以利用 Olapic 核心产品和功能的应用的难度。

要开始使用 SDK，请导航到包含最新版本 SDK 的 dist/ 文件夹，其中包含 OlapicSDK.framework 文件。

您可以使用 Olapic SDK 做什么

获取媒体

iOS SDK 提供了 4 种不同的获取媒体的方式

• 客户级别：来自您的 Olapic 账户的所有已批准的照片

• 单个媒体级别：这将返回特定的媒体

• 流级别：返回特定流中的所有媒体

• 类别级别：返回特定类别中的媒体

Olapic 提供了 4 种不同的方式来排序获取的媒体

• 最近
• 随机
• Photorank
• 高点击率

上传媒体

SDK 允许直接将UGC 上传到您的 Olapic 账户。当媒体上传时，API 将返回与该UGC 相关联的用户和媒体 ID。

报告媒体

为了最佳地遵守版权法律和法规，Olapic 提供了一种简单的方法，以允许用户报告受版权保护或不适的媒体。我们的 SDK 提供了访问此功能的简易途径，以便您遵守法律指南。

管理流/类别

流是 Olapic 平台的组成部分，因此我们使通过 SDK 管理流变得简单。您将能够轻松执行以下操作：

• 获取所有流/类别的列表
• 获取特定的流/类别

用户

此功能将提供检索特定用户 UGC 并显示内容的工具。如果您感兴趣为您的客户建立包含 Olapic 中 Instagram 照片的个人资料页面，这将很有用。您需要知道您客户的 Instagram 用户名。

要求

• iOS 7.0+
• ARC
• 一个 Olapic 账户和凭证

安装

身份验证和授权

SDK 使用 OAuth 对您的账户进行身份验证并提供访问我们 API 的权限。您需要在我们帮助台打开一个工单，以获得一个 客户端 ID 和一个 密钥

客户端身份验证

您需要首先将 <OlapicSDK/OlapicSDK.h> 导入到您的文件中，然后创建一个用于身份验证的 OAuth 对象，之后告诉 SDK 使用该对象连接到我们的 API。一旦建立连接，您就可以开始使用 SDK 的所有功能。

// Setup the OAuth client ID and secret key
NSString *clientID = @"YOUR_CLIENT_ID";
NSString *secretKey = @"YOUR_SECRET_KEY";
// Instantiate the OAuth handler
OlapicOAuthForSecretKey *oauth = [[OlapicOAuthForSecretKey alloc] initWithClientId:clientID andSecretKey:secretKey];
// Connect the SDK to our API using your OAuth method
[[OlapicSDK sharedOlapicSDK] connectWithOAuthMethod:oauth onSuccess:^(OlapicCustomerEntity *customer) {
    // Everything went fine, here's your information
    NSLog(@"Ready for %@", [customer get:@"name"]);
} onFailure:^(NSError *error) {
    // Error! Something happened!
    NSLog(@"Connection Error %@", error);
}];

注意：将 YOUR_CLIENT_ID 和 YOUR_SECRET_KEY 替换为 Olapic 提供的信息。

获取媒体列表

连接完成后，成功回调将返回 Customer 实体，您可以使用该实体获取媒体对象列表。

list = [[OlapicCustomerMediaList alloc] initForCustomer:customer delegate:self sort:SORTING_TYPE mediaPerPage:NUMBER_OF_MEDIAS_PER_PAGE];

list 变量应该是一个 OlapicCustomerMediaList 对象，可用的 SORTING_TYPE 有 [OlapicMediaListSortingTypeRecent, OlapicMediaListSortingTypeShuffled, OlapicMediaListSortingTypePhotorank, OlapicMediaListSortingTypeRated]。

接下来，您需要使用 [list startFetching]; 来获取所有媒体，这将执行带有信息的委托方法。

-(void)OlapicMediaList:(OlapicMediaList *)mediaList didLoadMedia:(NSArray *)media withLinks:(NSDictionary *)links;
-(void)OlapicMediaList:(OlapicMediaList *)mediaList didReceiveAnError:(NSError *)error

文档

您可以在 http://docs.photorank.me/ios/ 上找到每个类的文档。

开始制作令人惊叹的应用

一旦安装并准备就绪 SDK，通过将 Olapic SDK 头文件添加到任何实现文件中开始使用它。要导入头文件，请将以下行添加到您的代码中

#import <OlapicSDK.h>

许可

iOS 的 Olapic SDK 在 MIT 许可下可用。有关更多信息，请参阅 LICENSE 文件。