npm package: @io-tt/sdk
Description: Official TypeScript SDK for the io.tt v3 API.
Author: Sharp End Partnership Ltd.
Latest version: 3.3.0

# @io-tt/sdk · io.tt Templates SDK

Build immersive marketing experiences without back-end complexity.

The `@io-tt/sdk` is the official TypeScript SDK for [io.tt Templates](https://dashboard.io.tt) — a platform that lets you easily launch dynamic, data-driven campaigns like:

- 🏆 Raffle competitions
- 🔑 Golden Ticket promotions (QR-based instant wins)
- 😍 Loyalty stamp cards
- 🎁 On-pack gifting experiences

Using your SDK key (generated via the io.tt dashboard), you can quickly connect your front-end experience to powerful, production-ready back-end logic — no server development required.

---

## Documentation

Typescript documentation can be [found here](docs/globals.md)

---

## 📊 Architecture & Structure

The `@io-tt/sdk` acts as a lightweight frontend integration layer for io.tt's Backend-as-a-Service (BaaS) platform. Once initialized with your API key, the SDK connects your client app to secure, scalable back-end services for validation, data handling, and CRM integration.

---

## 🌐 Global Methods

These methods are available across all Experience types:

- 📝 User Data Submission
  Collect and submit user data using predefined fields (first name, last name, email, etc.) along with custom developer-defined fields. Data is routed directly to your configured CRM.

- 🔐 Experience Validation  
  Every user lands on your site through an io.tt ID (e.g. via QR code on product packaging). The ID is passed as a URL parameter (`?id=![10-char-id]`). When you configure an Experience in the io.tt dashboard, you pair it with one or more valid io.tt IDs.  
  During initialization, the SDK validates the SDK key against this ID. If no match is found, the SDK returns an error — effectively preventing invalid or unintended access.

- 🗓️ Experience Status  
  Determine if the Experience is currently active, as defined in your dashboard configuration.

- 🗂️ Receipt Upload (optional)  
  Allow users to upload proof-of-purchase as a validation method for participation or reward eligibility.

---

## 🎯 Experience-Specific Methods

Each supported Experience type has specific methods for its intended logic:

### Raffle
Allows a user to enter a prize draw. The SDK checks for eligibility, records the entry, and optionally syncs the data to your CRM.

### Golden Ticket
Validates whether a scanned QR code or token corresponds to an instant win. If the token is valid and not previously redeemed, the user wins and data is synced to the CRM.

### Loyalty Stamp Card
Lets users earn stamps by scanning packaging or entering codes. You can retrieve stamp count, award stamps, and determine card completion status to trigger reward logic.

### Gifting
Allows a user to attach a personalized message and/or media to a gift item (via QR code). The recipient can then scan the same code to reveal the message.

These methods can also accept additional custom fields (e.g., rich media, metadata) to tailor the user interaction. All methods are async and return fully typed responses.

---

## 🚀 Installation

```bash
npm install @io-tt/sdk
# or
yarn add @io-tt/sdk
# or
pnpm add @io-tt/sdk
```

---

## 🛠 Getting Started

### 1. Get Your API Key

Log into [https://dashboard.io.tt](https://dashboard.io.tt) and create a new Experience. Each Experience is paired with a unique SDK API key.

### 2. Initialize the SDK

Client-side:

```ts
import { IOTT } from "@io-tt/sdk";

const sdk = new IOTT({
  apiKey: "your-api-key"
});
```

Server-side (e.g. in Next.js API routes or middleware):

```ts
import { IOTT } from "@io-tt/sdk";

const sdk = new IOTT({
  apiKey: "your-api-key",
  userAgent: req.headers["user-agent"],
  userIP: req.ip
});
```

---

## ⚛️ Using in React with Context

```tsx
import { IOTT } from "@io-tt/sdk";
import { createContext, useContext, useMemo } from "react";

const IOTTContext = createContext<IOTT | undefined>(undefined);

export function IOTTProvider({ apiKey, children }) {
  const sdk = useMemo(() => new IOTT({ apiKey }), [apiKey]);
  return <IOTTContext.Provider value={sdk}>{children}</IOTTContext.Provider>;
}

export function useIOTT() {
  const sdk = useContext(IOTTContext);
  if (!sdk) throw new Error("useIOTT must be used within an <IOTTProvider>");
  return sdk;
}
```

### Example Methods

```ts
// Raffle: Enter a prize draw
await sdk.enterRaffle("your-experience-id", {
    uid: "user@example.com",
    firstName: "John",
    lastName: "Doe",
    email: "user@example.com",
    extra: {
      favoriteColor: "blue"
    }
}, [
    mediaFile1,
    mediaFile2
]);

// Golden Ticket: Validate win
const result = await sdk.claimGoldenTicket("experience-id", "!abcdef1234", "user@example.com");
if (result.isWinner) {
  // Show winner screen
}

// Loyalty: Claim and get stamps
await sdk.claimLoyaltyItem("experience-id", "!abc123defg", "user@example.com");
const stamps = await sdk.getStampHistory("experience-id", "!abc123defg", "user@example.com");

// Gifting: Attach digital message
await sdk.attachGiftMessage("experience-id", "!giftid123", {
  senderName: "Jane Doe",
  message: "Happy Birthday!",
  media: audioFile
});
```

---

## 📊 Analytics & Event Hooks

Track custom events and user interactions using the built-in analytics system. This allows you to analyse custom user journeys and custom KPI's.

```ts
analytics.trackEvent("add-to-cart",
    { 
        color: 'red',
        size: 'large'
    }
);
```

## 📆 TypeScript Support

This package includes full TypeScript definitions with rich types for all method parameters and return values.

---

## 📖 Documentation Scope

This README offers a high-level overview and quickstart examples. Detailed method docs and advanced guides are coming soon. In the meantime, use your code editor (like VS Code) to explore available methods via autocomplete and inline type hints.

---

## 🌎 Need Help?

Contact us at [support@io.tt](mailto:support@io.tt) or visit [dashboard.io.tt](https://dashboard.io.tt) to manage your Experience configuration and retrieve your API keys.

---

## Licnense
This SDK is released under the [Apache License](LICENSE).## License
```
Apache License
                           Version 2.0, January 2004
                        http://www.apache.org/licenses/

   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION

   1. Definitions.

      "License" shall mean the terms and conditions for use, reproduction,
      and distribution as defined by Sections 1 through 9 of this document.

      "Licensor" shall mean the copyright owner or entity authorized by
      the copyright owner that is granting the License.

      "Legal Entity" shall mean the union of the acting entity and all
      other entities that control, are controlled by, or are under common
      control with that entity. For the purposes of this definition,
      "control" means (i) the power, direct or indirect, to cause the
      direction or management of such entity, whether by contract or
      otherwise, or (ii) ownership of fifty percent (50%) or more of the
      outstanding shares, or (iii) beneficial ownership of such entity.

      "You" (or "Your") shall mean an individual or Legal Entity
      exercising permissions granted by this License.

      "Source" form shall mean the preferred form for making modifications,
      including but not limited to software source code, documentation
      source, and configuration files.

      "Object" form shall mean any form resulting from mechanical
      transformation or translation of a Source form, including but
      not limited to compiled object code, generated documentation,
      and conversions to other media types.

      "Work" shall mean the work of authorship, whether in Source or
      Object form, made available under the License, as indicated by a
      copyright notice that is included in or attached to the work
      (an example is provided in the Appendix below).

      "Derivative Works" shall mean any work, whether in Source or Object
      form, that is based on (or derived from) the Work and for which the
      editorial revisions, annotations, elaborations, or other modifications
      represent, as a whole, an original work of authorship. For the purposes
      of this License, Derivative Works shall not include works that remain
      separable from, or merely link (or bind by name) to the interfaces of,
      the Work and Derivative Works thereof.

      "Contribution" shall mean any work of authorship, including
      the original version of the Work and any modifications or additions
      to that Work or Derivative Works thereof, that is intentionally
      submitted to Licensor for inclusion in the Work by the copyright owner
      or by an individual or Legal Entity authorized to submit on behalf of
      the copyright owner. For the purposes of this definition, "submitted"
      means any form of electronic, verbal, or written communication sent
      to the Licensor or its representatives, including but not limited to
      communication on electronic mailing lists, source code control systems,
      and issue tracking systems that are managed by, or on behalf of, the
      Licensor for the purpose of discussing and improving the Work, but
      excluding communication that is conspicuously marked or otherwise
      designated in writing by the copyright owner as "Not a Contribution."

      "Contributor" shall mean Licensor and any individual or Legal Entity
      on behalf of whom a Contribution has been received by Licensor and
      subsequently incorporated within the Work.

   2. Grant of Copyright License. Subject to the terms and conditions of
      this License, each Contributor hereby grants to You a perpetual,
      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
      copyright license to reproduce, prepare Derivative Works of,
      publicly display, publicly perform, sublicense, and distribute the
      Work and such Derivative Works in Source or Object form.

   3. Grant of Patent License. Subject to the terms and conditions of
      this License, each Contributor hereby grants to You a perpetual,
      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
      (except as stated in this section) patent license to make, have made,
      use, offer to sell, sell, import, and otherwise transfer the Work,
      where such license applies only to those patent claims licensable
      by such Contributor that are necessarily infringed by their
      Contribution(s) alone or by combination of their Contribution(s)
      with the Work to which such Contribution(s) was submitted. If You
      institute patent litigation against any entity (including a
      cross-claim or counterclaim in a lawsuit) alleging that the Work
      or a Contribution incorporated within the Work constitutes direct
      or contributory patent infringement, then any patent licenses
      granted to You under this License for that Work shall terminate
      as of the date such litigation is filed.

   4. Redistribution. You may reproduce and distribute copies of the
      Work or Derivative Works thereof in any medium, with or without
      modifications, and in Source or Object form, provided that You
      meet the following conditions:

      (a) You must give any other recipients of the Work or
          Derivative Works a copy of this License; and

      (b) You must cause any modified files to carry prominent notices
          stating that You changed the files; and

      (c) You must retain, in the Source form of any Derivative Works
          that You distribute, all copyright, patent, trademark, and
          attribution notices from the Source form of the Work,
          excluding those notices that do not pertain to any part of
          the Derivative Works; and

      (d) If the Work includes a "NOTICE" text file as part of its
          distribution, then any Derivative Works that You distribute must
          include a readable copy of the attribution notices contained
          within such NOTICE file, excluding those notices that do not
          pertain to any part of the Derivative Works, in at least one
          of the following places: within a NOTICE text file distributed
          as part of the Derivative Works; within the Source form or
          documentation, if provided along with the Derivative Works; or,
          within a display generated by the Derivative Works, if and
          wherever such third-party notices normally appear. The contents
          of the NOTICE file are for informational purposes only and
          do not modify the License. You may add Your own attribution
          notices within Derivative Works that You distribute, alongside
          or as an addendum to the NOTICE text from the Work, provided
          that such additional attribution notices cannot be construed
          as modifying the License.

      You may add Your own copyright statement to Your modifications and
      may provide additional or different license terms and conditions
      for use, reproduction, or distribution of Your modifications, or
      for any such Derivative Works as a whole, provided Your use,
      reproduction, and distribution of the Work otherwise complies with
      the conditions stated in this License.

   5. Submission of Contributions. Unless You explicitly state otherwise,
      any Contribution intentionally submitted for inclusion in the Work
      by You to the Licensor shall be under the terms and conditions of
      this License, without any additional terms or conditions.
      Notwithstanding the above, nothing herein shall supersede or modify
      the terms of any separate license agreement you may have executed
      with Licensor regarding such Contributions.

   6. Trademarks. This License does not grant permission to use the trade
      names, trademarks, service marks, or product names of the Licensor,
      except as required for reasonable and customary use in describing the
      origin of the Work and reproducing the content of the NOTICE file.

   7. Disclaimer of Warranty. Unless required by applicable law or
      agreed to in writing, Licensor provides the Work (and each
      Contributor provides its Contributions) on an "AS IS" BASIS,
      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
      implied, including, without limitation, any warranties or conditions
      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
      PARTICULAR PURPOSE. You are solely responsible for determining the
      appropriateness of using or redistributing the Work and assume any
      risks associated with Your exercise of permissions under this License.

   8. Limitation of Liability. In no event and under no legal theory,
      whether in tort (including negligence), contract, or otherwise,
      unless required by applicable law (such as deliberate and grossly
      negligent acts) or agreed to in writing, shall any Contributor be
      liable to You for damages, including any direct, indirect, special,
      incidental, or consequential damages of any character arising as a
      result of this License or out of the use or inability to use the
      Work (including but not limited to damages for loss of goodwill,
      work stoppage, computer failure or malfunction, or any and all
      other commercial damages or losses), even if such Contributor
      has been advised of the possibility of such damages.

   9. Accepting Warranty or Additional Liability. While redistributing
      the Work or Derivative Works thereof, You may choose to offer,
      and charge a fee for, acceptance of support, warranty, indemnity,
      or other liability obligations and/or rights consistent with this
      License. However, in accepting such obligations, You may act only
      on Your own behalf and on Your sole responsibility, not on behalf
      of any other Contributor, and only if You agree to indemnify,
      defend, and hold each Contributor harmless for any liability
      incurred by, or claims asserted against, such Contributor by reason
      of your accepting any such warranty or additional liability.

   END OF TERMS AND CONDITIONS

   APPENDIX: How to apply the Apache License to your work.

      To apply the Apache License to your work, attach the following
      boilerplate notice, with the fields enclosed by brackets "[]"
      replaced with your own identifying information. (Don't include
      the brackets!)  The text should be enclosed in the appropriate
      comment syntax for the file format. We also recommend that a
      file or class name and description of purpose be included on the
      same "printed page" as the copyright notice for easier
      identification within third-party archives.

   Copyright [yyyy] [name of copyright owner]

   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
   You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.```
</div>