Tournaments Implementation Guide

Step by step approach to getting started with the Lucra Tournaments product

Briefing

By the end of this implementation guide, users on your platform will be able to find and join real money or free to play tournaments, increasing engagement in your ecosystem. You'll also learn how to submit scores for tournament participants in a robust, seamless fashion.

There are many ways to integrate the Tournament Lucra Product, this guide focuses on leaning on the client side Lucra SDK to standup the UI within your application. If you're looking for other approaches, such as headless integrations, see SDKs & APIs and Headless tournaments

Prerequisites

• Your Lucra account must have Tournaments enabled and predefined Games to associate with created Tournaments

• You must have created at least one Tournament and available to join. Read more about Tournament creation here

Tournament creation can be done through the Lucra Console or ask your Lucra representative for assistance

• Obtain Lucra Keys for your application, two apiKey values, one for sandbox environment and another for production environment.

Lucra API Keys

Step by step guide

1

Install & Initialize the SDK

Install a Lucra client SDK and confirm initialization is successful.

Install

iOS

Project Setup (iOS)

Javascript

Android

React Native

Initialize the SDK

With the provided apiKey you can now initialize the LucraClient SDK on your platform

iOS

LucraClient Initialization (iOS)

Javascript

Android

React Native

2

Apply brand theming

Provide brand colors and images to make the Lucra experience as familiar as your own

Branding & Theming

3

Configure your user

This is an optional but highly recommended step.

When a user logs into Lucra for the first time, they are given a randomly generated name and will have no other identifying properties beyond the phone number they used to two-factor-authenticate into the experience.

If a user has previously logged into Lucra within a different Lucra client product using the same phone number, their information will be merged and can be automatically verified if their account is still in good standing.

Upon attempting to join a tournament, or deposit money, they will be prompted for identifying information such as email, age and location so that we can verify they are compliant to proceed.

Supplying the information you have for the current user ahead of their journey through the Lucra SDK can streamline the experience for a number of reasons:

• Pre fill user information such as name, city, state, zip, address and email

• Pre fill and lock the phone number used to login

• Predefine their username so that the Lucra account is familiar to your platform's account

• Supply arbitrary metadata to Lucra users (more on this below!)

To avoid compliance issues, we recommend sending identifying information that is accurate and up to date.

Find your client configure user Lucra SDK docs here

iOS

Headless Functionality (iOS)

Javascript

Android

React Native

How user metadata can streamline your Tournaments implementation

At the point where you're ready to send scores for participants in specific Tournaments, you'll need a way to identify the participant and the tournament. While you can do this by providing Lucra User IDs and Lucra Tournament IDs, this requires non-trivial binding of your user's with their respective Lucra User IDs, as well as the Tournaments themselves.

This is where user metadata comes in. You can simply provide your user's internal ID to their Lucra User's metadata, and send scores with this metadata for our systems to quickly identify who you're referring to. This allows you to proceed without any additional overhead of keeping track of Lucra Users and Lucra Tournaments.

Read more about user linking and score ingestion here

User Linking & Score Ingestion

4

Setup Convert to Credit support

This is an optional step, the Lucra SDK will not show Convert to Credit options if not provided

Convert to credit functionality allows users to convert their real money earnings into a defined currency of your choosing. An example would be converting $10 for 120 tokens within your ecosystem.

Learn more here:

Convert to Credit

Find your platform technical convert to credit docs here:

iOS

Convert to Credit (C2C) Support — iOS

Javascript

Android

React Native

Server to Server

Successful server to server integration is required for a successful convert to credit implementation

5

Enable Apple Pay, Paypal, Venmo for payments

This is an optional step, a default payment processor comes out of the box.

If Apple Pay enablement is desired for iOS, ReactNative and Javascript, please reach out to Lucra for further assistance

Read more here

Payments

Find your platform technical payment docs here

iOS

Payments (iOS)

Javascript

Android

React Native

6

Guide users to join their first tournament

At this point, the Lucra SDK is ready get your users involved in your available tournaments. Lucra will handle user authentication, user identification, and any compliance forms required for joining your tournaments.

This requires intentional action by your platform to launch the Lucra Tournaments experience within your platform

Find your platform Tournament flows docs here

iOS

Tournaments Lucra Flows

Javascript

Android

React Native

If you don't see any available tournaments, see the Prerequisites section

7

Listen for key events

Depending on your integration, you might need to know when users take certain actions. This can be for many reasons, including, but not limited to, the following:

• Know when a user joins a tournament

The Lucra SDKs, APIs and Webhooks allow you to be in tune with much of the user's and matchup's lifecycle.

Client SDKs

Setup client side event listeners with the technical docs here

iOS

Tournament Events

Javascript

Android

React Native

Server Webhooks

Setup your backend to receive webhooks here

Tournament Webhooks

8

Send scores for Tournament participants

At this point, you have users that have joined your tournament(s). The Lucra Tournaments product will handle paying out winners upon the completion of this tournament, but first, Lucra needs to know the scores of the participants to correctly rank them.

There are multiple way to send scores for tournaments, regardless of the approach, there are required details you'll need to provide Lucra before sending scores.

1. User participant identifying information

2. Tournament identifying information

We'll discuss how to obtain both of these requirements in the approaches below

---

Sending scores with the Metadata API approach (recommended)

Recall the configure user metadata step above? We have APIs to consume scores given user and tournament identifying information, if you only know the metadata you've identified your users with and the game type of the score they just registered, that's all you need to send to apply it to your user's score in the tournament!

Lets walk through the required details in this scenario

1. User participant identifying information

   1. The user's metadata, the user's phone number

2. Tournament identifying information

   1. The tournament's metadata or tournament's gameId

Lucra User ID and Lucra Tournament IDs can also be supplied as identifiers, albeit, requiring the overhead of binding on your platform ahead of time.

A common approach is to send scores for your users as soon as you know they scored any type of score for any game you have registered with Lucra. Our APIs are designed to gracefully identify if your users are involved in any open tournaments expecting scores, removing the need for you track what tournaments users are participants of.

Read more about user linking and score ingestion below

User Linking & Score Ingestion

Read more about tournament metadata creation via API

Tournaments REST API

---

Sending scores via the Console (Beta)

You can manually set scores for participants via the Lucra Console. Ideal for smaller controlled Tournaments.

Read more here

Lucra-Owned Tournaments

---

Sending scores with Lucra IDs via API

If you have built the binding abstraction to link your users with their respective Lucra IDs, as well as your active Tournaments with Lucra matchup IDs, we have other APIs readily available for you to hit with those IDs.

Read more here

Tournaments REST API

9

Complete your Tournament

Scores have been submitted, the leaderboard is packed, and the gameplay has completed, you now need to complete the tournament so your winners can get paid.

Lucra Tournaments will not automatically complete and send payouts, regardless of the end date specified with the Tournament.

This can be done in two ways, with the Lucra Console or via API.

Read more about the Console approach here

Lucra-Owned Tournaments

Read more about the API approach here

Tournaments REST API

While real-time scores are ideal for the Lucra leaderboard experience, they are only required to be provided at the time of completing a Tournament

10

Test end-to-end

At this point, testing the full integration will likely be on your to-do list. This is where our sandbox environment comes in. This environment allows you to simulate a production environment with test users and money transactions that don't impact anyone's bank account.

Read more here

Testing

When testing your Lucra SDK and API integration, be sure to use your provided sandbox keys for both client side SDKs and API endpoints.

---

Tournament Platform Technical Documentation

iOS

Tournaments

Javascript

Android

React Native

APIs & Webhooks

---

Headless Tournament Support

This guide focused on the idea that users will find and join tournaments through the Lucra SDK experience, where Lucra handles the various layers of guiding users through authentication, age & location compliance, as well as adding funds when necessary.

Depending on your platform, you may already have concepts of tournaments and would rather have your users join Lucra tournaments through a "headless" fashion.

We support this idea through our headless functionality offered within our Mobile client side SDKs

While joining tournaments can be done headlessly, you will still be required to guide your users through the Lucra SDK experience to do the following required actions

• Authenticate

• Add / Withdrawal funds

• Submit identification form for age and location compliance

• Collect demographic information for free to join tournaments

Read more about our mobile client side headless Tournament SDKs

iOS

Tournament API

Android

React Native

Headless Tournament functionality is only supported on our mobile SDKs

---

Common troubleshooting

The Lucra SDK says I'm unauthorized after launching a Flow

Be sure to double check your provided apiKey(s) and the environment you're pointing to. Each platform (web, mobile, server) have a respective key per environment

Lucra says my account is suspended

Our compliance ruleset will suspend accounts for a number of different reasons due to suspicious activity. If you don't think your account should be suspended, please reach out to Lucra for assistance.

I can't see the Tournament I created

A tournament may not populate within the Lucra SDK experience for a number of reasons

• It's end date is in the past

• It's location is in a different location than what the user has selected

Double check your tournaments properties to make sure it's upcoming or live, as well as the location it's tied to

The score I sent isn't applying to the tournament

Scores abide to a strict rule set, the participant must be expecting a score, meaning they have an open attempt, and the tournament must not be completed.

Not finding the answers you're looking for? Reach out to your Lucra representative for further assistance