NHN Cloud > SDK User Guide > IAP > iOS

Prerequisites

  1. Install NHN Cloud SDK.
  2. Enable Mobile Service > IAP in NHN Cloud console.
  3. Check AppKey in IAP.

NHN Cloud IAP Components

NHN Cloud IAP SDK for iOS consists of the following:

Service Cocoapods Pod Name Framework Dependency Build Settings
IAP NHNCloudIAP NHNCloudIAP.framework * StoreKit.framework

[Optional]
* libsqlite3.tdb
Mandatory NHNCloudCore
NHNCloudCommon
NHNCloudCore.framework
NHNCloudCommon.framework
OTHER_LDFLAGS = (
"-ObjC",
"-lc++"
);

Apply NHN Cloud IAP SDK to Xcode Projects

1. Apply using Cococapods

  • Create a Podfile and add a pod for NHN Cloud SDK.
platform :ios, '9.0'
use_frameworks!

target '{YOUR PROJECT TARGET NAME}' do
    pod 'NHNCloudIAP'
end

2. Apply NHN Cloud SDK by Downloading Binaries

Frameworks Setup

  • The entire iOS SDK can be downloaded from the Downloads page of NHN Cloud.
  • Add NHNCloudIAP.framework, NHNCloudCore.framework, NHNCloudCommon.framework, StoreKit.framework to the Xcode Project.
  • StoreKit.framework can be added in the following way. linked_storekit_frameworks

linked_frameworks_iap

Project Setup

  • Add -lc++ and -ObjC to Other Linker Flags under Build Settings.
    • Project Target > Build Settings > Linking > Other Linker Flags other_linker_flags

Capabilities Setup

  • To use NHN Cloud IAP, you must enable the In-App Purchase option in Capabilities.
    • Project Target > Capabilities > In-App Purchase capabilities_iap

Service Login

  • All products provided by NHN Cloud SDK (Log & Crash, IAP, Push, etc.) share one user ID.

Login

  • Without setting the user ID, features such as purchase, query of activated products, or query of unconsumed details are not available.
// Set user ID after service login is completed
[NHNCloudSDK setUserID:@"INPUT_USER_ID"];

Logout

// Set user ID to nil after service logout is completed
[NHNCloudSDK setUserID:nil];

Initialize NHN Cloud IAP SDK

Specification for Initialization API

// Initialize
+ (void)initWithConfiguration:(NHNCloudIAPConfiguration *)configuration;
// Set delegate
+ (void)setDelegate:(nullable id<NHNCloudInAppPurchaseDelegate>)delegate;
// Initialize and set delegate
+ (void)initWithConfiguration:(NHNCloudIAPConfiguration *)configuration
                     delegate:(nullable id<NHNCloudInAppPurchaseDelegate>)delegate;

Specification for Delegate API

  • If you register NHNCloudInAppPurchaseDelegate, you can receive notifications on purchase result and the decision of whether to proceed with promotion payment.
    • You can decide whether to proceed with the promotion payment in SDK or request payment directly when the user wants.
  • The purchases for which payment is completed by reprocessing are not delegated, but are reflected on the list of unconsumed products (for consumable products) and the list of activated subscriptions (for subscription products).
  • To receive notifications on payment result, Delegate must be set before purchase of a product.
@protocol NHNCloudInAppPurchaseDelegate <NSObject>

// Purchase succeeded
- (void)didReceivePurchaseResult:(NHNCloudPurchaseResult *)purchase;

// Purchase failed
- (void)didFailPurchaseProduct:(NSString *)productIdentifier withError:(NSError *)error;

@optional
// Select how to proceed with the promotion payment
- (BOOL)shouldAddStorePurchaseForProduct:(NHNCloudProduct *)product API_AVAILABLE(ios(11.0));
@end

Example of Initialization Procedure

#import <UIKit/UIKit.h>
#import <NHNCloudIAP/NHNCloudIAP.h>

@interface ViewController () <NHNCloudInAppPurchaseDelegate>
@end

@implementation ViewController

- (void)initializeNHNCloudIAP {
    // Initialize and set delegate
    NHNCloudIAPConfiguration *configuration = [NHNCloudIAPConfiguration configurationWithAppKey:@"INPUT_YOUE_APPKEY"];

    [NHNCloudIAP initWithConfiguration:configuration delegate:self];
}

// Purchase succeeded
- (void)didReceivePurchaseResult:(NHNCloudPurchaseResult *)purchase {
    NSLog(@"Successfully purchased");
}

// Purchase failed
- (void)didFailPurchaseProduct:(NSString *)productIdentifier withError:(NSError *)error {
    NSLog(@"Failed to purchase: %@", error);
}

// Select how to proceed with the promotion payment
- (BOOL)shouldAddStorePurchaseForProduct:(NHNCloudProduct *)product {
    /*
    * return YES;
        * Make the requested promotion payment performed in SDK.
        * Payment window will show up after initialization and login.
    */
    return YES;

    /*
    * return NO;
        * Promotion payment will be terminated.
        * After storing the product object, you can proceed with payment using the stored object at a later time.
    */
    self.promotionProduct = product;
    return NO;
}

@end

Query Product List

  • Products registered in IAP console are returned as the NHNCloudProductResponse object.
  • Among the products registered in IAP console, products that can be purchased are returned as products (NHNCloudProduct).
  • Among the products registered in IAP console, products for which product information could not be obtained from Apple Store are returned as invalidProducts (NHNCloudProduct).

Specification for Product List Query API

+ (void)requestProductsWithCompletionHandler:(nullable void (^)(NHNCloudProductsResponse * _Nullable response, NSError * _Nullable error))completionHandler;

Usage Example of Product List Query API

[NHNCloudIAP requestProductsWithCompletionHandler:^(NHNCloudProductsResponse *response, NSError *error) {
    if (error == nil) {
        NSArray<NHNCloudProduct *> *products = response.products;
        NSLog(@"Products : %@", products);

        // Failed to obtain product information from store
        NSArray<NHNCloudProduct *> *invalidProducts = response.invalidProducts;
        NSLog(@"Invalid Products : %@", invalidProducts);

    } else {
        NSLog(@"Failed to request products: %@", error);
    }
}

Product Types

Product Name Product Type Description
Consumable product NHNCloudProductTypeConsumable Consumable one-time products.
This can be used for in-game goods, coins, or products that can be purchased repeatedly.
Auto-renewable subscription product NHNCloudProductTypeAutoRenewableSubscription Products that are automatically purchased at specific interval and price.
This can be used for access to magazines and music streaming services, and advertisement removal.
Auto-renewable consumable subscription product NHNCloudProductTypeConsumableSubscription Products that are automatically purchased at specific interval and price.
This can be used to provide consumable products at specific interval and price.

Upgrade, downgrade, and modification of auto-renewable subscription products are not supported. Only one product must be registered to one subscription group.

typedef NS_ENUM(NSInteger, NHNCloudProductType) {
    // Failed to obtain product types
    NHNCloudProductTypeUnknown = 0,
    // Consumable products
    NHNCloudProductTypeConsumable = 1,
    // Auto-renewable subscription products
    NHNCloudProductTypeAutoRenewableSubscription = 2,
    // Auto-renewable consumable subscription products
    NHNCloudProductTypeConsumableSubscription = 3
};

Purchase Product

  • A purchase result is passed via NHNCloudInAppPurchaseDelegate that has been set.
  • If an app is closed during the purchase process or the purchase is interrupted due to a network error, etc., reprocessing will be performed after the IAP SDK initialization of the next app launch.
  • When you request purchase, you can add user data.
  • User data is returned in the NHNCloudPurchaseResult object of a payment result (purchase success delegate, unconsumed payment details, activated subscription, purchase restoration).
  • If the product cannot be purchased, an error indicating that the product is not available for purchase is passed via NHNCloudInAppPurchaseDelegate.
  • You can request purchase using the NHNCloudProduct object or a product ID.

Specification for Product Purchase API

// Request product purchase
+ (void)purchaseWithProduct:(NHNCloudProduct *)product;
// Add user data when requesting product purchase
+ (void)purchaseWithProduct:(NHNCloudProduct *)product payload:(NSString *)payload;
// Request purchase with a product ID
+ (void)purchaseWithProductIdentifier:(NSString *)productIdentifier;
// Add user data when requesting purchase with a product ID
+ (void)purchaseWithProductIdentifier:(NSString *)productIdentifier payload:(NSString *)payload;

Usage Example of Product Purchase API

// Request product purchase
[NHNCloudIAP purchaseWithProduct:self.products[0] payload:@"DEVELOPER_PAYLOAD"];
// or
// Request purchase with a product ID
[NHNCloudIAP purchaseWithProductIdentifier:@"PRODUCT_IDENTIFIER" payload:@"DEVELOPER_PAYLOAD"];

Query Activated Subscription List

  • Query list of activated subscriptions for the current user ID.
  • Subscription products (auto-renewal subscription, auto-renewal consumable subscription) for which payment is completed are returned as the NHNCloudPurchaseResult objects until they are expired.
  • If the user ID is the same, subscription products purchased on Android can also be queried.

Specification for Activated Subscription List API

// Query activated subscription list
+ (void)requestActivePurchasesWithCompletionHandler:(nullable void (^)(NSArray<NHNCloudPurchaseResult *> * _Nullable purchases, NSError * _Nullable error))completionHandler;

Usage Example of Activated Subscription List Query API

[NHNCloudIAP requestActivePurchasesWithCompletionHandler:^(NSArray<NHNCloudPurchaseResult *> *purchases, NSError *error) {
    if (error == nil) {
        for (NHNCloudPurchaseResult *purchase in purchases) {
            // Activate access for subscription products
        }
    } else {
        NSLog(@"Failed to request active purchases : %@", error);
    }
}];

Restore Purchases

  • Restore purchases based on the items purchased with the user's AppStore account and reflect it on the IAP console.
  • Use this feature if purchased subscription products cannot be queried or activated.
  • Restored purchases including the expired purchases are returned a an NHNCloudPurchaseResult object.
  • In case of auto-renewable consumable subscription products, if there is purchases that is not reflected, it can be queried from the unconsumed purchases after restoration.

Specification for Purchase Restoration API

// Restore purchase
+ (void)restoreWithCompletionHandler:(nullable void (^)(NSArray<NHNCloudPurchaseResult *> * _Nullable purchases, NSError * _Nullable error))completionHandler;

Usage Example of Purchase Restoration API

[NHNCloudIAP restoreWithCompletionHandler:^(NSArray<NHNCloudPurchaseResult *> *purchases, NSError *error) {
    if (error == nil) {
        for (NHNCloudPurchaseResult *purchase in purchases) {
            NSLog(@"Restored purchase : %@", purchase);
        }
    } else {
        NSLog(@"Failed to request restore : %@", error);
    }
}];

Query Unconsumed Purchases

  • An consumable product must be processed as consumed after product is provided.
  • Purchases that have not been processed as consumed are returned a an NHNCloudPurchaseResult object.
  • Auto-renewable consumable subscription products can be queried from the unconsumed purchases whenever a renewal occurs.

Specification for Unconsumed Purchase Query API

// Query Unconsumed Purchases
+ (void)requestConsumablePurchasesWithCompletionHandler:(nullable void (^)(NSArray<NHNCloudPurchaseResult *> * _Nullable purchases, NSError * _Nullable error))completionHandler;

Usage Example of Unconsumed Purchase Query API

[NHNCloudIAP requestConsumablePurchasesWithCompletionHandler:^(NSArray<NHNCloudPurchaseResult *> *purchases, NSError *error) {
    if (error == nil) {
        NSLog(@"Consumable Purchases : %@", purchases);
    } else {
        NSLog(@"Failed to request consumable : %@", error);
    }
}

Consume Consumable Products

  • Consumable products must be processed as consumed through REST API or Consume API of SDK, after products are provided.

Specification for Consumption API

+ (void)consumeWithPurchaseResult:(NHNCloudPurchaseResult *)result
                completionHandler:(nullable void (^)(NSError * _Nullable error))completionHandler;

Usage Example of Consumption API

// Query Unconsumed Purchases
[NHNCloudIAP requestConsumablePurchasesWithCompletionHandler:^(NSArray<NHNCloudPurchaseResult *> *purchases, NSError *error) {
    if (error == nil) {
        for (NHNCloudPurchaseResult *purchaseResult in purchases) {
            //  Process as Product Provided
            // ...

            // Process as Consumed after Product is Provided
            [NHNCloudIAP consumeWithPurchaseResult:purchaseResult
                              completionHandler:^(NSError *error) {
                                    if (error == nil) {
                                        NSLog(@"Successfully consumed");

                                    } else {
                                        NSLog(@"Failed to consume : %@", error);

                                        // Retreive Product Provided
                                        // ...
                                    }
                              }];
        }

    } else {
        NSLog(@"Failed to request consumable : %@", error);
    }
}

Provide Page for Subscription Products

  • For auto-renewable subscription products, users must be provided with a subscription management page.

    Apple Guide

  • Without configuring a separate UI, call URL as below to display subscription management page.

Connect to Subscription Management Page on Safari

https://buy.itunes.apple.com/WebObjects/MZFinance.woa/wa/manageSubscriptions
[[UIApplication sharedApplication] openURL:[NSURL URLWithString:@"https://buy.itunes.apple.com/WebObjects/MZFinance.woa/wa/manageSubscriptions"]];

Management page on Safari is called in the following order:

  1. Safari Opens
  2. Popup Shows: Want to open in iTunes Store?
  3. iTunes Store Opens
  4. Connected to subscription management page on a popup

Safari appears for Return to Previous App on top left on an iOS Device.

Connect to Subscription Management Page on Scheme

itms-apps://buy.itunes.apple.com/WebObjects/MZFinance.woa/wa/manageSubscriptions
[[UIApplication sharedApplication] openURL:[NSURL URLWithString:@"itms-apps://buy.itunes.apple.com/WebObjects/MZFinance.woa/wa/manageSubscriptions"]];

Management page on Scheme is called in the following order:

  1. Subscription management page of App Store is directly connected with App-to-App call.

Service App appears for Return to Previous App on top left on an iOS device.

Remain Compatible with (old) IAP SDK

  • To remain compatible with (old) IAP SDK, reprocessing is supported for incomplete purchases created by (old) IAP SDK.
  • To enable compatibility with (old) IAP SDK, additionally link sqlite3 Library(libsqlite3.tdb). linked_sqlite3

Specification for Reprocessing Incomplete Purchase API

+ (void)processesIncompletePurchasesWithCompletionHandler:(nullable void (^)(NSArray <NHNCloudPurchaseResult *> * _Nullable results, NSError * _Nullable error))completionHandler;

Usage Example of Reprocessing Incomplete Purchase

// Request for Reprocessing Incomplete Purchase
[NHNCloudIAP processesIncompletePurchasesWithCompletionHandler:^(NSArray<NHNCloudPurchaseResult *> *results, NSError *error) {
    if (error == nil) {
        for (NHNCloudPurchaseResult *purchaseResult in results) {
            // Process as Product Provided
            // ...

            // Process as Consumed after Product Provided
            [NHNCloudIAP consumeWithPurchaseResult:purchaseResult
                              completionHandler:^(NSError *error) {
                                    if (error == nil) {
                                        NSLog(@"Successfully consumed");

                                    } else {
                                        NSLog(@"Failed to consume : %@", error);

                                        // Retrieve Product Provided
                                        // ...
                                    }
                              }];
        }

    } else {
        NSLog(@"Failed to process incomplete purchases : %@", error);
    }
}];

NHN Cloud IAP Class Reference

NHNCloudIAPConfiguration

IAP configuration information which is used as a parameter for the NHN Cloud IAP initialization method.

@interface NHNCloudIAPConfiguration : NSObject <NSCoding, NSCopying>

// IAP service Appkey
@property (nonatomic, copy, readonly) NSString *appKey;
// Service zone
@property (nonatomic) NHNCloudServiceZone serviceZone;

+ (instancetype)configurationWithAppKey:(NSString *)appKey;

- (instancetype)initWithAppKey:(NSString *)appKey
NS_SWIFT_NAME(init(appKey:));

@end

NHNCloudInAppPurchaseDelegate

Lets you be notified of the purchase result and set how to perform a promotion purchase.

@protocol NHNCloudInAppPurchaseDelegate <NSObject>

// Purchase succeeded
- (void)didReceivePurchaseResult:(NHNCloudPurchaseResult *)purchase
NS_SWIFT_NAME(didReceivePurchase(purchase:));

// Purchase failed
- (void)didFailPurchaseProduct:(NSString *)productIdentifier withError:(NSError *)error
NS_SWIFT_NAME(didFailPurchase(productIdentifier:error:));

@optional
// Select how to proceed with the promotion payment
- (BOOL)shouldAddStorePurchaseForProduct:(NHNCloudProduct *)product API_AVAILABLE(ios(11.0));

@end

NHNCloudProductResponse

Lets you check the product list information.

@interface NHNCloudProductsResponse : NSObject <NSCoding, NSCopying>

// List of products that can be used for purchase, which are registered in IAP console and Apple Store
@property (nonatomic, copy, readonly) NSArray<NHNCloudProduct *> *products;
// List of products for which product information could not be obtained from Apple Store
@property (nonatomic, copy, readonly) NSArray<NHNCloudProduct *> *invalidProducts;

@end

NHNCloudProduct

Lets you check information of a product registered in NHN Cloud IAP console.

@interface NHNCloudProduct : NSObject <NSCoding, NSCopying>

// Product ID
@property (nonatomic, copy, readonly) NSString *productIdentifier;
// Product sequence number
@property (nonatomic, readonly) long productSeq;
// Product name (IAP console)
@property (nonatomic, copy, readonly, nullable) NSString *productName;
// Product type
@property (nonatomic, readonly) NHNCloudProductType productType;
// Price
@property (nonatomic, copy, readonly, nullable) NSDecimalNumber *price;
// Currency
@property (nonatomic, copy, readonly, nullable) NSString *currency;
// Local product name (AppStoreConnect)
@property (nonatomic, copy, readonly, nullable) NSString *localizedTitle;
// Local product description (AppStoreConnect)
@property (nonatomic, copy, readonly, nullable) NSString *localizedDescription;
// Local price
@property (nonatomic, copy, readonly, nullable) NSString *localizedPrice;
// Whether the product is activated or not
@property (nonatomic, readonly, getter=isActive) BOOL active;
// Store code "AS"
@property (nonatomic, copy, readonly) NSString *storeCode;

@end

NHNCloudPurchaseResult

Lets you check the purchase information.

@interface NHNCloudPurchaseResult : NSObject <NSCoding, NSCopying>

// User ID
@property (nonatomic, copy, readonly) NSString *userID;
// Store code "AS"
@property (nonatomic, copy, readonly) NSString *storeCode;
// Product ID
@property (nonatomic, copy, readonly) NSString *productIdentifier;
// Product sequence number
@property (nonatomic, readonly) long productSeq;
// Product type
@property (nonatomic, readonly) NHNCloudProductType productType;
// Price
@property (nonatomic, copy, readonly) NSDecimalNumber *price;
// Currency
@property (nonatomic, copy, readonly) NSString *currency;
// Payment sequence number payment ID
@property (nonatomic, copy, readonly) NSString *paymentSeq;
// Token used for consumption
@property (nonatomic, copy, readonly) NSString *accessToken;
// Transaction ID
@property (nonatomic, copy, readonly) NSString *transactionIdentifier;
// Original transaction ID
@property (nonatomic, copy, readonly, nullable) NSString *originalTransactionIdentifier;
// Product purchase time
@property (nonatomic, readonly) NSTimeInterval purchaseTime;
// Expiry time of a subscription product
@property (nonatomic, readonly) NSTimeInterval expiryTime;
// Whether it is promotion payment or not
@property (nonatomic, readonly, getter=isStorePayment) BOOL storePayment;
// Whether it is sandbox payment or not
@property (nonatomic, readonly, getter=isSandboxPayment) BOOL sandboxPayment;
// User data
@property (nonatomic, readonly, copy, nullable) NSString *payload;

@end

Error Codes

// IAP Error
static NSString *const NHNCloudIAPErrorDomain = @"com.nhncloud.iap";

typedef NS_ENUM(NSUInteger, NHNCloudIAPError) {
    NHNCloudIAPErrorUnknown = 0,                       // Unknown
    NHNCloudIAPErrorNotInitialized = 1,                // Not Initialized
    NHNCloudIAPErrorStoreNotAvailable = 2,             // Store is unavailable
    NHNCloudIAPErrorProductNotAvailable = 3,           // Failed to get product information
    NHNCloudIAPErrorProductInvalid = 4,                // Inconsistency of IDs between original payment and current product
    NHNCloudIAPErrorAlreadyOwned = 5,                  // Product is already owned
    NHNCloudIAPErrorAlreadyInProgress = 6,             // Request is already processing
    NHNCloudIAPErrorUserInvalid = 7,                   // Inconsistency of IDs between current user and paid user
    NHNCloudIAPErrorPaymentInvalid = 8,                // Failed to get further payment information (ApplicationUsername)
    NHNCloudIAPErrorPaymentCancelled = 9,              // Store payment cancelled
    NHNCloudIAPErrorPaymentFailed = 10,                // Store payment failed
    NHNCloudIAPErrorVerifyFailed = 11,                 // Receipt verification failed
    NHNCloudIAPErrorChangePurchaseStatusFailed = 12,   // Change of purchase status failed
    NHNCloudIAPErrorPurchaseStatusInvalid = 13,        // Unavailable to purchase
    NHNCloudIAPErrorExpired = 14,                      // Subscription expired
    NHNCloudIAPErrorRenewalPaymentNotFound = 15,       // Renewal payment information not found in receipt
    NHNCloudIAPErrorRestoreFailed = 16,                // Failed to restore
    NHNCloudIAPErrorPaymentNotAvailable = 17,          // Status of purchase inoperative (e.g. setting purchase restrictions in app)
    NHNCloudIAPErrorPurchaseLimitExceeded = 18,        // Monthly purchase limit exceeded
};

// Network Error
static NSString *const NHNCloudHttpErrorDomain = @"com.nhncloud.http";

typedef NS_ENUM(NSUInteger, NHNCloudHttpError) {
    NHNCloudHttpErrorNetworkNotAvailable = 100,        // Network is unavailable
    NHNCloudHttpErrorRequestFailed = 101,              // HTTP Status Code is not 200 or can not read request
    NHNCloudHttpErrorRequestTimeout = 102,             // Timeout
    NHNCloudHttpErrorRequestInvalid = 103,             // Request is invalid
    NHNCloudHttpErrorURLInvalid = 104,                 // URL is invalid
    NHNCloudHttpErrorResponseInvalid = 105,            // Response is invalid
    NHNCloudHttpErrorAlreadyInprogress = 106,          // Request is already in progress
    NHNCloudHttpErrorRequiresSecureConnection = 107,   // Do not set Allow Arbitrary Loads
};
TOP