애드팝콘 S2S api 연동(Meta Type)
이 가이드는 Server-to-Server API 방식으로 애드팝콘 오퍼월을 연동하기 위한 문서입니다.
매체사는 본 가이드를 활용하여 애드팝콘 캠페인 정보를 취득하고, 이를 유저에게 노출하여 매체 수익을 극대화할 수 있습니다.
본 가이드의 내용은 애드팝콘과 매체사 간 서버 연동을 위한 API에 초점을 맞추고 있으며, 안정적인 데이터 연동을 위해 아래 사항을 반드시 준수해야 합니다.
- 모든 API는 클라이언트에서 직접 호출할 수 없으며, 반드시 매체사 서버에서 호출해야 합니다.
- 유저식별값은 고정값을 사용하며 개인정보가 포함되지 않아야 합니다.
- 설치형 캠페인의 완료 여부는 매체사가 판단하되, 리워드는 반드시 리워드 지급 콜백을 통해 지급해야 합니다.
애드팝콘 오퍼월 연동은 다음과 같은 API 흐름을 따릅니다.
- 캠페인 정보 조회 API (
GET/mediamix/meta)
- 애드팝콘에서 제공하는 캠페인 정보를 매체사가 조회하여 유저에게 노출합니다.
- 주기적으로 호출하여 최신 캠페인 정보를 유지해야 합니다.
- 캠페인 참여 여부 조회 API (
GET/mediamix/join)
- 유저가 특정 캠페인에 참여하려고 할 때 호출하여 참여 가능 여부를 확인합니다.
- 참여 가능하면 캠페인에 대한 RedirectURL을 반환합니다.
- 설치형 캠페인 완료 API (
POST/mediamix/completeoffer)
- 설치형 캠페인의 경우, 매체사가 유저의 앱 설치 여부를 확인한 후 완료 처리를 합니다.
- 캠페인 참여 시도 기록이 있어야 정상적으로 완료 처리가 가능합니다.
- 리워드 지급 콜백
- 캠페인 완료가 확인되면, 애드팝콘 리워드 서버에서 매체사 콜백 서버로 리워드 정보를 전송합니다.
- 매체사는 해당 정보를 활용하여 유저에게 적절한 보상을 지급해야 합니다.
- 기타 정보 및 응답 코드
- API 호출 시 반환되는 응답 코드 및 오류 메시지를 참고하여 처리해야 합니다.
- 유효하지 않은 요청을 방지하기 위해 필수 파라미터를 정확히 전달해야 합니다.