iOS SDK

Overview

WINR lets you add daily-entry sweepstakes and prize experiences to your app with a single configuration call. The SDK automatically opens the experience on the first app-open of each day, captures the user, and claims their daily entries — no scheduling or session logic on your side. You customize your logo, prize image, and brand color from the WINR dashboard; everything else is managed server-side.

Requirements

Installation

Swift Package Manager (Recommended)

1. In Xcode, go to File → Add Package Dependencies
2. Enter the repository URL:

https://github.com/AVAFLI/winr_ios_sdk.git

3. Select version 2.9.0 or later
4. Add WINRSDK to your app target

CocoaPods

Add the pod to your Podfile and run pod install:

pod 'WINRSDK', '~> 2.8'

Quick Start

The simplest integration requires just two calls:

import WINRSDK

let config = WINRConfiguration(
    apiKey: "YOUR_API_KEY",  // debug builds: use your winr_test_ sandbox key
    bundleId: "com.example.myapp",
    user: WINRUser(
        id: "user_123",             // only id is required — pass whatever identity you have
        firstName: "Jane",
        lastName: "Doe",
        email: "jane@example.com"   // include it when you have it — pre-fills & locks the capture form
    ),
    // Nobody signed in? use user: .guest
    options: WINROptions(
        logging: .error,            // use .debug while integrating
        enablePushReminders: true   // streak reminders via YOUR Firebase project
    )
)
WINR.configure(config)

// Done — the experience auto-opens once per day.
// Push reminders: forward your FCM token: WINR.didReceiveFCMToken(token)

The experience opens itself on the first app-open of each day — there is no manual launch API. Presentation timing, the daily cadence, and dismissal are fully managed by the SDK.

Push Notifications

Drive re-engagement with daily reminders — sent through your own Firebase project. Forward your FCM registration token (and the standard APNs callbacks) to WINR:

// In your AppDelegate
// MessagingDelegate — server pushes need the FCM token
func messaging(_ messaging: Messaging, didReceiveRegistrationToken fcmToken: String?) {
    if let fcmToken { WINR.didReceiveFCMToken(fcmToken) }
}

func application(
    _ application: UIApplication,
    didRegisterForRemoteNotificationsWithDeviceToken deviceToken: Data
) {
    WINR.didRegisterForRemoteNotifications(deviceToken: deviceToken)
}

Reminders are sent through your own Firebase project — upload your Firebase service account key via the WINR Dashboard, and forward your FCM registration token with WINR.didReceiveFCMToken(token). Apps without Firebase Messaging fall back to daily local reminders automatically.

SDK Features