Table of Contents Introduction Integration Workflow Server Information Postback Example API List Request by Adunit Engagement Request Installation Request Postback Dispatch Response Code Contact Change Log Comup Offerwall(OfferUP) API 1.0 This is the API document for mobile apps to communicate with Comup Offerwall (OfferUP) . Each app must register media and ad units and link campaigns to each ad unit through the Login page before integration.
Integration Workflow Flow of Media (c), User Action (u), Comup Server (s):
Adunit Campaign Request (c) -> User Participates (u) -> Engagement Confirmation Request (c) -> User Completes Campaign (u) -> Postback Dispatch (s) -> Reward Accreditation (c)
Server Information Base URL: https://api.offerup.co.kr/req/v1
Postback Example https://yourdomain.com/comup?userid=[userKey]&campname=[campTitle]&price=[rewardPrice]&transkey=[comupKey]
- Provided Macro List:
User Key: [userKey]
Campaign Name: [campTitle]
Reward Amount: [rewardPrice]
Duplicate Key: [comupKey]
You can map macros to your desired key values for reception.
API List Campaign Request by Adunit Campaign Engagement Request Campaign Installation Request Postback Dispatch 1. Campaign Request by Adunit Inquiry of campaigns by adunit POST https://api.offerup.co.kr/req/v1/campReq
Name Name Type Description mediaId integer Media ID adunitId integer Adunit ID userKey string User Unique key
{
"mediaId": 1,
"adunitId": 2,
"userKey": "a81Rteax2LNR7RpXZnq6x1YG3cjk"
}
Name Name Type Description result integer Result Code campId integer Campaign ID campTitle string Campaign Name campSubTitle string Campaign Subtitle campDesc string Detailed content (how to participate) price float User Reward Amount icon string Campaign Icon URL ctvWide string Campaign Ad Creative URL ctvBig string Campaign Ad Creative URL message string Result Message (on failure)
{
"result": 200,
"campId": 10012,
"campTitle": "나는야 설치왕",
"campSubTitle": "첫 참여만 인정",
"campDesc": "참여방법:1.클릭후 스토어에서 설치\n2.설치 후 실행",
"price": 10.99,
"icon": "https://example.com/img/icon.png",
"ctvWide": "https://example.com/img/ctvWide.png",
"ctvBig": "https://example.com/img/ctvBig.png"
}
2. Campaign Engagement Request Campaign Engagement Confirmation POST https://api.offerup.co.kr/req/v1/engage
Name Name Type Description campId integer Campaign ID mediaId integer Media ID adunitId integer Adunit ID userKey string User Unique key userAdid string User Advertising ID
{
"campId": 10012,
"mediaId": 1,
"adunitId": 2,
"userKey": "a81Rteax2LNR7RpXZnq6x1YG3cjk",
"userAdid": "1cf377c7-d972-4bd5-a5c1-00ba9aa9dvjk"
}
Name Name Type Description result integer Result Code landingUrl string Landing URL (on success) message string Result Message (on failure)
{
"result": 200,
"landingUrl": "https://play.google.com/store/apps/details?id=io.comup.cashcompany"
}
3. Campaign Installation Request Campaign Installation Confirmation POST https://api.offerup.co.kr/req/v1/inst
Name Name Type Description campId integer Campaign ID mediaId integer Media ID adunitId integer Adunit ID userKey string User Unique key userAdid string User Advertising ID
{
"campId": 10012,
"mediaId": 1,
"adunitId": 2,
"userKey": "a81Rteax2LNR7RpXZnq6x1YG3cjk",
"userAdid": "1cf377c7-d972-4bd5-a5c1-00ba9aa9dvjk"
}
Name Name Type Description result integer Result Code message string Result Message (on failure)
{
"result": 200
}
4. Postback Dispatch (After Campaign Completion) Postback upon campaign completion GET https://yourdomain.com/
Name Name Type Description userKey User Unique Key campTitle Campaign Title rewardPrice Reward Amount comupKey Duplicate Prevention Key
https://yourdomain.com/comup?userid=[userKey]&campname=[campTitle]&price=[rewardPrice]&transkey=[comupKey]
Name Name Type Description HTTP 200 OK Successful processing
// Empty response, just HTTP 200 OK
* Postback URL for reception needs prior registration
Response Code Summary Code Message 200 Success 400 Bad Request 401 Ineligible Media 402 User Information Error 403 No Participation History 404 Not Eligible for Ad Participation 501 Daily Quantity Exhausted 503 Ended Campaign 504 Duplicate Participation 505 Ineligible Campaign 506 Accreditation Criteria Not Met 507 Accreditation Status Pending 601 Unknown Error 604 System Error
Change Log Date Version Description 2025-04-09 1.0 Initial Creation
Copyright © 2025 COMUP. All rights reserved.