TIKI SDK (Flutter) —Data Licensing #

The TIKI SDK for JavaScript makes it easy to add data licensing to your web 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.

Install the dependency using Flutter

flutter pub add tiki_sdk_flutter

This will add a line like this to your package's pubspec.yaml (and run an implicit flutter pub get):

dependencies:
  tiki_sdk_flutter: ^2.1.6

Make sure your project's Android minSdkVersion to is set to at least 19 in [project]/android/app/build.gradle.

android {
    ...
    defaultConfig {
        ...
        minSdkVersion 19
        ...
    }
}

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.

await TikiSdk.config()
  .theme
  	.primaryTextColor(Color(0xFF1C0000))
  	.primaryBackgroundColor(Color(0xFFFFFFFF))
  	.secondaryBackgroundColor(Color(0xFFF6F6F6))
  	.accentColor(Color(0xFF00B277))
  	.fontFamily("Space Grotesk")
  	.and()
  .offer
  	.description("Trade your IDFA (kind of like a serial # for your phone) for a discount.")
  	.reward(Image.asset("<path>/reward.png"))
  	.bullet("Learn how our ads perform", true)
  	.bullet("Reach you on other platforms", false)
  	.bullet("Sold to other companies", false)
  	.terms("<path>/terms.md")
  	.ptr("db2fd320-aed0-498e-af19-0be1d9630c63")
  	.tag(TitleTag.deviceId())
  	.use([LicenseUsecase.attribution()])
  	.add()
  .initialize("<your-publishing-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.

TikiSdk.present(context);

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

TikiSdk.settings(context);

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 #

/lib: The primary implementation source for the library.
- /ui: Declarative UI flows and widgets.
- /assets: Bundled assets such as graphics and fonts.
/integration_tests: Requires a device or simulator.
/example_app: Simple example app showing how to get started configuring and adding the SDK to a basic Flutter app.