iOS SDK для offerwall. Swift, SwiftUI и Objective-C.
Открывайте offerwall Moonetix в приложении для iPhone и iPad с помощью одного пакета Swift. Он использует только UIKit и WebKit, не имеет сторонних зависимостей и поставляется с манифестом конфиденциальности.
- 13+iOS и iPadOS
- 2.0.1Текущая версия
- 0Сторонние зависимости
import MoonetixOfferwall
Moonetix.configure(appId: "YOUR_APP_ID")
// When the user taps Earn
Moonetix.open(token: token)Запуск за четыре шага.
Скопируйте код, замените плейсхолдеры значениями из личного кабинета (Offerwall, ваш offerwall, Интеграция) и протестируйте перед запуском.
-
Установите SDK
Добавьте пакет в Xcode через File, Add Package Dependencies или используйте CocoaPods. Также можно скачать xcframework и встроить его вручную. Собирайте в Xcode 16 или новее.
Package.swiftdependencies: [ .package(url: "https://moonetix.com/ios/moonetix-ios.git", from: "2.0.1"), ], targets: [ .target(name: "MyApp", dependencies: [ .product(name: "MoonetixOfferwall", package: "moonetix-ios"), ]), ]Podfilepod 'MoonetixOfferwall', :podspec => 'https://moonetix.com/ios/2.0.1/MoonetixOfferwall.podspec' -
Добавьте на сервер эндпоинт для токенов
В вашем приложении никогда нет API-ключа. Когда пользователь нажимает Earn, приложение запрашивает сессию у вашего сервера, а ваш сервер запрашивает у Moonetix одноразовый токен для этого авторизованного пользователя. Токен действует один раз в течение 10 минут.
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 -
Откройте offerwall
Вызовите configure один раз с App ID из личного кабинета, затем откройте offerwall с новым токеном. Без view controller SDK показывает экран поверх верхнего экрана вашего приложения, поэтому он работает и из SwiftUI.
EarnViewController.swiftMoonetix.configure(appId: "YOUR_APP_ID") Moonetix.onClosed = { [weak self] in self?.refreshBalance() } Moonetix.onError = { error in print(error.code.name, error.message) } Moonetix.open(token: token, from: self)EarnButton.swiftButton("Earn coins") { Task { let token = try await api.fetchMoonetixToken() Moonetix.open(token: token) } }EarnViewController.m@import MoonetixOfferwall; [Moonetix configureWithAppId:@"YOUR_APP_ID"]; [Moonetix openWithToken:token from:self options:nil]; -
Начисляйте награды через postback
Каждая награда приходит на ваш сервер в виде подписанного postback. Проверьте хеш, начислите награду один раз на каждый ID транзакции и спишите ее, если последующий postback ее отменяет. Неудачные postback отправляются повторно до 5 раз.
Личный кабинет, вкладка "Postback"https://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 TownДостигните 15 уровня+1,500
WPS OfficeУстановка и открытие+2,000
Bus EscapeДостигните 20 уровня+450
CapCutSign up in the app+800
Что видят ваши пользователи
Нативный экран поверх вашего приложения: ваш заголовок и цвета, ваша валюта, а каждая награда подтверждается через postback.
Что SDK делает за вас
- Офферы открываются в нужном месте
Офферы, ведущие в App Store, открываются в приложении магазина, а другие сайты открываются в браузере, поэтому установки отслеживаются корректно.
- Никаких ключей в вашем приложении
В вашем приложении хранится только App ID. Сессии создаются на вашем сервере и действуют один раз, поэтому никто не сможет открыть offerwall от имени другого пользователя.
- Защищенный экран
Внутри загружаются только страницы offerwall, без JavaScript-моста в ваше приложение.
- Нативная навигация
Кнопка закрытия возвращает в ваше приложение, свайп от левого края возвращает назад внутри offerwall, а после возврата из фона offerwall открывается там, где остановился пользователь.
- Доступность по умолчанию
Светлая и темная тема, крупный текст и VoiceOver работают сразу.
- Манифест конфиденциальности в комплекте
SDK поставляется с манифестом конфиденциальности, не использует цифровые отпечатки устройства и не использует рекламный идентификатор.
Протестируйте, затем запускайте.
Все, что нужно проверить, прежде чем реальные пользователи увидят ваш offerwall, с помощью инструментов, встроенных в личный кабинет.
Открыть как тестовый пользователь
В блоке "Статус интеграции" на вкладке "Интеграция" откройте свой offerwall как пользователь owner-test. Тестовые визиты не учитываются как пользователи.
Запускайте на реальном устройстве
Соберите проект для Android или iOS и открывайте offerwall по кнопке Earn, каждый раз с новым токеном.
Отправить тестовый postback
Выберите пользователя, статус и выплату и посмотрите, что именно ответил ваш сервер, с кодом ответа и временем. ID тестовых транзакций начинаются с test_.
Тестируйте с обычного подключения
VPN, прокси, Tor и облачные сети блокируются, поэтому тестируйте через домашний Wi-Fi или мобильный интернет, в стране, где доступны офферы.
Чек-лист запуска
0 из 11 готово
Все готово к запуску. Ваш прогресс сохраняется в этом браузере.
Частые ошибки и быстрые решения.
Что вы можете увидеть при интеграции iOS SDK, в чем причина и как это исправить.
INVALID_APP_IDЗначение, переданное в init, не является App ID. Самая частая ошибка - передать сюда API-ключ.
РешениеСкопируйте 24-символьный App ID заново на вкладке "Интеграция".
INVALID_TOKENПриложение передало что-то кроме токена или токен, созданный с API-ключом другого приложения.
РешениеПередавайте только поле token, которое начинается с sst_, и используйте App ID и API-ключ одного и того же приложения.
TOKEN_EXPIRED_OR_USEDТокену больше 10 минут или он уже использован, например сохранен после предыдущего нажатия.
РешениеСоздавайте новый токен для каждого открытия, сразу когда пользователь нажимает Earn.
NOT_INITIALIZEDopen был вызван до init.
РешениеВызовите Moonetix.configure при запуске приложения.
UNKNOWNOfferwall уже открыт, или на экране не было view controller, из которого его можно показать.
РешениеОткрывайте не больше одного экземпляра за раз и передавайте видимый view controller в open(token:from:).
Delegate is never calledMoonetix.delegate - слабая ссылка, поэтому объект уже был освобожден.
РешениеХраните сильную ссылку на делегат или используйте замыкания.
403 from /v1/sessionapp_not_live означает, что приложение приостановлено или ваш аккаунт неактивен. user_blocked означает, что мы заблокировали этого пользователя.
РешениеНе показывайте offerwall. При app_not_live проверьте уведомления.
VPN or Proxy detectedУстройство подключено через VPN, прокси или облачную сеть, где офферы невозможно отследить.
РешениеТестируйте с обычного домашнего или мобильного подключения, в стране, где доступны офферы.
Postback log shows 403 or 404Ваш скрипт отклонил postback, или URL неверен.
РешениеОткройте URL из лога в браузере и проверьте код, который вычисляет хеш.
Postback log shows a timeoutВаш скрипт отвечает дольше 6 секунд.
РешениеСначала отвечайте кодом 200, а медленную работу выполняйте в фоне.
Postback log shows 301 or 302Ваш URL выполняет редирект, например с http на https.
РешениеИспользуйте конечный URL. Postback-запросы не следуют редиректам.
Ничего не найдено. Посмотрите полный список в документации или свяжитесь с нами.
Коротко о главном
- Минимальная версия
- iOS 13, iPhone и iPad, сборка в Xcode 16 или новее
- Языки
- Swift, SwiftUI и Objective-C
- Установка
- Swift Package Manager, CocoaPods или xcframework
- Зависимости
- Только UIKit и WebKit
- Конфиденциальность
- Манифест конфиденциальности в комплекте, без рекламного идентификатора
- Цена
- Бесплатно для одобренных паблишеров
Другие интеграции
- СайтСсылка, iframe или плавающая кнопка Earn. SDK не нужен.
- Offers APIПолучайте офферы в JSON и показывайте их в собственном дизайне.
- Android SDKНативный экран offerwall для приложений на Kotlin и Java.
- Unity SDKОфферы с наградами для игр на Android и iOS, прямо из кода на C#.
- Flutter SDKОдин плагин на Dart для Android и iOS.
- React Native SDKДля приложений React Native и Expo, с типами TypeScript.
- Все интеграцииСравните их между собой.
Вопросы по iOS
Что спрашивают разработчики, прежде чем добавить iOS SDK.
Что-то не получается? Свяжитесь с нами
Какие версии iOS поддерживает Moonetix SDK?
iOS 13 или новее на iPhone и iPad, сборка в Xcode 16 или новее. SDK использует только UIKit и WebKit и не имеет сторонних зависимостей.
Можно ли использовать его со SwiftUI?
Да. Вызовите Moonetix.open(token:) без view controller, и SDK покажет экран поверх верхнего экрана вашего приложения, что работает с кнопками SwiftUI.
Как его установить?
Через Swift Package Manager из https://moonetix.com/ios/moonetix-ios.git, через CocoaPods из нашего podspec или вручную, встроив xcframework.
Что указать в сведениях о конфиденциальности App Store?
User ID, Device ID, Coarse Location и Product Interaction: все связаны с пользователем, не используются для отслеживания, цель - App Functionality. Манифест конфиденциальности SDK содержит те же данные.
Нарушает ли offerwall правила проверки App Store?
У Apple есть правила для приложений, которые награждают пользователей. В Academy есть руководство о том, как запустить offerwall в iOS-приложении в рамках этих правил, включая формулировки для наград.
Как пользователи получают награды?
Ваш сервер получает подписанный postback за каждую награду и начисляет ее пользователю. Никогда не начисляйте награды по событиям приложения, потому что их можно подделать на устройстве.
Превратите свой трафик в доход.
Создайте бесплатный аккаунт паблишера и зарабатывайте на каждом оффере, который ваши пользователи выполняют на вашем сайте, в приложении, игре или сообществе.