Promotions SDK
From ePrize Developers Wiki
m (→Summary - Adding v2.0 notes for push notifications) |
(→Summary) |
||
| (6 intermediate revisions not shown.) | |||
| Line 1: | Line 1: | ||
== Summary == | == Summary == | ||
| - | The HelloWorld | + | The HelloWorld Promotions SDK is designed to be an easy and practical way to retrieve a list of active promotions your organization is running with HelloWorld, Inc. Once you retrieve a list of active promotions, you can use the SDK to launch a given promotion using an instance of the SDK's built-in web view controller, where the specified promotion will be loaded into a customizable web view and presented to the user - all while remaining in your mobile application. |
| - | + | Please note that Mobile SDK has been renamed to Promotions SDK for clarity purposes, but as you implement the code you may still see references to “Mobile SDK.” For all intents and purposes, these are the same thing. | |
== Sample Client Keys for Testing == | == Sample Client Keys for Testing == | ||
| - | As you will see in the OS-specific documentation, you will need to configure the HelloWorld | + | As you will see in the OS-specific documentation, you will need to configure the HelloWorld Promotions SDK with your public client key in order to retrieve a list of active promotions. Since your organization may not have any active promotions available when developing and integrating the SDK into your mobile app, we have provided three sample client keys: |
<ul> | <ul> | ||
| Line 31: | Line 31: | ||
<ul> | <ul> | ||
| - | <li>[http://www.helloworld.com/assets/mobile/HelloWorld%20Mobile%20SDK%20License%20Agreement.pdf | + | <li>[http://www.helloworld.com/assets/mobile/HelloWorld%20Mobile%20SDK%20License%20Agreement.pdf Promotions SDK License Agreement]</li> |
</ul> | </ul> | ||
Current revision
Contents |
Summary
The HelloWorld Promotions SDK is designed to be an easy and practical way to retrieve a list of active promotions your organization is running with HelloWorld, Inc. Once you retrieve a list of active promotions, you can use the SDK to launch a given promotion using an instance of the SDK's built-in web view controller, where the specified promotion will be loaded into a customizable web view and presented to the user - all while remaining in your mobile application.
Please note that Mobile SDK has been renamed to Promotions SDK for clarity purposes, but as you implement the code you may still see references to “Mobile SDK.” For all intents and purposes, these are the same thing.
Sample Client Keys for Testing
As you will see in the OS-specific documentation, you will need to configure the HelloWorld Promotions SDK with your public client key in order to retrieve a list of active promotions. Since your organization may not have any active promotions available when developing and integrating the SDK into your mobile app, we have provided three sample client keys:
- dev_none (no active promotions)
- dev_one (one active promotion)
- dev_multi (more than one active promotion)
While developing, we recommend that you test with all three client keys in an effort to ensure your app is able to handle all of the different scenarios you could encounter when retrieving the list of active promotions: no active promotions, one active promotion, and more than one active promotion.
If you use these sample client keys for testing, be sure to replace it with your actual client key before exporting the final release build of your app.
Documentation
Presently, HelloWorld offers this SDK for the following operating systems:
