SDK de offerwall para Android. Nativo, em poucas linhas de Kotlin.
Abra o offerwall da Moonetix como uma tela nativa no seu app Android. Instale uma dependência do Gradle, crie uma sessão no seu servidor e chame open. Funciona com Kotlin, Java e Jetpack Compose.
- 5.0+Android, API 21
- 2.0.1Versão atual
- 0Permissões extras
// Once, in your Application class
Moonetix.init(applicationContext, "YOUR_APP_ID")
// When the user taps Earn
Moonetix.open(activity, token)Entre no ar em quatro passos.
Copie o código, substitua os placeholders pelos valores do seu painel em Offerwalls, seu offerwall, Integration, e teste antes de lançar.
-
Instale o SDK
Adicione o repositório Maven da Moonetix e uma dependência. O SDK adiciona sozinho a permissão de internet e a sua tela ao manifest, e já traz as próprias regras de R8 e ProGuard.
settings.gradle.ktsdependencyResolutionManagement { repositories { google() mavenCentral() maven { url = uri("https://moonetix.com/maven") } } } // app/build.gradle.kts dependencies { implementation("com.moonetix:offerwall:2.0.1") }settings.gradledependencyResolutionManagement { repositories { google() mavenCentral() maven { url 'https://moonetix.com/maven' } } } // app/build.gradle dependencies { implementation 'com.moonetix:offerwall:2.0.1' } -
Adicione um endpoint de token ao seu servidor
O seu app nunca guarda a API key. Quando um usuário toca em Earn, o seu app pede uma sessão ao seu servidor, e o seu servidor pede à Moonetix um token de uso único para aquele usuário logado. Um token funciona uma única vez, por 10 minutos.
session.php<?php // POST /api/moonetix/session: a fresh token for the signed-in user $user = current_user(); if (!$user) { http_response_code(401); exit; } $key = getenv('MOONETIX_API_KEY'); $ch = curl_init('https://api.moonetix.com/v1/session'); curl_setopt_array($ch, [ CURLOPT_POST => true, CURLOPT_POSTFIELDS => http_build_query(['user_id' => (string)$user->id]), CURLOPT_RETURNTRANSFER => true, CURLOPT_TIMEOUT => 10, CURLOPT_HTTPHEADER => ['Authorization: Bearer ' . $key], ]); $data = json_decode((string)curl_exec($ch), true); $code = (int)curl_getinfo($ch, CURLINFO_RESPONSE_CODE); header('Content-Type: application/json'); if ($code === 201 && !empty($data['token'])) { echo json_encode(['token' => $data['token']]); exit; } http_response_code($code === 403 ? 403 : 503); echo json_encode(['error' => 'offerwall_unavailable']);session.js// POST /api/moonetix/session: a fresh token for the signed-in user app.post('/api/moonetix/session', requireLogin, async (req, res) => { const r = await fetch('https://api.moonetix.com/v1/session', { method: 'POST', headers: { Authorization: `Bearer ${process.env.MOONETIX_API_KEY}`, 'Content-Type': 'application/json', }, body: JSON.stringify({ user_id: String(req.user.id) }), signal: AbortSignal.timeout(10000), }); const data = await r.json().catch(() => ({})); if (r.status === 201 && data.token) { return res.json({ token: data.token }); } const status = r.status === 403 ? 403 : 503; res.status(status).json({ error: 'offerwall_unavailable' }); });session.py# POST /api/moonetix/session: a fresh token for the signed-in user @app.post("/api/moonetix/session") @login_required def moonetix_session(): key = os.environ["MOONETIX_API_KEY"] r = requests.post( "https://api.moonetix.com/v1/session", data={"user_id": str(current_user.id)}, headers={"Authorization": f"Bearer {key}"}, timeout=10, ) data = r.json() if r.status_code == 201 and data.get("token"): return {"token": data["token"]} status = 403 if r.status_code == 403 else 503 return {"error": "offerwall_unavailable"}, status -
Abra o offerwall
Chame init uma vez com o App ID do seu painel e depois abra o offerwall com o token do seu servidor. Os erros nunca lançam exceções: eles chegam como eventos, e onClosed é um bom momento para atualizar o saldo do usuário.
EarnActivity.ktMoonetix.init(applicationContext, "YOUR_APP_ID") Moonetix.setListener(object : MoonetixListener { override fun onClosed() { refreshBalance() } override fun onError(error: MoonetixError) { Log.w("Earn", "${error.code}: ${error.message}") } }) lifecycleScope.launch { val token = fetchMoonetixToken(authToken) Moonetix.open(this@EarnActivity, token) }EarnActivity.javaMoonetix.init(getApplicationContext(), "YOUR_APP_ID"); // with a fresh token from your server Moonetix.open(activity, token);EarnButton.kt@Composable fun EarnButton(authToken: String) { val context = LocalContext.current val scope = rememberCoroutineScope() Button(onClick = { scope.launch { val token = runCatching { fetchMoonetixToken(authToken) } .getOrNull() ?: return@launch context.findActivity()?.let { Moonetix.open(it, token) } } }) { Text("Earn coins") } } -
Credite as recompensas com o postback
Cada recompensa chega ao seu servidor como um postback assinado. Verifique o hash, adicione a recompensa uma única vez por ID de transação e retire-a se um postback posterior a estornar. Postbacks com falha são reenviados até 5 vezes.
Painel, aba Postbackhttps://yoursite.com/postback?user={user_id}&tx={transaction_id}&status={status}&reward={reward}&hash={hash}postback.php<?php $tx = $_GET['tx'] ?? ''; $userId = $_GET['user'] ?? ''; $reward = $_GET['reward'] ?? ''; $status = $_GET['status'] ?? ''; $secret = getenv('MOONETIX_POSTBACK_SECRET'); $expected = hash_hmac('sha256', "$tx:$userId:$reward:$status", $secret); if (!hash_equals($expected, $_GET['hash'] ?? '')) { http_response_code(403); exit; } if ($status === '1') { credit_once($userId, $tx, $reward); // once per transaction ID } elseif ($status === '2') { reverse_if_credited($userId, $tx, $reward); } http_response_code(200);postback.jsconst crypto = require('crypto'); app.get('/postback', (req, res) => { const { tx, user, reward, status, hash } = req.query; const secret = process.env.MOONETIX_POSTBACK_SECRET; const expected = crypto.createHmac('sha256', secret) .update(`${tx}:${user}:${reward}:${status}`) .digest('hex'); const valid = typeof hash === 'string' && hash.length === expected.length && crypto.timingSafeEqual(Buffer.from(hash), Buffer.from(expected)); if (!valid) return res.sendStatus(403); if (status === '1') creditOnce(user, tx, reward); // once per transaction ID if (status === '2') reverseIfCredited(user, tx, reward); res.sendStatus(200); });postback.pyimport hmac, hashlib, os from flask import request, abort @app.get("/postback") def postback(): a = request.args parts = [a.get(k, "") for k in ("tx", "user", "reward", "status")] msg = ":".join(parts) secret = os.environ["MOONETIX_POSTBACK_SECRET"].encode() expected = hmac.new(secret, msg.encode(), hashlib.sha256).hexdigest() if not hmac.compare_digest(expected, a.get("hash", "")): abort(403) if a.get("status") == "1": credit_once(a["user"], a["tx"], a["reward"]) # once per transaction ID elif a.get("status") == "2": reverse_if_credited(a["user"], a["tx"], a["reward"]) return "", 200
Travel TownChegue ao nível 15+1,500
WPS OfficeInstalar e abrir+2,000
Bus EscapeChegue ao nível 20+450
CleanfoxSign up in the app+800
O que os seus usuários veem
Uma tela nativa sobre o seu app, com seu título e suas cores, sua moeda e cada recompensa confirmada por um postback.
O que o SDK faz por você
- As ofertas abrem no lugar certo
As ofertas que levam ao Google Play abrem no app da loja, e os outros sites abrem no navegador, para que as instalações sejam rastreadas corretamente.
- Nenhuma chave dentro do seu app
O seu app guarda apenas o App ID. As sessões são criadas no seu servidor e funcionam uma única vez, então ninguém consegue abrir o offerwall como outro usuário.
- Uma tela protegida
Somente páginas do offerwall carregam dentro dela, sem nenhuma ponte JavaScript para o seu app.
- Navegação nativa
O botão voltar navega dentro do offerwall, e a rotação da tela ou um reinício por pouca memória mantém o usuário onde ele estava.
- O seu design, sem código extra
A tela usa o título e as cores da aba Design do seu painel e aplica as mudanças em poucos minutos.
- Sem ID de publicidade
O SDK não usa o identificador de publicidade e não rastreia usuários entre apps.
Teste e depois lance.
Tudo o que você precisa verificar antes que usuários reais vejam o seu offerwall, com as ferramentas integradas ao seu painel.
Open as a test user
Em Integration status, na aba Integration, abra o seu offerwall como o usuário owner-test. Visitas de teste não são contadas como usuários.
Execute em um dispositivo real
Gere o build para Android ou iOS e abra o offerwall pelo seu botão Earn com um token novo a cada vez.
Send a test postback
Escolha o usuário, o status e o pagamento, e veja exatamente o que o seu servidor respondeu, com o código de resposta e o tempo. Os IDs de transação de teste começam com test_.
Teste a partir de uma conexão normal
VPNs, proxies, Tor e redes de nuvem são bloqueados, então teste no Wi-Fi de casa ou nos dados móveis, em um país onde haja ofertas ativas.
Checklist de lançamento
0 de 11 prontos
Pronto para lançar. Seu progresso fica salvo neste navegador.
Erros comuns, resolvidos rápido.
O que pode aparecer enquanto você integra o Android SDK, a causa e a solução.
INVALID_APP_IDO valor passado para init não é o App ID. Passar a API key aqui é o erro mais comum.
SoluçãoCopie novamente o App ID de 24 caracteres na aba Integration.
INVALID_TOKENO app passou algo diferente do token, ou um token criado com a API key de outro app.
SoluçãoPasse apenas o campo token, que começa com sst_, e use o App ID e a API key do mesmo app.
TOKEN_EXPIRED_OR_USEDO token tem mais de 10 minutos ou já foi usado, por exemplo guardado de um toque anterior.
SoluçãoCrie um novo token a cada abertura, logo quando o usuário tocar em Earn.
NOT_INITIALIZEDopen foi chamado antes de init.
SoluçãoChame Moonetix.init em Application.onCreate.
UNKNOWNO Android System WebView está ausente ou desativado, ou a Activity que você passou já estava fechando.
SoluçãoPeça ao usuário para atualizar o Android System WebView e passe uma Activity que esteja na tela.
onClosed never arrivesO listener foi limpo no onStop, ou pertencia a uma tela que não existe mais.
SoluçãoDefina-o no onCreate e limpe-o no onDestroy, ou defina-o uma vez na sua Application.
403 from /v1/sessionapp_not_live significa que o app está pausado ou que a sua conta não está ativa. user_blocked significa que bloqueamos esse usuário.
SoluçãoNão mostre o offerwall. Para app_not_live, confira suas notificações.
VPN or Proxy detectedO dispositivo está em uma VPN, um proxy ou uma rede de nuvem, onde as ofertas não podem ser rastreadas.
SoluçãoTeste em uma conexão residencial ou móvel normal, em um país onde haja ofertas ativas.
Postback log shows 403 or 404O seu script rejeitou o postback, ou a URL está errada.
SoluçãoAbra a URL do log em um navegador e confira o seu código de hash.
Postback log shows a timeoutO seu script leva mais de 6 segundos para responder.
SoluçãoResponda primeiro com 200 e execute o trabalho demorado em segundo plano.
Postback log shows 301 or 302A sua URL redireciona, por exemplo de http para https.
SoluçãoUse a URL final. Os postbacks não seguem redirecionamentos.
Nenhum resultado. Veja a lista completa na documentação ou fale conosco.
Em resumo
- Versão mínima
- Android 5.0 (API 21), com Android System WebView ou Chrome
- Linguagens
- Kotlin, Java e Jetpack Compose
- Pacote
- com.moonetix:offerwall:2.0.1 de moonetix.com/maven
- Dependências
- Apenas a biblioteca padrão do Kotlin
- Permissões
- Apenas internet, adicionada pelo SDK
- Preço
- Gratuito para publishers aprovados
Outras integrações
- SiteUm link, um iframe ou um botão Earn flutuante. Não precisa de SDK.
- Offers APIReceba as ofertas em JSON e mostre-as com o seu próprio design.
- iOS SDKUm offerwall nativo para Swift, SwiftUI e Objective-C.
- Unity SDKOfertas com recompensa para jogos Android e iOS, em C#.
- Flutter SDKUm plugin em Dart para Android e iOS.
- React Native SDKPara apps React Native e Expo, com tipos de TypeScript.
- Todas as integraçõesCompare lado a lado.
Perguntas sobre Android
O que os desenvolvedores perguntam antes de adicionar o Android SDK.
Travou em alguma coisa? Fale conosco
Quais versões do Android o SDK da Moonetix suporta?
Android 5.0 (API 21) ou mais recente, com Android System WebView ou Chrome no dispositivo. A única dependência é a biblioteca padrão do Kotlin, então funciona em apps Kotlin e Java.
Preciso adicionar regras de ProGuard ou R8?
Não. O SDK traz as próprias regras de R8 e ProGuard e adiciona sozinho a permissão de internet e a tela do offerwall ao seu manifest.
A minha API key vai dentro do app?
Não. O seu app guarda apenas o App ID. O seu servidor cria uma sessão com a API key e passa um token para o app. Um token funciona uma única vez e por 10 minutos, então nada no seu app consegue abrir o offerwall de outro usuário.
O SDK usa o ID de publicidade?
Não. Ele não usa o ID de publicidade, não pede nenhuma permissão além do acesso à internet e não rastreia usuários entre apps. A documentação lista o que declarar no formulário Data safety do Google Play.
Como recompenso os usuários no meu app?
Credite as recompensas a partir do postback assinado no seu servidor, nunca a partir de eventos no app, porque eventos podem ser falsificados no dispositivo. Quando o usuário fechar o offerwall, carregue o novo saldo dele do seu servidor.
A tela do offerwall pode combinar com o meu app?
Sim. Ela usa o título e as cores da aba Design do seu painel. Você também pode passar o seu próprio título e a cor da toolbar, ou ocultar a marca com MoonetixOptions.
Transforme o seu tráfego em ganhos.
Crie uma conta de publisher gratuita e ganhe com cada oferta que seus usuários concluírem no seu site, app, jogo ou comunidade.