TIKI SDK (iOS) —Consumer Data Licensing

The TIKI SDK for iOS makes it easy to add consumer data licensing to your iOS applications. It's the client-side component that your users will interact with to accept (or decline) data licensing offers. TIKI's SDK creates immutable, digitally signed license records using cryptographic hashing, forming an audit trail. Programmatically consume records and enforce terms client or server-side using developer-friendly data structures and APIs.

This library includes both configurable pre-built UI flows/elements and native low-level APIs for building custom experiences.

Get started with our 📚 SDK docs, or jump right into the 📘 API reference.

Installing

Note: Before you get started, you will need a Publishing ID. It's free to create one; simply log in to our 🧑‍💻 Developer Console and create a new Project.

Add the Swift Package repository (this repository): https://github.com/tiki/tiki-sdk-ios

If you're unfamiliar with the Swift Package Manager, check out Apple's instructions.

• If you're running in debug mode and intend to use the Simulator, you're all set.
• If you're ready to deploy a release version, set your package repository to the latest release version. At the time of writing, it's 2.0.3, but make sure to check the registry. We release often.

That's it. And yes, it's really that easy.

Initialization

Initialize the TIKI SDK in minutes with the TIKI pre-built UI and a custom data offer —just 1 builder function (interactive example).

try? TikiSdk.config()
    .theme
        .primaryTextColor(Color(red: 0.11, green: 0, blue: 0))
        .secondaryTextColor(Color(red: 0, green: 0, blue: 0).opacity(0.6))
        .primaryBackgroundColor(Color(red: 1, green: 1, blue: 1))
        .secondaryBackgroundColor(Color(red: 0.96, green:0.96, blue:0.96))
        .accentColor(Color(red: 0, green: 0.7, blue: 0.44))
        .fontFamily("SpaceGrotesk")
        .and()
    .offer
        .description("Trade your IDFA (kind of like a serial # for your phone) for a discount.")
        .reward("offerImage")
        .bullet(text: "Learn how our ads perform ", isUsed: true)
        .bullet(text: "Reach you on other platforms", isUsed: false)
        .bullet(text: "Sold to other companies", isUsed: false)
        .terms("terms")
        .ptr("db2fd320-aed0-498e-af19-0be1d9630c63")
        .tag(.deviceId)
        .use(usecases: [LicenseUsecase.attribution])
        .permission(Permission.tracking)
        .add()
    .initialize( publishingId: "<your-publishing-id>", id: "<your-user-id>")

Read about styling, selecting metadata, and desiging your offer in our 📚 SDK docs →.

UI Flows

The SDK includes 2 pre-built flows: present() and settings(). Use present() to display to the user a new data licensing offer.

try TikiSdk.present();

Use settings() to render a ...settings screen 😲 where users can change their mind and opt-out of an existing license agreement.

try TikiSdk.settings();

Contributing

• Use GitHub Issues to report any bugs you find or to request enhancements.
• If you'd like to get in touch with our team or other active contributors, pop in our 👾 Discord.
• Please use conventional commits if you intend to add code to this project.

Project Structure

This project leverages and bundles the Flutter Engine to create a bidirectional channel between the native interface and the core library.

• /Sources: The primary implementation source for the library.
  • /Ui: Declarative UI flows and elements (SwiftUI)
  • /Resources & /Media.xcassets: Bundled such as graphics.
  • /Core Bi-directional communication with the bundled tiki-sdk-dart library using the Flutter Engine.
• /Tests: Integration tests. Requires a device or simulator, open Tests.xcodeproj to run.
• /TikiSdkExample: Simple example app showing how to get started configuring and adding the SDK to a basic iOS app.

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Ricardo Gonçalves 💻 📖 🚧

Mike Audi 👀

This project follows the all-contributors specification. Contributions of any kind welcome!