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 adunitPOSThttps://api.offerup.co.kr/req/v1/campReq
Name
NameTypeDescription
mediaIdintegerMedia ID
adunitIdintegerAdunit ID
userKeystringUser Unique key
{
  "mediaId": 1,
  "adunitId": 2,
  "userKey": "a81Rteax2LNR7RpXZnq6x1YG3cjk"
}
Name
NameTypeDescription
resultintegerResult Code
campIdintegerCampaign ID
campTitlestringCampaign Name
campSubTitlestringCampaign Subtitle
campDescstringDetailed content (how to participate)
pricefloatUser Reward Amount
iconstringCampaign Icon URL
ctvWidestringCampaign Ad Creative URL
ctvBigstringCampaign Ad Creative URL
messagestringResult 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 ConfirmationPOSThttps://api.offerup.co.kr/req/v1/engage
Name
NameTypeDescription
campIdintegerCampaign ID
mediaIdintegerMedia ID
adunitIdintegerAdunit ID
userKeystringUser Unique key
userAdidstringUser Advertising ID
{
  "campId": 10012,
  "mediaId": 1,
  "adunitId": 2,
  "userKey": "a81Rteax2LNR7RpXZnq6x1YG3cjk",
  "userAdid": "1cf377c7-d972-4bd5-a5c1-00ba9aa9dvjk"
}
Name
NameTypeDescription
resultintegerResult Code
landingUrlstringLanding URL (on success)
messagestringResult Message (on failure)
{
  "result": 200,
  "landingUrl": "https://play.google.com/store/apps/details?id=io.comup.cashcompany"
}

3. Campaign Installation Request

Campaign Installation ConfirmationPOSThttps://api.offerup.co.kr/req/v1/inst
Name
NameTypeDescription
campIdintegerCampaign ID
mediaIdintegerMedia ID
adunitIdintegerAdunit ID
userKeystringUser Unique key
userAdidstringUser Advertising ID
{
  "campId": 10012,
  "mediaId": 1,
  "adunitId": 2,
  "userKey": "a81Rteax2LNR7RpXZnq6x1YG3cjk",
  "userAdid": "1cf377c7-d972-4bd5-a5c1-00ba9aa9dvjk"
}
Name
NameTypeDescription
resultintegerResult Code
messagestringResult Message (on failure)
{
  "result": 200
}

4. Postback Dispatch (After Campaign Completion)

Postback upon campaign completionGEThttps://yourdomain.com/
Name
NameTypeDescription
userKeyUser Unique Key
campTitleCampaign Title
rewardPriceReward Amount
comupKeyDuplicate Prevention Key
https://yourdomain.com/comup?userid=[userKey]&campname=[campTitle]&price=[rewardPrice]&transkey=[comupKey]
Name
NameTypeDescription
HTTP 200 OKSuccessful processing
// Empty response, just HTTP 200 OK
* Postback URL for reception needs prior registration

Response Code Summary

CodeMessage
200Success
400Bad Request
401Ineligible Media
402User Information Error
403No Participation History
404Not Eligible for Ad Participation
501Daily Quantity Exhausted
503Ended Campaign
504Duplicate Participation
505Ineligible Campaign
506Accreditation Criteria Not Met
507Accreditation Status Pending
601Unknown Error
604System Error

Contact

Change Log

DateVersionDescription
2025-04-091.0Initial Creation