Comup Offerwall(OfferUP) API 1.0
컴업 오퍼월(OfferUP)과 통신하기 위한 모바일 앱 용 API 문서입니다.
각 앱은 연동 전 로그인 페이지를 통해 매체 및 지면 등록과 각 지면에 캠페인을 연결해야 합니다.
연동 업무 흐름
매체(c), 유저행동(u), 컴업서버(s) 흐름:
지면 캠페인 조회(c) -> 유저가 참여 시(u) -> 참여 확인 요청(c) -> 유저가 캠페인 수행 완료(u) -> 포스트백 발신(s) -> 매체에서 적립(c)
서버 정보
- Base URL:
https://api.offerup.co.kr/req/v1
포스트백 예시
https://yourdomain.com/comup?userid=[userKey]&campname=[campTitle]&price=[rewardPrice]&transkey=[comupKey]
- 제공 매크로 목록:
- 유저키:
[userKey] - 캠페인명:
[campTitle] - 리워드금액:
[rewardPrice] - 중복키:
[comupKey]
원하는 키 값에 매크로를 매핑하여 수신 가능합니다.
API 목록
- 지면 캠페인 조회
- 캠페인 참여 확인 요청
- 캠페인 설치 확인 요청
- 포스트백 발신
1. 지면 캠페인 조회
지면별 캠페인 조회POSThttps://api.offerup.co.kr/req/v1/campReq
이름| 이름 | 타입 | 설명 |
|---|
| mediaId | integer | Media ID |
| adunitId | integer | Adunit ID |
| userKey | string | User Unique key |
{
"mediaId": 1,
"adunitId": 2,
"userKey": "a81Rteax2LNR7RpXZnq6x1YG3cjk"
}
이름| 이름 | 타입 | 설명 |
|---|
| result | integer | 결과 코드 |
| campId | integer | 캠페인 ID |
| campTitle | string | 캠페인 명 |
| campSubTitle | string | 캠페인 부가 설명 |
| campDesc | string | 상세 내용(참여방법) |
| price | float | 유저 리워드 금액 |
| icon | string | 캠페인 아이콘 URL |
| ctvWide | string | 캠페인 광고 소재 URL |
| ctvBig | string | 캠페인 광고 소재 URL |
| message | string | 결과 메시지(실패 시) |
{
"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. 캠페인 참여 확인 요청
캠페인 참여 확인POSThttps://api.offerup.co.kr/req/v1/engage
이름| 이름 | 타입 | 설명 |
|---|
| campId | integer | 캠페인 ID |
| mediaId | integer | Media ID |
| adunitId | integer | Adunit ID |
| userKey | string | User Unique key |
| userAdid | string | 유저 광고 ID |
{
"campId": 10012,
"mediaId": 1,
"adunitId": 2,
"userKey": "a81Rteax2LNR7RpXZnq6x1YG3cjk",
"userAdid": "1cf377c7-d972-4bd5-a5c1-00ba9aa9dvjk"
}
이름| 이름 | 타입 | 설명 |
|---|
| result | integer | 결과 코드 |
| landingUrl | string | 랜딩 URL (성공시) |
| message | string | 결과 메시지(실패 시) |
{
"result": 200,
"landingUrl": "https://play.google.com/store/apps/details?id=io.comup.cashcompany"
}
3. 캠페인 설치 확인 요청
캠페인 설치 확인POSThttps://api.offerup.co.kr/req/v1/inst
이름| 이름 | 타입 | 설명 |
|---|
| campId | integer | 캠페인 ID |
| mediaId | integer | Media ID |
| adunitId | integer | Adunit ID |
| userKey | string | User Unique key |
| userAdid | string | 유저 광고 ID |
{
"campId": 10012,
"mediaId": 1,
"adunitId": 2,
"userKey": "a81Rteax2LNR7RpXZnq6x1YG3cjk",
"userAdid": "1cf377c7-d972-4bd5-a5c1-00ba9aa9dvjk"
}
이름| 이름 | 타입 | 설명 |
|---|
| result | integer | 결과 코드 |
| message | string | 결과 메시지(실패 시) |
{
"result": 200
}
4. 포스트백 발신 (캠페인 완료 후)
캠페인 완료 시 포스트백GEThttps://yourdomain.com/
이름| 이름 | 타입 | 설명 |
|---|
| userKey | | 유저 고유 키 |
| campTitle | | 캠페인 제목 |
| rewardPrice | | 리워드 금액 |
| comupKey | | 중복 방지 키 |
https://yourdomain.com/comup?userid=[userKey]&campname=[campTitle]&price=[rewardPrice]&transkey=[comupKey]
이름// Empty response, just HTTP 200 OK
* 수신받을 포스트백 URL은 사전 등록 필요
응답 코드 요약
| 코드 | 메시지 |
|---|
| 200 | 성공 |
| 400 | 잘못된 요청 |
| 401 | 참여할 수 없는 매체 |
| 402 | 유저 정보 오류 |
| 403 | 참여 이력 없음 |
| 404 | 광고 참여 대상 아님 |
| 501 | 금일 수량 마감 |
| 503 | 종료된 캠페인 |
| 504 | 중복 참여 |
| 505 | 참여할 수 없는 캠페인 |
| 506 | 적립 기준 미달 |
| 507 | 적립 여부 확인 중 |
| 601 | 알 수 없는 에러 |
| 604 | 시스템 오류 |
