Cleeng iOS SDK Documentation

Target Audience:

Target audience of this iOS SDK documentation, is/are application developer(s) from Cleeng’s video publisher clients & who would like to create an iOS application with worrying less about the application’s integration with Cleeng API platform.

Pre-requisites:

It is assumed that the user of this SDK would already know iOS based application development/programming environment/terminology used. Also it is noted that this SDK does not present complete features/capability that Cleeng platform. You are encouraged to visit Cleeng’s API documentation & add value to this SDK.

Integrating SDK in your Project:

To align with iOS terminology, we will refer the SDK as “framework” here onwards.

Once you download the framework application from Cleeng’s github location, you need to build the application as you do with iOS application environment. It will generate the framework file into the Products folder as display in following fig:

Methods in Framework:

Framework has two methods as follows:

  • getCustomerTokenByTransactionID
  • getAccessGranted

How to use:

getCustomerTokenByTransactionID

This method will accept one parameter named receiptNumber and will return the completion handler with data, response, error parameters. You can parse and use them accordingly in your app.

getAccessGranted

This method will accept three parameters named customerToken (received by getCustomerTokenByTransactionID), eventOfferID, and deviceID. It will return the completion handler with data, response, error parameters. You can parse and use them accordingly in your app.

Terminology

receiptNumber : The transaction number / receipt number that end customer receive in their email notification sent by Cleeng.

eventOfferID : The offer Id for an event as available in Cleeng Admin

deviceID : The deviceID identifier of user device. If needed, the actual deviceID can be encrypted to another unique string to use.

Reference

https://github.com/Cleeng/cleeng-ios-sdk