> ## Documentation Index
> Fetch the complete documentation index at: https://docs.almedia.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Prerequisites

> What to have in place before engineering starts on an Almedia Link integration.

Engineering time for the SDK integration is short — about 15 minutes. The work worth doing
first is everything around it, so that a working integration can actually go live rather than
sitting behind a missing account or an unconfigured MMP.

## Accounts and access

Your account manager is the route for all of this. Send three things:

1. **Your app IDs** — bundle ID for iOS, package name for Android.
2. **Unattributed MMP events**, shared with Almedia across all media sources. See
   [Attribution](#attribution) below.
3. **A deep link into your game**, if you have one. Strongly recommended, not required.

In return, Almedia creates your campaign and offers, and issues your **integration keys** —
one per platform. Treat the keys as configuration rather than secrets, but keep them out of
public repositories.

> [!WARNING]
>
> **Do not start end-to-end QA before the campaign exists and the keys are issued.** Testing
> earlier does not prove anything, and it is where most "it doesn't work" reports come from.

A deep link lets the Play button on Freecash reopen your game directly. Without one, players
come back via your store page. Anything that opens your app today works — an Adjust,
AppsFlyer or Singular link, or a scheme like `mygame://`. No release needed to supply it.

### Your dashboard

You also get an account on the Almedia Platform at
[app.almedia.ai](https://app.almedia.ai). Your account manager sends the invite by email — you
set a password and sign in.

It shows your Link performance: revenue, players linked, CPA and ROAS, filtered by date range,
app, platform and country.

It is also the number you invoice from. Each month, take the figure from the dashboard and
invoice Almedia for it.

> [!NOTE]
>
> The dashboard is not live. It syncs at intervals, so today's numbers are not final.

## Attribution

Almedia Link reports through your existing MMP, configured in your own dashboard rather than
anywhere on Almedia's side. This is usually owned by growth or UA rather than product, but it is
a real dependency — it has to be done before launch, and it can run in parallel with the
engineering work.

> **[MMP Setup](https://docs.almedia.dev/publisher/mmp.md)**
>
> Step-by-step setup for Adjust, AppsFlyer and Singular, with screenshots.

## Decisions to make before you build

Five, in rough order of how expensive they are to revisit.

**Which experiences to enable.** Link, Reward Progression and the Earn Tab ship through one
integration, but each has its own launch steps. See [Experiences](https://docs.almedia.dev/publisher/experiences.md).

**Where the entry point sits.** The screen you choose is the single biggest lever on
install-to-link rate.

**Prebuilt button or your own UI.** Four button styles ship with the SDK and manage their own
visibility. Your own UI is a single call plus a status subscription — more control, slightly
more work. Both are themeable.

**Whether linking earns an in-game reward.** If it does, the SDK gives you a hook that fires
exactly once per player, so you do not need deduplication logic of your own.

**How you want postbacks.** Through your MMP, or to an endpoint you host. Postbacks are
optional and do not block go-live — most publishers want them for real-time revenue
monitoring on their own side.

## Ready-to-launch checklist

One checklist per experience. Link comes first; the other two build on it.

### Link

1. Configure your MMP to share unattributed data for your game with Almedia. **Send** a
   screenshot of the setup.
2. **Send** your game IDs, your deep link, and your preferred `link_success` postback setup —
   MMP or your own server. **Receive** your SDK integration key.
3. Integrate the SDK into your game.
4. *Strongly recommended, not required:* build your own popup. **Send** screenshots for
   feedback.
5. Test: the popup matches the guidelines, linking works, the linking notification works.
6. Go live.

### Reward Progression

1. Add a button on your main screen to open Freecash rewards. Use your own, or one of the four
   that ship with the SDK.
2. Test: the button shows for linked players and opens the reward hub. **Send** screenshots
   for feedback.
3. Go live.

### Earn Tab

1. **Send** your in-game currency name, the amount rewarded per downloaded game, your currency
   art and banner art. Your account manager will send you a short survey for this.
   **Receive** your personalised Earn Tab UI.
2. Confirm your postback setup for *install* and *install plus first task completed* — same
   route as Link.
3. Ask Almedia to enable the Earn Tab for your integration.
4. Test that the Earn Tab appears for an eligible linked player. **Send** screenshots for
   feedback.
5. Go live.

> [!NOTE]
>
> Once these are in place, engineering can pick up the
> [integration guide](https://docs.almedia.dev/technical/integration-guide.md), and
> [For QA](https://docs.almedia.dev/qa.md) covers signing the result off.

***

*Unfamiliar with a term on this page? The [glossary](https://docs.almedia.dev/overview/glossary.md) explains the
vocabulary used across this site.*


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.