SDK offerwall iOS. Swift, SwiftUI và Objective-C.
Mở offerwall Moonetix trong ứng dụng iPhone và iPad chỉ với một Swift package. Nó chỉ dùng UIKit và WebKit, không có phụ thuộc bên thứ ba và đi kèm privacy manifest.
- 13+iOS và iPadOS
- 2.0.1Phiên bản hiện tại
- 0Phụ thuộc bên thứ ba
import MoonetixOfferwall
Moonetix.configure(appId: "YOUR_APP_ID")
// When the user taps Earn
Moonetix.open(token: token)Triển khai trong bốn bước.
Sao chép mã, thay các giá trị giữ chỗ bằng giá trị từ bảng điều khiển của bạn trong "Offerwall", offerwall của bạn, "Tích hợp", và thử nghiệm trước khi ra mắt.
-
Cài đặt SDK
Thêm package trong Xcode qua File, Add Package Dependencies, hoặc dùng CocoaPods. Bạn cũng có thể tải xcframework về và nhúng thủ công. Build bằng Xcode 16 trở lên.
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' -
Thêm endpoint token vào máy chủ của bạn
Ứng dụng của bạn không bao giờ giữ khóa API. Khi người dùng nhấn Earn, ứng dụng yêu cầu máy chủ của bạn tạo phiên, và máy chủ yêu cầu Moonetix cấp một token dùng một lần cho người dùng đã đăng nhập đó. Mỗi token chỉ dùng được một lần, trong 10 phút.
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 -
Mở offerwall
Cấu hình một lần với App ID từ bảng điều khiển, sau đó mở offerwall bằng token mới. Nếu không có view controller, SDK sẽ hiển thị từ màn hình trên cùng của ứng dụng, nên cũng dùng được từ 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]; -
Cộng thưởng bằng postback
Mọi phần thưởng tới máy chủ của bạn dưới dạng postback có chữ ký. Hãy kiểm tra mã hash, cộng thưởng một lần cho mỗi ID giao dịch, và lấy lại nếu một postback sau đó thu hồi nó. Postback thất bại được gửi lại tối đa 5 lần.
Bảng điều khiển, tab "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Đạt cấp 15+1,500
WPS OfficeCài đặt và mở+2,000
Bus EscapeĐạt cấp 20+450
CapCutSign up in the app+800
Những gì người dùng nhìn thấy
Một màn hình native hiển thị trên ứng dụng của bạn, với tiêu đề và màu sắc của bạn, đơn vị tiền tệ của bạn, và mọi phần thưởng đều được xác nhận bằng postback.
SDK xử lý những gì cho bạn
- Offer mở đúng nơi
Offer dẫn tới App Store mở trong ứng dụng cửa hàng, còn các trang khác mở trong trình duyệt, nên lượt cài đặt được ghi nhận chính xác.
- Không có khóa trong ứng dụng
Ứng dụng của bạn chỉ giữ App ID. Phiên được tạo trên máy chủ của bạn và chỉ dùng được một lần, nên không ai có thể mở offerwall dưới danh nghĩa người dùng khác.
- Một màn hình được khóa chặt
Chỉ các trang offerwall được tải bên trong, không có JavaScript bridge vào ứng dụng của bạn.
- Điều hướng native
Nút đóng đưa người dùng về ứng dụng của bạn, vuốt từ cạnh trái sẽ quay lại bên trong offerwall, và offerwall tiếp tục từ chỗ người dùng đang xem sau khi chạy nền.
- Hỗ trợ tiếp cận ngay từ đầu
Chế độ sáng và tối, cỡ chữ lớn hơn và VoiceOver đều hoạt động ngay từ đầu.
- Đã kèm privacy manifest
SDK đi kèm privacy manifest, không dùng kỹ thuật lấy dấu vân tay thiết bị và không dùng mã định danh quảng cáo.
Thử nghiệm, rồi ra mắt.
Mọi thứ bạn cần kiểm tra trước khi người dùng thật thấy offerwall của bạn, với các công cụ có sẵn trong bảng điều khiển.
Mở với tư cách người dùng thử nghiệm
Trong "Trạng thái tích hợp" ở tab "Tích hợp", hãy mở offerwall của bạn với tư cách người dùng owner-test. Lượt truy cập thử nghiệm không được tính là người dùng.
Chạy trên thiết bị thật
Build cho Android hoặc iOS và mở offerwall từ nút Earn với token mới mỗi lần.
Gửi postback thử nghiệm
Chọn người dùng, trạng thái và mức thanh toán, rồi xem chính xác máy chủ của bạn đã trả lời gì, kèm mã phản hồi và thời gian. ID giao dịch thử nghiệm bắt đầu bằng test_.
Thử nghiệm từ một kết nối bình thường
VPN, proxy, Tor và mạng đám mây đều bị chặn, vì vậy hãy thử nghiệm qua Wi-Fi gia đình hoặc dữ liệu di động, ở quốc gia có offer đang chạy.
Danh sách kiểm tra trước khi ra mắt
0 / 11 mục đã sẵn sàng
Sẵn sàng ra mắt. Tiến độ của bạn được lưu trong trình duyệt này.
Lỗi thường gặp, khắc phục nhanh.
Những lỗi bạn có thể gặp khi tích hợp iOS SDK, nguyên nhân và cách khắc phục.
INVALID_APP_IDGiá trị truyền vào init không phải là App ID. Truyền khóa API vào đây là lỗi phổ biến nhất.
Khắc phụcSao chép lại App ID gồm 24 ký tự từ tab "Tích hợp".
INVALID_TOKENỨng dụng đã truyền thứ khác ngoài token, hoặc một token được tạo bằng khóa API của ứng dụng khác.
Khắc phụcChỉ truyền trường token, bắt đầu bằng sst_, và dùng App ID cùng khóa API của cùng một ứng dụng.
TOKEN_EXPIRED_OR_USEDToken đã quá 10 phút hoặc đã được dùng, ví dụ được giữ lại từ một lần nhấn trước.
Khắc phụcTạo token mới cho mỗi lần mở, ngay khi người dùng nhấn Earn.
NOT_INITIALIZEDopen được gọi trước init.
Khắc phụcGọi Moonetix.configure khi ứng dụng khởi động.
UNKNOWNOfferwall đã được mở, hoặc không có view controller nào trên màn hình để hiển thị từ đó.
Khắc phụcChỉ mở một lần tại một thời điểm, và truyền một view controller đang hiển thị bằng open(token:from:).
Delegate is never calledMoonetix.delegate là một weak reference, nên đối tượng đã bị giải phóng.
Khắc phụcGiữ một strong reference tới delegate của bạn, hoặc dùng closure.
403 from /v1/sessionapp_not_live nghĩa là ứng dụng đang tạm dừng hoặc tài khoản của bạn không hoạt động. user_blocked nghĩa là chúng tôi đã chặn người dùng này.
Khắc phụcKhông hiển thị offerwall. Với app_not_live, hãy kiểm tra thông báo của bạn.
VPN or Proxy detectedThiết bị đang dùng VPN, proxy hoặc mạng đám mây, nơi offer không thể được theo dõi.
Khắc phụcThử nghiệm trên kết nối gia đình hoặc di động bình thường, ở quốc gia có offer đang chạy.
Postback log shows 403 or 404Script của bạn đã từ chối postback, hoặc URL bị sai.
Khắc phụcMở URL trong log bằng trình duyệt và kiểm tra mã hash của bạn.
Postback log shows a timeoutScript của bạn mất hơn 6 giây để trả lời.
Khắc phụcTrả lời 200 trước, rồi chạy các tác vụ chậm ở chế độ nền.
Postback log shows 301 or 302URL của bạn có chuyển hướng, ví dụ từ http sang https.
Khắc phụcDùng URL cuối cùng. Postback không đi theo chuyển hướng.
Không tìm thấy. Xem danh sách đầy đủ trong tài liệu hoặc liên hệ với chúng tôi.
Tổng quan nhanh
- Phiên bản tối thiểu
- iOS 13, iPhone và iPad, build bằng Xcode 16 trở lên
- Ngôn ngữ
- Swift, SwiftUI và Objective-C
- Cài đặt
- Swift Package Manager, CocoaPods hoặc xcframework
- Dependency
- Chỉ UIKit và WebKit
- Quyền riêng tư
- Đã kèm privacy manifest, không dùng mã định danh quảng cáo
- Giá
- Miễn phí cho publisher đã được duyệt
Bắt đầu từ mã chạy được
Cách tích hợp khác
- Trang webMột liên kết, một iframe hoặc một nút Earn nổi. Không cần SDK.
- Offers APILấy danh sách offer dưới dạng JSON và hiển thị theo thiết kế của riêng bạn.
- Android SDKMàn hình offerwall native cho ứng dụng Kotlin và Java.
- Unity SDKOffer có thưởng cho game Android và iOS, từ C#.
- Flutter SDKMột plugin Dart cho Android và iOS.
- React Native SDKDành cho ứng dụng React Native và Expo, có kèm kiểu TypeScript.
- Tất cả tích hợpSo sánh song song.
Câu hỏi về iOS
Những điều nhà phát triển thường hỏi trước khi thêm iOS SDK.
Gặp vướng mắc? Liên hệ với chúng tôi
Moonetix SDK hỗ trợ những phiên bản iOS nào?
iOS 13 trở lên trên iPhone và iPad, build bằng Xcode 16 trở lên. SDK chỉ dùng UIKit và WebKit, không có phụ thuộc bên thứ ba.
Tôi có thể dùng với SwiftUI không?
Có. Gọi Moonetix.open(token:) mà không cần view controller và SDK sẽ hiển thị từ màn hình trên cùng của ứng dụng, cách này hoạt động với các nút SwiftUI.
Cài đặt như thế nào?
Bằng Swift Package Manager từ https://moonetix.com/ios/moonetix-ios.git, bằng CocoaPods từ podspec của chúng tôi, hoặc nhúng xcframework thủ công.
Tôi cần khai báo gì trong phần quyền riêng tư của App Store?
User ID, Device ID, Coarse Location và Product Interaction, tất cả đều liên kết với người dùng, không dùng để theo dõi, cho mục đích App Functionality. Privacy manifest của SDK liệt kê cùng các dữ liệu này.
Offerwall có vi phạm quy tắc duyệt của App Store không?
Apple có quy định cho các ứng dụng thưởng cho người dùng. Academy có hướng dẫn chạy offerwall trong ứng dụng iOS theo đúng các quy định đó, kể cả cách diễn đạt phần thưởng.
Người dùng được thưởng như thế nào?
Máy chủ của bạn nhận một postback có chữ ký cho mỗi phần thưởng và cộng thưởng cho người dùng. Đừng bao giờ cộng thưởng từ sự kiện trong ứng dụng, vì chúng có thể bị giả mạo trên thiết bị.
Biến lưu lượng truy cập thành thu nhập.
Tạo tài khoản publisher miễn phí và kiếm tiền từ mỗi offer mà người dùng hoàn thành trên trang web, ứng dụng, game hoặc cộng đồng của bạn.