유저

유저 API 목록

1. 로그인(U001)

HTTP request

POST /core/api/v1/users/login HTTP/1.1
Content-Type: application/json
Content-Length: 44
Host: localhost:8080

{"id":"아이디","password":"패스워드"}

HTTP response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 619

{"result":{"agent":{"agentId":1,"name":"대행사 이름","uniqueCode":"고유 코드","representativeName":"대표자 이름","businessRegistrationNumber":"사업자 등록 번호","status":"NORMAL","domainName":"도메인 이름"},"userWithToken":{"user":{"userId":1,"agentId":1,"id":"아이디","status":"NORMAL","type":"ADVERTISER","name":"이름","phoneNumber":"전화번호"},"accessToken":{"token":"토큰 값","expiredDt":"2025-06-27T21:13:54.069+09:00"},"refreshToken":{"token":"토큰 값","expiredDt":"2025-06-27T21:13:54.069+09:00"}}},"code":"0","message":"요청이 성공적으로 완료되었습니다."}

Request body

{"id":"아이디","password":"패스워드"}

Request fields

Path Type Description Required

id

String

사용자 아이디

required

password

String

사용자 비밀번호

required

Response body

{"result":{"agent":{"agentId":1,"name":"대행사 이름","uniqueCode":"고유 코드","representativeName":"대표자 이름","businessRegistrationNumber":"사업자 등록 번호","status":"NORMAL","domainName":"도메인 이름"},"userWithToken":{"user":{"userId":1,"agentId":1,"id":"아이디","status":"NORMAL","type":"ADVERTISER","name":"이름","phoneNumber":"전화번호"},"accessToken":{"token":"토큰 값","expiredDt":"2025-06-27T21:13:54.069+09:00"},"refreshToken":{"token":"토큰 값","expiredDt":"2025-06-27T21:13:54.069+09:00"}}},"code":"0","message":"요청이 성공적으로 완료되었습니다."}

Response fields

Path Type Description Required

code

String

응답 코드

required

message

String

오류 메시지

required

result.agent.agentId

Number

대행사 UID

required

result.agent.name

String

대행사 이름

required

result.agent.uniqueCode

String

대행사 고유코드

required

result.agent.representativeName

String

대행사 대표자명

required

result.agent.businessRegistrationNumber

String

대행사 사업자 등록번호

required

result.agent.status

String

NORMAL : 활성화 STOP : 비활성화

required

result.agent.domainName

String

대행사 도메인 이름

required

result.userWithToken

Object

유저 정보

required

result.userWithToken.user.userId

Number

유저 UID

required

result.userWithToken.user.agentId

Number

에이전트 UID

required

result.userWithToken.user.id

String

회원 ID

required

result.userWithToken.user.status

String

NORMAL : 활성화 STOP : 비활성화 TEMP : 임시

required

result.userWithToken.user.type

String

ASSOCIATE_ADVERTISER : 준광고주 ADVERTISER : 광고주 AGENCY_GROUP_MEMBER : 대행사 그룹원 AGENCY_GROUP_MANAGER : 대행사 그룹장 AGENCY_GROUP_MASTER : 대행사 최상위 그룹장 OPERATIONS_MANAGER : 운영관리자 SYSTEM_ADMINISTRATOR : 시스템 관리자

required

result.userWithToken.user.name

String

회원 이름

required

result.userWithToken.user.phoneNumber

String

회원 전화번호

required

result.userWithToken.accessToken.token

String

액세스 토큰

required

result.userWithToken.accessToken.expiredDt

String

만료 시간

required

result.userWithToken.refreshToken.token

String

리프레시 토큰

required

result.userWithToken.refreshToken.expiredDt

String

만료 시간

required

2. 로그아웃(U002)

HTTP request

POST /core/api/v1/users/logout HTTP/1.1
Content-Type: application/json
Host: localhost:8080

HTTP response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 87

{"result":null,"code":"0","message":"요청이 성공적으로 완료되었습니다."}

Response body

{"result":null,"code":"0","message":"요청이 성공적으로 완료되었습니다."}

Response fields

Path Type Description Required

code

String

응답 코드

required

message

String

오류 메시지

required

result

Null

결과

required

3. 비밀번호 재설정(U003)

HTTP request

POST /core/api/v1/users/password-reset-mail HTTP/1.1
Content-Type: application/json
Content-Length: 30
Host: localhost:8080

{"loginId":"회원 아이디"}

HTTP response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 87

{"result":null,"code":"0","message":"요청이 성공적으로 완료되었습니다."}

Request body

{"loginId":"회원 아이디"}

Request fields

Path Type Description Required

loginId

String

사용자 아이디

required

Response body

{"result":null,"code":"0","message":"요청이 성공적으로 완료되었습니다."}

Response fields

Path Type Description Required

code

String

응답 코드

required

message

String

오류 메시지

required

result

Null

결과

required

4. 기본 정보 변경(U004)

HTTP request

PATCH /core/api/v1/users/1/profile HTTP/1.1
Content-Type: application/json
Content-Length: 97
Host: localhost:8080

{"name":"회원 이름","emailAddress":"회원 로그인 아이디","phoneNumber":"전화번호"}

HTTP response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 87

{"result":null,"code":"0","message":"요청이 성공적으로 완료되었습니다."}

Path parameters

Table 1. /core/api/v1/users/{userId}/profile
Parameter Description

userId

회원 UID

Request body

{"name":"회원 이름","emailAddress":"회원 로그인 아이디","phoneNumber":"전화번호"}

Request fields

Path Type Description Required

name

String

사용자 이름

required

emailAddress

String

사용자 아이디

required

phoneNumber

String

전화번호

optional

Response body

{"result":null,"code":"0","message":"요청이 성공적으로 완료되었습니다."}

Response fields

Path Type Description Required

code

String

응답 코드

required

message

String

오류 메시지

required

result

Null

결과

required

5. 토큰 재발급(U005)

HTTP request

POST /core/api/v1/users/token/refresh HTTP/1.1
Content-Type: application/json
Host: localhost:8080

HTTP response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 379

{"result":{"user":{"userId":1,"agentId":1,"id":"아이디","status":"NORMAL","type":"ADVERTISER","name":"이름","phoneNumber":"전화번호"},"accessToken":{"token":"토큰 값","expiredDt":"2025-06-27T21:13:53.982+09:00"},"refreshToken":{"token":"토큰 값","expiredDt":"2025-06-27T21:13:53.982+09:00"}},"code":"0","message":"요청이 성공적으로 완료되었습니다."}

Response body

{"result":{"user":{"userId":1,"agentId":1,"id":"아이디","status":"NORMAL","type":"ADVERTISER","name":"이름","phoneNumber":"전화번호"},"accessToken":{"token":"토큰 값","expiredDt":"2025-06-27T21:13:53.982+09:00"},"refreshToken":{"token":"토큰 값","expiredDt":"2025-06-27T21:13:53.982+09:00"}},"code":"0","message":"요청이 성공적으로 완료되었습니다."}

Response fields

Path Type Description Required

code

String

응답 코드

required

message

String

오류 메시지

required

result.user

Object

유저 정보

required

result.user.userId

Number

유저 UID

required

result.user.agentId

Number

에이전트 UID

required

result.user.id

String

회원 ID

required

result.user.status

String

NORMAL : 활성화 STOP : 비활성화 TEMP : 임시

required

result.user.type

String

ASSOCIATE_ADVERTISER : 준광고주 ADVERTISER : 광고주 AGENCY_GROUP_MEMBER : 대행사 그룹원 AGENCY_GROUP_MANAGER : 대행사 그룹장 AGENCY_GROUP_MASTER : 대행사 최상위 그룹장 OPERATIONS_MANAGER : 운영관리자 SYSTEM_ADMINISTRATOR : 시스템 관리자

required

result.user.name

String

회원 이름

required

result.user.phoneNumber

String

회원 전화번호

required

result.accessToken.token

String

액세스 토큰

required

result.accessToken.expiredDt

String

만료 시간

required

result.refreshToken.token

String

리프레시 토큰

required

result.refreshToken.expiredDt

String

만료 시간

required

6. 회원 이름 중복 체크(U006)

HTTP request

GET /core/api/v1/users/name-duplicate?loginId=test%40test.com HTTP/1.1
Content-Type: application/json
Host: localhost:8080

HTTP response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 87

{"result":true,"code":"0","message":"요청이 성공적으로 완료되었습니다."}

Query parameters

Parameter Description Required

loginId

회원 ID

required

Response body

{"result":true,"code":"0","message":"요청이 성공적으로 완료되었습니다."}

Response fields

Path Type Description Required

code

String

응답 코드

required

message

String

오류 메시지

required

result

Boolean

true : 중복 , false : 미중복

required

7. 회원 상태 조회(U007)

HTTP request

GET /core/api/v1/users/info?loginId=test%40test.com HTTP/1.1
Content-Type: application/json
Host: localhost:8080

HTTP response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 207

{"result":{"userId":1,"agentId":1,"id":"아이디","status":"NORMAL","type":"ADVERTISER","name":"이름","phoneNumber":"전화번호"},"code":"0","message":"요청이 성공적으로 완료되었습니다."}

Query parameters

Parameter Description Required

loginId

회원 ID

required

Response body

{"result":{"userId":1,"agentId":1,"id":"아이디","status":"NORMAL","type":"ADVERTISER","name":"이름","phoneNumber":"전화번호"},"code":"0","message":"요청이 성공적으로 완료되었습니다."}

Response fields

Path Type Description Required

code

String

응답 코드

required

message

String

오류 메시지

required

result.userId

Number

회원 UID

required

result.agentId

Number

대행사 UID

required

result.id

String

회원 로그인 ID

required

result.status

String

NORMAL : 활성화 STOP : 비활성화 TEMP : 임시

required

result.type

String

ASSOCIATE_ADVERTISER : 준광고주 ADVERTISER : 광고주 AGENCY_GROUP_MEMBER : 대행사 그룹원 AGENCY_GROUP_MANAGER : 대행사 그룹장 AGENCY_GROUP_MASTER : 대행사 최상위 그룹장 OPERATIONS_MANAGER : 운영관리자 SYSTEM_ADMINISTRATOR : 시스템 관리자

required

result.name

String

회원 이름

required

result.phoneNumber

String

회원 전화 번호

required

대행사

관리자 기준 API 목록

1. 대행사 회원가입(AAG001)

HTTP request

POST /core/admin/api/v1/agents HTTP/1.1
Content-Type: application/json
Content-Length: 322
Host: localhost:8080

{"name":"대행사 이름","uniqueCode":"고유 코드","representativeName":"대표자 이름","businessRegistrationNumber":"사업자 등록 번호","domainName":"도메인 이름","agentBills":[{"name":"세금 계산서 담당자명","phoneNumber":"담당자 전화번호","emailAddress":"담당자 이메일 주소"}]}

HTTP response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 463

{"result":{"agentBills":[{"agentBillId":1,"agentId":1,"name":"세금 계산서 담당자명","phoneNumber":"담당자 전화번호","emailAddress":"담당자 이메일 주소"}],"agentId":1,"name":"대행사 이름","uniqueCode":"고유 코드","representativeName":"대표자 이름","businessRegistrationNumber":"사업자 등록 번호","status":"NORMAL","domainName":"도메인 이름"},"code":"0","message":"요청이 성공적으로 완료되었습니다."}

Request body

{"name":"대행사 이름","uniqueCode":"고유 코드","representativeName":"대표자 이름","businessRegistrationNumber":"사업자 등록 번호","domainName":"도메인 이름","agentBills":[{"name":"세금 계산서 담당자명","phoneNumber":"담당자 전화번호","emailAddress":"담당자 이메일 주소"}]}

Request fields

Path Type Description Required

name

String

대행사 이름

required

uniqueCode

String

고유 코드

required

representativeName

String

대행사 대표자명

required

businessRegistrationNumber

String

사업자 등록 번호

required

domainName

String

도메인 이름

required

agentBills[].name

String

세금계산서 담당자명

optional

agentBills[].phoneNumber

String

세금계산서 전화번호

optional

agentBills[].emailAddress

String

세금계산서 이메일

optional

Response body

{"result":{"agentBills":[{"agentBillId":1,"agentId":1,"name":"세금 계산서 담당자명","phoneNumber":"담당자 전화번호","emailAddress":"담당자 이메일 주소"}],"agentId":1,"name":"대행사 이름","uniqueCode":"고유 코드","representativeName":"대표자 이름","businessRegistrationNumber":"사업자 등록 번호","status":"NORMAL","domainName":"도메인 이름"},"code":"0","message":"요청이 성공적으로 완료되었습니다."}

Response fields

Path Type Description Required

code

String

응답 코드

required

message

String

오류 메시지

required

result.agentId

Number

에이전트 UID

required

result.name

String

대행사 이름

required

result.uniqueCode

String

고유 코드

required

result.representativeName

String

대행사 대표자명

required

result.businessRegistrationNumber

String

사업자 등록 번호

required

result.status

String

NORMAL : 활성화 STOP : 비활성화

required

result.domainName

String

도메인 이름

required

result.agentBills[].agentBillId

Number

세금계산서 담당자 ID

optional

result.agentBills[].agentId

Number

에이전트 UID

optional

result.agentBills[].name

String

세금계산서 담당자 이름

optional

result.agentBills[].phoneNumber

String

세금계산서 담당자 전화번호

optional

result.agentBills[].emailAddress

String

세금계산서 담당자 이메일

optional

2. 대행사 정보 수정 (AAG002)

HTTP request

PUT /core/admin/api/v1/agents/1 HTTP/1.1
Content-Type: application/json
Content-Length: 125
Host: localhost:8080

[{"name":"세금 계산서 담당자명","phoneNumber":"담당자 전화번호","emailAddress":"담당자 이메일 주소"}]

HTTP response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 87

{"result":null,"code":"0","message":"요청이 성공적으로 완료되었습니다."}

Request body

[{"name":"세금 계산서 담당자명","phoneNumber":"담당자 전화번호","emailAddress":"담당자 이메일 주소"}]

Request fields

Path Type Description Required

[].name

String

세금계산서 담당자명

optional

[].phoneNumber

String

세금계산서 전화번호

optional

[].emailAddress

String

세금계산서 이메일

optional

Response body

{"result":null,"code":"0","message":"요청이 성공적으로 완료되었습니다."}

Response fields

Path Type Description Required

code

String

응답 코드

required

message

String

오류 메시지

required

result

Null

결과

required

3. 대행사 페이지네이션 리스트 조회 (AAG003)

HTTP request

GET /core/admin/api/v1/agents?page=1&size=10 HTTP/1.1
Content-Type: application/json
Host: localhost:8080

HTTP response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 332

{"result":{"content":[{"agentId":1,"agentName":"대행사 이름","agentRepresentativeName":"대행사 대표자 이름","businessRegistrationNumber":"12312312","status":"NORMAL","registerDt":"2025-06-27T12:13:48.30246083"}],"page":1,"size":10,"totalCount":1},"code":"0","message":"요청이 성공적으로 완료되었습니다."}

Query parameters

Parameter Description Required

page

페이지 번호 (1부터 시작)

required

size

페이지 크기

required

sort

해당 부분 사용하지 않음, OrderType을 통해 정렬 기준 제어

optional

keyword

대행사, 회원명, 이메일 검색 키워드

optional

orderType

AGENT_ASC AGENT_DESC STATUS_ASC STATUS_DESC REGISTER_DT_ASC REGISTER_DT_DESC

optional

Response body

{"result":{"content":[{"agentId":1,"agentName":"대행사 이름","agentRepresentativeName":"대행사 대표자 이름","businessRegistrationNumber":"12312312","status":"NORMAL","registerDt":"2025-06-27T12:13:48.30246083"}],"page":1,"size":10,"totalCount":1},"code":"0","message":"요청이 성공적으로 완료되었습니다."}

Response fields

Path Type Description Required

code

String

응답 코드

required

message

String

오류 메시지

required

result.content[].agentId

Number

대행사 UID

required

result.content[].agentName

String

대행사명

required

result.content[].agentRepresentativeName

String

대표자 이름

required

result.content[].businessRegistrationNumber

String

사업자 등록번호

required

result.content[].status

String

NORMAL : 활성화 STOP : 비활성화

required

result.content[].registerDt

String

등록 시간

required

result.page

Number

페이지 번호

required

result.size

Number

사이즈

required

result.totalCount

Number

전체 갯수

required

4. 대행사 상태 변경 (AAG004)

HTTP request

PUT /core/admin/api/v1/agents/1/status?status=NORMAL HTTP/1.1
Content-Type: application/json
Host: localhost:8080

HTTP response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 87

{"result":null,"code":"0","message":"요청이 성공적으로 완료되었습니다."}

Path parameters

Table 1. /core/admin/api/v1/agents/{agentId}/status
Parameter Description

agentId

대행사 UID

Query parameters

Parameter Description Required

status

NORMAL : 활성화 STOP : 비활성화

required

Response body

{"result":null,"code":"0","message":"요청이 성공적으로 완료되었습니다."}

Response fields

Path Type Description Required

code

String

응답 코드

required

message

String

오류 메시지

required

result

Null

결과

required

5. 대행사 최상위 그룹장 회원 가입 (직접 등록) (AAG005)

HTTP request

POST /core/admin/api/v1/agents/1/users HTTP/1.1
Content-Type: application/json
Content-Length: 147
Host: localhost:8080

{"userType":"AGENCY_GROUP_MANAGER","name":"회원 이름","emailAddress":"회원 아이디","password":"비밀번호","phoneNumber":"전화번호"}

HTTP response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 207

{"result":{"userId":1,"agentId":1,"id":"아이디","status":"NORMAL","type":"ADVERTISER","name":"이름","phoneNumber":"전화번호"},"code":"0","message":"요청이 성공적으로 완료되었습니다."}

Request body

{"userType":"AGENCY_GROUP_MANAGER","name":"회원 이름","emailAddress":"회원 아이디","password":"비밀번호","phoneNumber":"전화번호"}

Request fields

Path Type Description Required

userType

String

ASSOCIATE_ADVERTISER : 준광고주 ADVERTISER : 광고주 AGENCY_GROUP_MEMBER : 대행사 그룹원 AGENCY_GROUP_MANAGER : 대행사 그룹장 AGENCY_GROUP_MASTER : 대행사 최상위 그룹장 OPERATIONS_MANAGER : 운영관리자 SYSTEM_ADMINISTRATOR : 시스템 관리자

required

name

String

회원 이름

required

emailAddress

String

회원 ID

required

password

String

비밀번호

required

phoneNumber

String

전화번호

optional

Response body

{"result":{"userId":1,"agentId":1,"id":"아이디","status":"NORMAL","type":"ADVERTISER","name":"이름","phoneNumber":"전화번호"},"code":"0","message":"요청이 성공적으로 완료되었습니다."}

Response fields

Path Type Description Required

code

String

응답 코드

required

message

String

오류 메시지

required

result.userId

Number

회원 UID

required

result.agentId

Number

대행사 UID

required

result.id

String

회원 id

required

result.status

String

NORMAL : 활성화 STOP : 비활성화 TEMP : 임시

required

result.type

String

ASSOCIATE_ADVERTISER : 준광고주 ADVERTISER : 광고주 AGENCY_GROUP_MEMBER : 대행사 그룹원 AGENCY_GROUP_MANAGER : 대행사 그룹장 AGENCY_GROUP_MASTER : 대행사 최상위 그룹장 OPERATIONS_MANAGER : 운영관리자 SYSTEM_ADMINISTRATOR : 시스템 관리자

required

result.name

String

회원 이름

required

result.phoneNumber

String

회원 전화번호

required

6. 대행사 회원 페이지네이션 조회 (AAG006)

HTTP request

GET /core/admin/api/v1/agents/users?page=1&size=10 HTTP/1.1
Content-Type: application/json
Host: localhost:8080

HTTP response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 330

{"result":{"content":[{"agentId":1,"userId":1,"agentName":"대행사 이름","type":"AGENCY_GROUP_MANAGER","userName":"회원 이름","loginId":"test@Test.com","status":"NORMAL","registerDt":"2025-06-27T12:13:48.2363799"}],"page":1,"size":10,"totalCount":1},"code":"0","message":"요청이 성공적으로 완료되었습니다."}

Query parameters

Parameter Description Required

page

페이지 번호 (1부터 시작)

required

size

페이지 크기

required

sort

해당 부분 사용하지 않음, OrderType을 통해 정렬 기준 제어

optional

keyword

대행사, 대표자 검색 키워드

optional

orderType

AGENT_ASC AGENT_DESC USER_TYPE_ASC USER_TYPE_DESC NAME_ASC NAME_DESC LOGIN_ID_ASC LOGIN_ID_DESC STATUS_ASC STATUS_DESC REGISTER_DT_ASC REGISTER_DT_DESC

optional

Response body

{"result":{"content":[{"agentId":1,"userId":1,"agentName":"대행사 이름","type":"AGENCY_GROUP_MANAGER","userName":"회원 이름","loginId":"test@Test.com","status":"NORMAL","registerDt":"2025-06-27T12:13:48.2363799"}],"page":1,"size":10,"totalCount":1},"code":"0","message":"요청이 성공적으로 완료되었습니다."}

Response fields

Path Type Description Required

code

String

응답 코드

required

message

String

오류 메시지

required

result.content[].agentId

Number

대행사 UID

required

result.content[].userId

Number

회원 UID

required

result.content[].agentName

String

대행사명

required

result.content[].type

String

ASSOCIATE_ADVERTISER : 준광고주 ADVERTISER : 광고주 AGENCY_GROUP_MEMBER : 대행사 그룹원 AGENCY_GROUP_MANAGER : 대행사 그룹장 AGENCY_GROUP_MASTER : 대행사 최상위 그룹장 OPERATIONS_MANAGER : 운영관리자 SYSTEM_ADMINISTRATOR : 시스템 관리자

required

result.content[].userName

String

회원 이름

required

result.content[].loginId

String

회원 ID

required

result.content[].status

String

NORMAL : 활성화 STOP : 비활성화

required

result.content[].registerDt

String

회원 등록 시간

required

result.page

Number

페이지 번호

required

result.size

Number

사이즈

required

result.totalCount

Number

전체 갯수

required

7. 대행사 회원 상태 변경 (AAG007)

HTTP request

PUT /core/admin/api/v1/agents/1/users/1/status?status=NORMAL HTTP/1.1
Content-Type: application/json
Host: localhost:8080

HTTP response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 87

{"result":null,"code":"0","message":"요청이 성공적으로 완료되었습니다."}

Path parameters

Table 1. /core/admin/api/v1/agents/{agentId}/users/{userId}/status
Parameter Description

agentId

대행사 UID

userId

대행사 회원 UID

Query parameters

Parameter Description Required

status

NORMAL : 활성화 STOP : 비활성화

required

Response body

{"result":null,"code":"0","message":"요청이 성공적으로 완료되었습니다."}

Response fields

Path Type Description Required

code

String

응답 코드

required

message

String

오류 메시지

required

result

Null

결과

required

8. 대행사 회원 삭제 (AAG008)

HTTP request

DELETE /core/admin/api/v1/agents/1/users/1 HTTP/1.1
Content-Type: application/json
Host: localhost:8080

HTTP response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 87

{"result":null,"code":"0","message":"요청이 성공적으로 완료되었습니다."}

Path parameters

Table 1. /core/admin/api/v1/agents/{agentId}/users/{userId}
Parameter Description

agentId

대행사 UID

userId

대행사 회원 UID

Response body

{"result":null,"code":"0","message":"요청이 성공적으로 완료되었습니다."}

Response fields

Path Type Description Required

code

String

응답 코드

required

message

String

오류 메시지

required

result

Null

결과

required

9. 대행사 고유 코드 중복 체크 (AAG009)

HTTP request

GET /core/admin/api/v1/agents/uniquecode/duplicate?uniqueCode=AAAA HTTP/1.1
Content-Type: application/json
Host: localhost:8080

HTTP response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 101

{"result":{"duplicate":true},"code":"0","message":"요청이 성공적으로 완료되었습니다."}

Query parameters

Parameter Description Required

uniqueCode

대행사 고유 코드

required

Response body

{"result":{"duplicate":true},"code":"0","message":"요청이 성공적으로 완료되었습니다."}

Response fields

Path Type Description Required

code

String

응답 코드

required

message

String

오류 메시지

required

result.duplicate

Boolean

true : 중복, false : 중복 아님

required

10. 대행사 도메인 이름 중복 체크 (AAG011)

HTTP request

GET /core/admin/api/v1/agents/domain-name/duplicate?domainName=test@test.com HTTP/1.1
Content-Type: application/json
Host: localhost:8080

HTTP response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 101

{"result":{"duplicate":true},"code":"0","message":"요청이 성공적으로 완료되었습니다."}

Query parameters

Parameter Description Required

domainName

대행사 도메인 이름

required

Response body

{"result":{"duplicate":true},"code":"0","message":"요청이 성공적으로 완료되었습니다."}

Response fields

Path Type Description Required

code

String

응답 코드

required

message

String

오류 메시지

required

result.duplicate

Boolean

true : 중복, false : 중복 아님

required

11. 대행사 전체 리스트 조회 (AAG012)

HTTP request

GET /core/admin/api/v1/agents/all HTTP/1.1
Content-Type: application/json
Host: localhost:8080

HTTP response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 331

{"result":[{"agent":{"agentId":1,"name":"대행사 이름","uniqueCode":"고유 코드","representativeName":"대표자 이름","businessRegistrationNumber":"사업자 등록 번호","status":"NORMAL","domainName":"도메인 이름"},"isMasterAccount":true}],"code":"0","message":"요청이 성공적으로 완료되었습니다."}

Response body

{"result":[{"agent":{"agentId":1,"name":"대행사 이름","uniqueCode":"고유 코드","representativeName":"대표자 이름","businessRegistrationNumber":"사업자 등록 번호","status":"NORMAL","domainName":"도메인 이름"},"isMasterAccount":true}],"code":"0","message":"요청이 성공적으로 완료되었습니다."}

Response fields

Path Type Description Required

code

String

응답 코드

required

message

String

오류 메시지

required

result[].agent.agentId

Number

대행사 UID

required

result[].agent.name

String

대행사 이름

required

result[].agent.uniqueCode

String

대행사 고유 코드

required

result[].agent.representativeName

String

대행사 대표 이름

required

result[].agent.businessRegistrationNumber

String

대행사 사업자 등록 번호

required

result[].agent.status

String

NORMAL : 활성화 STOP : 비활성화

required

result[].agent.domainName

String

대행사 도메인 이름

required

result[].isMasterAccount

Boolean

true : 최상위 그룹장 계정 존재, false : 최상위 그룹장 계정 미존재

required

12. 대행사 최상위 그룹장 회원 초대 메일 발송 (AAG013)

HTTP request

POST /core/admin/api/v1/agents/users/email HTTP/1.1
Content-Type: application/json
Content-Length: 111
Host: localhost:8080

{"agentId":1,"userType":"AGENCY_GROUP_MANAGER","name":"대행사 회원 이름","emailAddress":"test@test.com"}

HTTP response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 87

{"result":null,"code":"0","message":"요청이 성공적으로 완료되었습니다."}

Request body

{"agentId":1,"userType":"AGENCY_GROUP_MANAGER","name":"대행사 회원 이름","emailAddress":"test@test.com"}

Request fields

Path Type Description Required

agentId

Number

대행사 UID

required

userType

String

ASSOCIATE_ADVERTISER : 준광고주 ADVERTISER : 광고주 AGENCY_GROUP_MEMBER : 대행사 그룹원 AGENCY_GROUP_MANAGER : 대행사 그룹장 AGENCY_GROUP_MASTER : 대행사 최상위 그룹장 OPERATIONS_MANAGER : 운영관리자 SYSTEM_ADMINISTRATOR : 시스템 관리자

required

name

String

회원 이름

required

emailAddress

String

이메일

required

Response body

{"result":null,"code":"0","message":"요청이 성공적으로 완료되었습니다."}

Response fields

Path Type Description Required

code

String

응답 코드

required

message

String

오류 메시지

required

result

Null

결과

required

13. 관리자 본인 및 하위 회원 정보 조회 (AAG016)

HTTP request

GET /core/admin/api/v1/agents/users/1 HTTP/1.1
Content-Type: application/json
Host: localhost:8080

HTTP response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 207

{"result":{"userId":1,"agentId":1,"id":"아이디","status":"NORMAL","type":"ADVERTISER","name":"이름","phoneNumber":"전화번호"},"code":"0","message":"요청이 성공적으로 완료되었습니다."}

Path parameters

Table 1. /core/admin/api/v1/agents/users/{userId}
Parameter Description

userId

회원 UID

Response body

{"result":{"userId":1,"agentId":1,"id":"아이디","status":"NORMAL","type":"ADVERTISER","name":"이름","phoneNumber":"전화번호"},"code":"0","message":"요청이 성공적으로 완료되었습니다."}

Response fields

Path Type Description Required

code

String

응답 코드

required

message

String

오류 메시지

required

result.userId

Number

회원 UID

required

result.agentId

Number

대행사 UID

required

result.id

String

회원 id

required

result.status

String

NORMAL : 활성화 STOP : 비활성화 TEMP : 임시

required

result.type

String

ASSOCIATE_ADVERTISER : 준광고주 ADVERTISER : 광고주 AGENCY_GROUP_MEMBER : 대행사 그룹원 AGENCY_GROUP_MANAGER : 대행사 그룹장 AGENCY_GROUP_MASTER : 대행사 최상위 그룹장 OPERATIONS_MANAGER : 운영관리자 SYSTEM_ADMINISTRATOR : 시스템 관리자

required

result.name

String

회원 이름

required

result.phoneNumber

String

회원 전화번호

required

14. 대행사 단일 정보 조회 (AAG017)

HTTP request

GET /core/admin/api/v1/agents/1 HTTP/1.1
Content-Type: application/json
Host: localhost:8080

HTTP response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 473

{"result":{"agent":{"agentId":1,"name":"대행사 이름","uniqueCode":"고유 코드","representativeName":"대표자 이름","businessRegistrationNumber":"사업자 등록 번호","status":"NORMAL","domainName":"도메인 이름"},"agentBills":[{"agentBillId":1,"agentId":1,"name":"세금 계산서 담당자명","phoneNumber":"담당자 전화번호","emailAddress":"담당자 이메일 주소"}]},"code":"0","message":"요청이 성공적으로 완료되었습니다."}

Path parameters

Table 1. /core/admin/api/v1/agents/{agentId}
Parameter Description

agentId

대행사 UID

Response body

{"result":{"agent":{"agentId":1,"name":"대행사 이름","uniqueCode":"고유 코드","representativeName":"대표자 이름","businessRegistrationNumber":"사업자 등록 번호","status":"NORMAL","domainName":"도메인 이름"},"agentBills":[{"agentBillId":1,"agentId":1,"name":"세금 계산서 담당자명","phoneNumber":"담당자 전화번호","emailAddress":"담당자 이메일 주소"}]},"code":"0","message":"요청이 성공적으로 완료되었습니다."}

Response fields

Path Type Description Required

code

String

응답 코드

required

message

String

오류 메시지

required

result.agent.agentId

Number

대행사 UID

required

result.agent.name

String

대행사 이름

required

result.agent.uniqueCode

String

대행사 고유코드

required

result.agent.representativeName

String

대행사 대표자명

required

result.agent.businessRegistrationNumber

String

대행사 사업자 등록 번호

required

result.agent.status

String

NORMAL : 활성화 STOP : 비활성화

required

result.agent.domainName

String

대행사 도메인 이름

required

result.agentBills[].agentBillId

Number

대행사 세금 계산서 UID

optional

result.agentBills[].agentId

Number

대행사 UID

optional

result.agentBills[].name

String

대행사 세금 계산서 담당자명

optional

result.agentBills[].phoneNumber

String

대행사 세금 계산서 담당자 전화번호

optional

result.agentBills[].emailAddress

String

대행사 세금 계산서 이메일 주소

optional

15. 광고주 심사 관리 리스트 조회 (운영 관리자 전용) (AAG018)

HTTP request

GET /core/admin/api/v1/agents/1/users/1/advertisers/audit/list?page=1&size=10&keyword=%EA%B2%80%EC%83%89%ED%95%A0+%ED%82%A4%EC%9B%8C%EB%93%9C&orderType=ADVERTISER_REGISTER_DESC HTTP/1.1
Content-Type: application/json
Host: localhost:8080

HTTP response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 493

{"result":{"content":[{"agentId":1,"agentName":"대행사명","userId":1,"userName":"회원 이름","advertiserId":1,"advertiserCustomerId":1,"advertiserLoginId":"광고주 로그인 아이디","advertiserNickname":"광고주 닉네임","advertiserName":"광고주명","advertiserType":"ADVERTISER_AGREE_WAIT","registerOrUpdateDt":"2025-06-27T12:13:47.83660567","isOperatorRead":true}],"page":1,"size":10,"totalCount":1},"code":"0","message":"요청이 성공적으로 완료되었습니다."}

Path parameters

Table 1. /core/admin/api/v1/agents/{agentId}/users/{userId}/advertisers/audit/list
Parameter Description

agentId

대행사 UID

userId

회원 UID

Query parameters

Parameter Description Required

page

페이지 번호 (1부터 시작)

required

size

페이지 크기

required

sort

해당 부분 사용하지 않음, OrderType을 통해 정렬 기준 제어

optional

keyword

대행사, 회원명, 이메일 검색 키워드

optional

orderType

ADVERTISER_REGISTER_DESC ADVERTISER_REGISTER_ASC ADVERTISER_STATUS_DESC ADVERTISER_STATUS_ASC ADVERTISER_NAME_DESC ADVERTISER_NAME_ASC ADVERTISER_NICK_NAME_DESC ADVERTISER_NICK_NAME_ASC ADVERTISER_ID_DESC ADVERTISER_ID_ASC ADVERTISER_CUSTOMER_ID_DESC ADVERTISER_CUSTOMER_ID_ASC USER_NAME_DESC USER_NAME_ASC AGENT_NAME_DESC AGENT_NAME_ASC

required

Response body

{"result":{"content":[{"agentId":1,"agentName":"대행사명","userId":1,"userName":"회원 이름","advertiserId":1,"advertiserCustomerId":1,"advertiserLoginId":"광고주 로그인 아이디","advertiserNickname":"광고주 닉네임","advertiserName":"광고주명","advertiserType":"ADVERTISER_AGREE_WAIT","registerOrUpdateDt":"2025-06-27T12:13:47.83660567","isOperatorRead":true}],"page":1,"size":10,"totalCount":1},"code":"0","message":"요청이 성공적으로 완료되었습니다."}

Response fields

Path Type Description Required

code

String

응답 코드

required

message

String

오류 메시지

required

result.content[].agentId

Number

대행사 UID

required

result.content[].agentName

String

대행사 명

required

result.content[].userId

Number

회원 UID

required

result.content[].userName

String

회원 이름

required

result.content[].advertiserId

Number

광고주 UID

required

result.content[].advertiserCustomerId

Number

광고주 customerId

required

result.content[].advertiserLoginId

String

광고주 로그인 ID

required

result.content[].advertiserNickname

String

광고주 닉네임

required

result.content[].advertiserName

String

광고주명

required

result.content[].advertiserType

String

UNSYNC_ADVERTISER : 광고주 비동기화 APPLICABLE : 신청 가능 WAIT_REVIEW : 심사 대기 REJECT : 심사 반려 OPERATION_REVIEW : 운영 검토 대기 OPERATION_REJECT : 운영 검토 거절 OPERATION_REVIEW_SUCCESS : 운영 검토 완료 ADVERTISER_AGREE_WAIT : 광고주 동의 대기 ADVERTISER_AGREE_TIME_EXPIRE : 광고주 동의 기한 만료 CANCEL : 신청 취소 REGISTER_WITHDRAW_ACCOUNT_FAIL : 출금 계좌 등록 실패 OPERATION : 운영중 PAUSE : 일시중지 TERMINATE_WAIT : 해지 대기 TERMINATE : 해지

required

result.content[].isOperatorRead

Boolean

운영 관리자 읽었는지 여부 true : 읽음 , false : 안읽음

required

result.content[].registerOrUpdateDt

String

광고주 등록 또는 수정 시간

required

result.page

Number

페이지 번호

required

result.size

Number

사이즈

required

result.totalCount

Number

전체 갯수

required

16. 광고주 심사 목록 읽음, 미읽음 상태 변경 (운영 관리자 전용) (AAG019)

HTTP request

PATCH /core/admin/api/v1/agents/1/users/1/advertisers/1/alarm?isOperatorRead=false HTTP/1.1
Content-Type: application/json
Host: localhost:8080

HTTP response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 87

{"result":null,"code":"0","message":"요청이 성공적으로 완료되었습니다."}

Path parameters

Table 1. /core/admin/api/v1/agents/{agentId}/users/{userId}/advertisers/{advertiserId}/alarm
Parameter Description

agentId

대행사 UID

userId

회원 UID

advertiserId

광고주 UID

Query parameters

Parameter Description Required

isOperatorRead

true : 읽음 , false : 미읽음

required

Response body

{"result":null,"code":"0","message":"요청이 성공적으로 완료되었습니다."}

Response fields

Path Type Description Required

code

String

응답 코드

required

message

String

오류 메시지

required

result

Null

결과

required

17. 광고주 detail 조회 (AAG020)

HTTP request

GET /core/admin/api/v1/agents/1/users/1/advertisers/1/details HTTP/1.1
Content-Type: application/json
Host: localhost:8080

HTTP response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 405

{"result":{"advertiserId":1,"userId":1,"customerId":1,"id":"아이디","nickName":"닉네임","name":"광고주명","representativeName":"대표자명","businessRegistrationNumber":"광고주 사업자 등록 번호","phoneNumber":"전화번호","emailAddress":"이메일","status":"WAIT_REVIEW","roleId":1,"isLossPrivileges":false},"code":"0","message":"요청이 성공적으로 완료되었습니다."}

Path parameters

Table 1. /core/admin/api/v1/agents/{agentId}/users/{userId}/advertisers/{advertiserId}/details
Parameter Description

agentId

대행사 UID

userId

회원 UID

advertiserId

광고주 UID

Response body

{"result":{"advertiserId":1,"userId":1,"customerId":1,"id":"아이디","nickName":"닉네임","name":"광고주명","representativeName":"대표자명","businessRegistrationNumber":"광고주 사업자 등록 번호","phoneNumber":"전화번호","emailAddress":"이메일","status":"WAIT_REVIEW","roleId":1,"isLossPrivileges":false},"code":"0","message":"요청이 성공적으로 완료되었습니다."}

Response fields

Path Type Description Required

code

String

응답 코드

required

message

String

오류 메시지

required

result.advertiserId

Number

광고주 UID

required

result.userId

Number

광고주 매핑 마케터 UID

required

result.customerId

Number

광고주 customer Id

required

result.id

String

광고주 로그인 ID

required

result.nickName

String

광고주 닉네임

required

result.name

String

광고주명

optional

result.representativeName

String

광고주 대표자명

optional

result.businessRegistrationNumber

String

광고주 사업자 등록 번호

optional

result.phoneNumber

String

광고주 전화번호

optional

result.emailAddress

String

광고주 이메일

optional

result.status

String

UNSYNC_ADVERTISER : 광고주 비동기화 APPLICABLE : 신청 가능 WAIT_REVIEW : 심사 대기 REJECT : 심사 반려 OPERATION_REVIEW : 운영 검토 대기 OPERATION_REJECT : 운영 검토 거절 OPERATION_REVIEW_SUCCESS : 운영 검토 완료 ADVERTISER_AGREE_WAIT : 광고주 동의 대기 ADVERTISER_AGREE_TIME_EXPIRE : 광고주 동의 기한 만료 CANCEL : 신청 취소 REGISTER_WITHDRAW_ACCOUNT_FAIL : 출금 계좌 등록 실패 OPERATION : 운영중 PAUSE : 일시중지 TERMINATE_WAIT : 해지 대기 TERMINATE : 해지

required

result.roleId

Number

광고주 역할 UID

required

result.isLossPrivileges

Boolean

권한 상실 여부 true : 상실 false : 비상실

required

18. 광고주 smPay 신청 이력 리스트 조회 (AAG021)

HTTP request

GET /core/admin/api/v1/agents/1/users/1/advertisers/1/apply-form-list HTTP/1.1
Content-Type: application/json
Host: localhost:8080

HTTP response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1252

{"result":[{"chargeRules":[{"advertiserFormChargeRuleId":1,"advertiserFormId":1,"rangeType":"UP","boundType":"FIXED_AMOUNT","changePercentOrValue":1}],"accounts":[{"advertiserFormAccountId":1,"advertiserFormId":1,"advertiserAccountCode":"002","advertiserAccountCodeName":"은행명","advertiserAccountNumber":"계좌번호","advertiserAccountName":"예금주","advertiserAccountType":"DEPOSIT"}],"advertiserFormId":1,"advertiserId":1,"advertiserCustomerId":1231231,"advertiserLoginId":"광고주 로그인 ID","advertiserStatus":"ADVERTISER_AGREE_TIME_EXPIRE","advertiserName":"광고주명","advertiserNickname":"광고주 닉네임","advertiserRepresentativeName":"광고주 대표자명","advertiserPhoneNumber":"0101111111","advertiserEmailAddress":"pgw111111@naver.com","advertiserOperationPeriod":1,"advertiserDailyAverageRoas":0.01,"advertiserMonthlyConvAmt":0.01,"advertiserDailySalesAmt":0.01,"advertiserRecommendRoasPercent":0.01,"advertiserStandardRoasPercent":1,"advertiserRejectDescription":"반려 사유","initialAmount":1,"maxChargeLimit":1,"minChargeLimit":1,"reviewerMemo":"심사자 메모","approvalMemo":"운영자 메모","registerDt":null,"updateDt":null}],"code":"0","message":"요청이 성공적으로 완료되었습니다."}

Path parameters

Table 1. /core/admin/api/v1/agents/{agentId}/users/{userId}/advertisers/{advertiserId}/apply-form-list
Parameter Description

agentId

대행사 UID

userId

회원 UID

advertiserId

광고주 UID

Response body

{"result":[{"chargeRules":[{"advertiserFormChargeRuleId":1,"advertiserFormId":1,"rangeType":"UP","boundType":"FIXED_AMOUNT","changePercentOrValue":1}],"accounts":[{"advertiserFormAccountId":1,"advertiserFormId":1,"advertiserAccountCode":"002","advertiserAccountCodeName":"은행명","advertiserAccountNumber":"계좌번호","advertiserAccountName":"예금주","advertiserAccountType":"DEPOSIT"}],"advertiserFormId":1,"advertiserId":1,"advertiserCustomerId":1231231,"advertiserLoginId":"광고주 로그인 ID","advertiserStatus":"ADVERTISER_AGREE_TIME_EXPIRE","advertiserName":"광고주명","advertiserNickname":"광고주 닉네임","advertiserRepresentativeName":"광고주 대표자명","advertiserPhoneNumber":"0101111111","advertiserEmailAddress":"pgw111111@naver.com","advertiserOperationPeriod":1,"advertiserDailyAverageRoas":0.01,"advertiserMonthlyConvAmt":0.01,"advertiserDailySalesAmt":0.01,"advertiserRecommendRoasPercent":0.01,"advertiserStandardRoasPercent":1,"advertiserRejectDescription":"반려 사유","initialAmount":1,"maxChargeLimit":1,"minChargeLimit":1,"reviewerMemo":"심사자 메모","approvalMemo":"운영자 메모","registerDt":null,"updateDt":null}],"code":"0","message":"요청이 성공적으로 완료되었습니다."}

Response fields

Path Type Description Required

code

String

응답 코드

required

message

String

오류 메시지

required

result[].advertiserFormId

Number

광고주 신청서 ID

required

result[].advertiserId

Number

광고주 UID

required

result[].advertiserCustomerId

Number

광고주 Customer Id

required

result[].advertiserLoginId

String

광고주 로그인 ID

required

result[].advertiserStatus

String

UNSYNC_ADVERTISER : 광고주 비동기화 APPLICABLE : 신청 가능 WAIT_REVIEW : 심사 대기 REJECT : 심사 반려 OPERATION_REVIEW : 운영 검토 대기 OPERATION_REJECT : 운영 검토 거절 OPERATION_REVIEW_SUCCESS : 운영 검토 완료 ADVERTISER_AGREE_WAIT : 광고주 동의 대기 ADVERTISER_AGREE_TIME_EXPIRE : 광고주 동의 기한 만료 CANCEL : 신청 취소 REGISTER_WITHDRAW_ACCOUNT_FAIL : 출금 계좌 등록 실패 OPERATION : 운영중 PAUSE : 일시중지 TERMINATE_WAIT : 해지 대기 TERMINATE : 해지

required

result[].advertiserName

String

광고주명

required

result[].advertiserNickname

String

광고주 닉네임

required

result[].advertiserRepresentativeName

String

광고주 대표자명

required

result[].advertiserPhoneNumber

String

광고주 전화번호

required

result[].advertiserEmailAddress

String

광고주 이메일

required

result[].advertiserOperationPeriod

Number

광고주 운영 기간 (개월)

required

result[].advertiserDailyAverageRoas

Number

일일 평균 ROAS

required

result[].advertiserMonthlyConvAmt

Number

월 평균 전환 금액

required

result[].advertiserDailySalesAmt

Number

일일 매출 금액

required

result[].advertiserRecommendRoasPercent

Number

권장 ROAS 비율

required

result[].advertiserStandardRoasPercent

Number

기준 ROAS

required

result[].chargeRules[].advertiserFormChargeRuleId

Number

충전 규칙 UID

required

result[].chargeRules[].advertiserFormId

Number

심사 스냅샷 UID

required

result[].chargeRules[].rangeType

String

UP DOWN

required

result[].chargeRules[].boundType

String

FIXED_AMOUNT PERCENTAGE

required

result[].chargeRules[].changePercentOrValue

Number

상승 퍼센테이지 또는 상승금액

required

result[].initialAmount

Number

초기 금액

required

result[].maxChargeLimit

Number

최대 충전 한도

required

result[].minChargeLimit

Number

최소 충전 한도

required

result[].reviewerMemo

String

검토자 메모

optional

result[].approvalMemo

String

승인 메모

optional

result[].registerDt

Null

등록 일시

required

result[].updateDt

Null

수정 일시

optional

result[].advertiserRejectDescription

String

거절 사유

optional

result[].accounts[].advertiserFormAccountId

Number

이력 계좌 정보 UID

optional

result[].accounts[].advertiserFormId

Number

이력 UID

optional

result[].accounts[].advertiserAccountCode

String

BANK_002 BANK_003 BANK_004 BANK_007 BANK_011 BANK_012 BANK_020 BANK_023 BANK_027 BANK_031 BANK_032 BANK_034 BANK_035 BANK_037 BANK_039 BANK_045 BANK_048 BANK_050 BANK_052 BANK_054 BANK_055 BANK_057 BANK_058 BANK_059 BANK_060 BANK_061 BANK_062 BANK_063 BANK_064 BANK_065 BANK_066 BANK_067 BANK_071 BANK_081 BANK_088 BANK_089 BANK_090 BANK_092 BANK_209 BANK_218 BANK_238 BANK_240 BANK_243 BANK_247 BANK_261 BANK_262 BANK_263 BANK_264 BANK_265 BANK_266 BANK_267 BANK_269 BANK_270 BANK_278 BANK_279 BANK_280 BANK_287 BANK_288 BANK_290 BANK_291 BANK_292 BANK_293 BANK_294

optional

result[].accounts[].advertiserAccountCodeName

String

은행명

optional

result[].accounts[].advertiserAccountNumber

String

계좌 번호

optional

result[].accounts[].advertiserAccountName

String

예금주명

optional

result[].accounts[].advertiserAccountType

String

DEPOSIT WITHDRAW

optional

19. 광고주 smPay 신청 이력 상세 조회(AAG022)

HTTP request

GET /core/admin/api/v1/agents/1/users/1/advertisers/1/form/1 HTTP/1.1
Content-Type: application/json
Host: localhost:8080

HTTP response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1250

{"result":{"chargeRules":[{"advertiserFormChargeRuleId":1,"advertiserFormId":1,"rangeType":"UP","boundType":"FIXED_AMOUNT","changePercentOrValue":1}],"accounts":[{"advertiserFormAccountId":1,"advertiserFormId":1,"advertiserAccountCode":"002","advertiserAccountCodeName":"은행명","advertiserAccountNumber":"계좌번호","advertiserAccountName":"예금주","advertiserAccountType":"DEPOSIT"}],"advertiserFormId":1,"advertiserId":1,"advertiserCustomerId":1231231,"advertiserLoginId":"광고주 로그인 ID","advertiserStatus":"ADVERTISER_AGREE_TIME_EXPIRE","advertiserName":"광고주명","advertiserNickname":"광고주 닉네임","advertiserRepresentativeName":"광고주 대표자명","advertiserPhoneNumber":"0101111111","advertiserEmailAddress":"pgw111111@naver.com","advertiserOperationPeriod":1,"advertiserDailyAverageRoas":0.01,"advertiserMonthlyConvAmt":0.01,"advertiserDailySalesAmt":0.01,"advertiserRecommendRoasPercent":0.01,"advertiserStandardRoasPercent":1,"advertiserRejectDescription":"반려 사유","initialAmount":1,"maxChargeLimit":1,"minChargeLimit":1,"reviewerMemo":"심사자 메모","approvalMemo":"운영자 메모","registerDt":null,"updateDt":null},"code":"0","message":"요청이 성공적으로 완료되었습니다."}

Path parameters

Table 1. /core/admin/api/v1/agents/{agentId}/users/{userId}/advertisers/{advertiserId}/form/{formId}
Parameter Description

agentId

대행사 UID

userId

회원 UID

advertiserId

광고주 UID

formId

심사 이력 UID

Response body

{"result":{"chargeRules":[{"advertiserFormChargeRuleId":1,"advertiserFormId":1,"rangeType":"UP","boundType":"FIXED_AMOUNT","changePercentOrValue":1}],"accounts":[{"advertiserFormAccountId":1,"advertiserFormId":1,"advertiserAccountCode":"002","advertiserAccountCodeName":"은행명","advertiserAccountNumber":"계좌번호","advertiserAccountName":"예금주","advertiserAccountType":"DEPOSIT"}],"advertiserFormId":1,"advertiserId":1,"advertiserCustomerId":1231231,"advertiserLoginId":"광고주 로그인 ID","advertiserStatus":"ADVERTISER_AGREE_TIME_EXPIRE","advertiserName":"광고주명","advertiserNickname":"광고주 닉네임","advertiserRepresentativeName":"광고주 대표자명","advertiserPhoneNumber":"0101111111","advertiserEmailAddress":"pgw111111@naver.com","advertiserOperationPeriod":1,"advertiserDailyAverageRoas":0.01,"advertiserMonthlyConvAmt":0.01,"advertiserDailySalesAmt":0.01,"advertiserRecommendRoasPercent":0.01,"advertiserStandardRoasPercent":1,"advertiserRejectDescription":"반려 사유","initialAmount":1,"maxChargeLimit":1,"minChargeLimit":1,"reviewerMemo":"심사자 메모","approvalMemo":"운영자 메모","registerDt":null,"updateDt":null},"code":"0","message":"요청이 성공적으로 완료되었습니다."}

Response fields

Path Type Description Required

code

String

응답 코드

required

message

String

오류 메시지

required

result.advertiserFormId

Number

광고주 신청서 ID

required

result.advertiserId

Number

광고주 UID

required

result.advertiserCustomerId

Number

광고주 Customer Id

required

result.advertiserLoginId

String

광고주 로그인 ID

required

result.advertiserStatus

String

UNSYNC_ADVERTISER : 광고주 비동기화 APPLICABLE : 신청 가능 WAIT_REVIEW : 심사 대기 REJECT : 심사 반려 OPERATION_REVIEW : 운영 검토 대기 OPERATION_REJECT : 운영 검토 거절 OPERATION_REVIEW_SUCCESS : 운영 검토 완료 ADVERTISER_AGREE_WAIT : 광고주 동의 대기 ADVERTISER_AGREE_TIME_EXPIRE : 광고주 동의 기한 만료 CANCEL : 신청 취소 REGISTER_WITHDRAW_ACCOUNT_FAIL : 출금 계좌 등록 실패 OPERATION : 운영중 PAUSE : 일시중지 TERMINATE_WAIT : 해지 대기 TERMINATE : 해지

required

result.advertiserName

String

광고주명

required

result.advertiserNickname

String

광고주 닉네임

required

result.advertiserRepresentativeName

String

광고주 대표자명

required

result.advertiserPhoneNumber

String

광고주 전화번호

required

result.advertiserEmailAddress

String

광고주 이메일

required

result.advertiserOperationPeriod

Number

광고주 운영 기간 (개월)

required

result.advertiserDailyAverageRoas

Number

일일 평균 ROAS

required

result.advertiserMonthlyConvAmt

Number

월 평균 전환 금액

required

result.advertiserDailySalesAmt

Number

일일 매출 금액

required

result.advertiserRecommendRoasPercent

Number

권장 ROAS 비율

required

result.advertiserStandardRoasPercent

Number

기준 ROAS

required

result.chargeRules[].advertiserFormChargeRuleId

Number

충전 규칙 UID

required

result.chargeRules[].advertiserFormId

Number

심사 스냅샷 UID

required

result.chargeRules[].rangeType

String

UP DOWN

required

result.chargeRules[].boundType

String

FIXED_AMOUNT PERCENTAGE

required

result.chargeRules[].changePercentOrValue

Number

상승 퍼센테이지 또는 상승금액

required

result.initialAmount

Number

초기 금액

required

result.maxChargeLimit

Number

최대 충전 한도

required

result.minChargeLimit

Number

최소 충전 한도

required

result.reviewerMemo

String

검토자 메모

optional

result.approvalMemo

String

승인 메모

optional

result.registerDt

Null

등록 일시

required

result.updateDt

Null

수정 일시

optional

result.advertiserRejectDescription

String

거절 사유

optional

result.accounts[].advertiserFormAccountId

Number

이력 계좌 정보 UID

optional

result.accounts[].advertiserFormId

Number

이력 UID

optional

result.accounts[].advertiserAccountCode

String

BANK_002 BANK_003 BANK_004 BANK_007 BANK_011 BANK_012 BANK_020 BANK_023 BANK_027 BANK_031 BANK_032 BANK_034 BANK_035 BANK_037 BANK_039 BANK_045 BANK_048 BANK_050 BANK_052 BANK_054 BANK_055 BANK_057 BANK_058 BANK_059 BANK_060 BANK_061 BANK_062 BANK_063 BANK_064 BANK_065 BANK_066 BANK_067 BANK_071 BANK_081 BANK_088 BANK_089 BANK_090 BANK_092 BANK_209 BANK_218 BANK_238 BANK_240 BANK_243 BANK_247 BANK_261 BANK_262 BANK_263 BANK_264 BANK_265 BANK_266 BANK_267 BANK_269 BANK_270 BANK_278 BANK_279 BANK_280 BANK_287 BANK_288 BANK_290 BANK_291 BANK_292 BANK_293 BANK_294

optional

result.accounts[].advertiserAccountCodeName

String

은행명

optional

result.accounts[].advertiserAccountNumber

String

계좌 번호

optional

result.accounts[].advertiserAccountName

String

예금주명

optional

result.accounts[].advertiserAccountType

String

DEPOSIT WITHDRAW

optional

20. 광고주 충전 규칙 조회(AAG023)

HTTP request

GET /core/admin/api/v1/agents/1/users/1/advertisers/1/charge-rule HTTP/1.1
Content-Type: application/json
Host: localhost:8080

HTTP response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 223

{"result":[{"advertiserChargeRuleId":1,"advertiserId":1,"standardRoasPercent":1,"changePercentOrValue":1,"rangeType":"UP","boundType":"FIXED_AMOUNT"}],"code":"0","message":"요청이 성공적으로 완료되었습니다."}

Path parameters

Table 1. /core/admin/api/v1/agents/{agentId}/users/{userId}/advertisers/{advertiserId}/charge-rule
Parameter Description

agentId

대행사 UID

userId

회원 UID

advertiserId

광고주 UID

Response body

{"result":[{"advertiserChargeRuleId":1,"advertiserId":1,"standardRoasPercent":1,"changePercentOrValue":1,"rangeType":"UP","boundType":"FIXED_AMOUNT"}],"code":"0","message":"요청이 성공적으로 완료되었습니다."}

Response fields

Path Type Description Required

code

String

응답 코드

required

message

String

오류 메시지

required

result[].advertiserChargeRuleId

Number

광고주 충전규칙 UID

required

result[].advertiserId

Number

광고주 UID

required

result[].standardRoasPercent

Number

광고주 충전 설정 ROAS

required

result[].changePercentOrValue

Number

정률 인상 퍼센트 또는 정액 인상 금액

required

result[].rangeType

String

UP DOWN

required

result[].boundType

String

FIXED_AMOUNT PERCENTAGE

required

21. 광고주 선결제 스케줄 조회(AAG024)

HTTP request

GET /core/admin/api/v1/agents/1/users/1/advertisers/1/pre-payment-schedule HTTP/1.1
Content-Type: application/json
Host: localhost:8080

HTTP response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 204

{"result":{"advertiserPrepaymentScheduleId":1,"advertiserId":1,"initialAmount":10000,"maxChargeLimit":10000,"minChargeLimit":10000},"code":"0","message":"요청이 성공적으로 완료되었습니다."}

Path parameters

Table 1. /core/admin/api/v1/agents/{agentId}/users/{userId}/advertisers/{advertiserId}/pre-payment-schedule
Parameter Description

agentId

대행사 UID

userId

회원 UID

advertiserId

광고주 UID

Response body

{"result":{"advertiserPrepaymentScheduleId":1,"advertiserId":1,"initialAmount":10000,"maxChargeLimit":10000,"minChargeLimit":10000},"code":"0","message":"요청이 성공적으로 완료되었습니다."}

Response fields

Path Type Description Required

code

String

응답 코드

required

message

String

오류 메시지

required

result.advertiserPrepaymentScheduleId

Number

광고주 선결제 규칙 UID

required

result.advertiserId

Number

광고주 UID

required

result.initialAmount

Number

광고주 최초 충전 금액 설정

required

result.maxChargeLimit

Number

일 최대 충전 한도

required

result.minChargeLimit

Number

일 최저 충전 한도

required

22. 광고주 심사자 참고용 메모 조회(AAG024)

HTTP request

GET /core/admin/api/v1/agents/1/users/1/advertisers/1/reviewer-memo HTTP/1.1
Content-Type: application/json
Host: localhost:8080

HTTP response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 144

{"result":{"advertiserReviewerMemosId":1,"description":"메모 내용"},"code":"0","message":"요청이 성공적으로 완료되었습니다."}

Path parameters

Table 1. /core/admin/api/v1/agents/{agentId}/users/{userId}/advertisers/{advertiserId}/reviewer-memo
Parameter Description

agentId

대행사 UID

userId

회원 UID

advertiserId

광고주 UID

Response body

{"result":{"advertiserReviewerMemosId":1,"description":"메모 내용"},"code":"0","message":"요청이 성공적으로 완료되었습니다."}

Response fields

Path Type Description Required

code

String

응답 코드

required

message

String

오류 메시지

required

result.advertiserReviewerMemosId

Number

심사자 참고용 메모 UID

optional

result.description

String

메모 내용

optional

23. 광고주 최상위 그룹장 참고용 메모 조회(AAG025)

HTTP request

GET /core/admin/api/v1/agents/1/users/1/advertisers/1/approval-memo HTTP/1.1
Content-Type: application/json
Host: localhost:8080

HTTP response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 147

{"result":{"advertiserApprovalMemosId":null,"description":"메모 내용"},"code":"0","message":"요청이 성공적으로 완료되었습니다."}

Path parameters

Table 1. /core/admin/api/v1/agents/{agentId}/users/{userId}/advertisers/{advertiserId}/approval-memo
Parameter Description

agentId

대행사 UID

userId

회원 UID

advertiserId

광고주 UID

Response body

{"result":{"advertiserApprovalMemosId":null,"description":"메모 내용"},"code":"0","message":"요청이 성공적으로 완료되었습니다."}

Response fields

Path Type Description Required

code

String

응답 코드

required

message

String

오류 메시지

required

result.advertiserApprovalMemosId

Null

최상위 그룹장 참고용 메모 UID

optional

result.description

String

메모 내용

optional

24. 광고주 운영 심사 승인/반려(AAG026)

HTTP request

POST /core/admin/api/v1/agents/1/users/1/advertisers/1/operator-decision HTTP/1.1
Content-Type: application/json
Content-Length: 327
Host: localhost:8080

{"decisionType":"APPROVE","chargeRule":[{"standardRoasPercent":1,"rangeType":"UP","boundType":"FIXED_AMOUNT","changePercentOrValue":1}],"prePaymentSchedule":{"initialAmount":1,"maxChargeLimit":1,"minChargeLimit":1},"reviewerMemo":"심사자 메모","approvalMemo":"최상위 그룹장 메모","rejectStatusMemo":"반려사유"}

HTTP response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 87

{"result":null,"code":"0","message":"요청이 성공적으로 완료되었습니다."}

Path parameters

Table 1. /core/admin/api/v1/agents/{agentId}/users/{userId}/advertisers/{advertiserId}/operator-decision
Parameter Description

agentId

대행사 UID

userId

회원 UID

advertiserId

광고주 UID

Request body

{"decisionType":"APPROVE","chargeRule":[{"standardRoasPercent":1,"rangeType":"UP","boundType":"FIXED_AMOUNT","changePercentOrValue":1}],"prePaymentSchedule":{"initialAmount":1,"maxChargeLimit":1,"minChargeLimit":1},"reviewerMemo":"심사자 메모","approvalMemo":"최상위 그룹장 메모","rejectStatusMemo":"반려사유"}

Request fields

Path Type Description Required

decisionType

String

APPROVE REJECT

required

chargeRule[].standardRoasPercent

Number

기준 ROAS

required

chargeRule[].rangeType

String

이상 , 미만

required

chargeRule[].boundType

String

정률 , 정액

required

chargeRule[].changePercentOrValue

Number

변화 퍼센트

required

prePaymentSchedule.initialAmount

Number

최초 충전 금액

required

prePaymentSchedule.maxChargeLimit

Number

일 최대 한도

required

prePaymentSchedule.minChargeLimit

Number

일 최저 한도 , 10000원 고정

required

reviewerMemo

String

심사자 메모

optional

approvalMemo

String

최상위 그룹장 메모

optional

rejectStatusMemo

String

반려자 메모

optional

Response body

{"result":null,"code":"0","message":"요청이 성공적으로 완료되었습니다."}

Response fields

Path Type Description Required

code

String

응답 코드

required

message

String

오류 메시지

required

result

Null

결과

required

25. 운영 계좌 잔액 조회(AAG027)

HTTP request

GET /core/admin/api/v1/agents/1/users/1/calculate-account-balance HTTP/1.1
Content-Type: application/json
Host: localhost:8080

HTTP response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 124

{"result":{"balance":10000,"dailyUsingAmount":3000},"code":"0","message":"요청이 성공적으로 완료되었습니다."}

Path parameters

Table 1. /core/admin/api/v1/agents/{agentId}/users/{userId}/calculate-account-balance
Parameter Description

agentId

대행사 UID

userId

회원 UID

Response body

{"result":{"balance":10000,"dailyUsingAmount":3000},"code":"0","message":"요청이 성공적으로 완료되었습니다."}

Response fields

Path Type Description Required

code

String

응답 코드

required

message

String

오류 메시지

required

result.balance

Number

운영 계좌 잔액

required

result.dailyUsingAmount

Number

현재 일 소진 금액

required

공통 대행사 API 목록

1. 대행사 부서 전체 조회(ADG001)

HTTP request

GET /core/api/v1/agents/1/departments?agentId=1 HTTP/1.1
Content-Type: application/json
Host: localhost:8080

HTTP response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1109

{"result":{"departments":[{"departmentId":1,"parentId":null,"name":"루트부서","displayOrder":1,"users":[{"userId":1,"agentId":1,"id":"사용자1@test.com","status":"NORMAL","type":"AGENCY_GROUP_MASTER","name":"사용자1","phoneNumber":"01011111111"}],"children":[{"departmentId":2,"parentId":1,"name":"자식부서1","displayOrder":2,"users":[{"userId":2,"agentId":1,"id":"사용자2@test.com","status":"NORMAL","type":"AGENCY_GROUP_MASTER","name":"사용자2","phoneNumber":"01022222222"}],"children":[],"totalUserCount":1},{"departmentId":3,"parentId":1,"name":"자식부서2","displayOrder":3,"users":[{"userId":3,"agentId":1,"id":"사용자3@test.com","status":"NORMAL","type":"AGENCY_GROUP_MASTER","name":"사용자3","phoneNumber":"01033333333"}],"children":[],"totalUserCount":1}],"totalUserCount":3}],"agent":{"agentId":1,"name":"대행사 이름","uniqueCode":"고유 코드","representativeName":"대표자 이름","businessRegistrationNumber":"사업자 등록 번호","status":"NORMAL","domainName":"도메인 이름"}},"code":"0","message":"요청이 성공적으로 완료되었습니다."}

Path parameters

Table 1. /core/api/v1/agents/{agentId}/departments
Parameter Description

agentId

대행사 UID

Response body

{"result":{"departments":[{"departmentId":1,"parentId":null,"name":"루트부서","displayOrder":1,"users":[{"userId":1,"agentId":1,"id":"사용자1@test.com","status":"NORMAL","type":"AGENCY_GROUP_MASTER","name":"사용자1","phoneNumber":"01011111111"}],"children":[{"departmentId":2,"parentId":1,"name":"자식부서1","displayOrder":2,"users":[{"userId":2,"agentId":1,"id":"사용자2@test.com","status":"NORMAL","type":"AGENCY_GROUP_MASTER","name":"사용자2","phoneNumber":"01022222222"}],"children":[],"totalUserCount":1},{"departmentId":3,"parentId":1,"name":"자식부서2","displayOrder":3,"users":[{"userId":3,"agentId":1,"id":"사용자3@test.com","status":"NORMAL","type":"AGENCY_GROUP_MASTER","name":"사용자3","phoneNumber":"01033333333"}],"children":[],"totalUserCount":1}],"totalUserCount":3}],"agent":{"agentId":1,"name":"대행사 이름","uniqueCode":"고유 코드","representativeName":"대표자 이름","businessRegistrationNumber":"사업자 등록 번호","status":"NORMAL","domainName":"도메인 이름"}},"code":"0","message":"요청이 성공적으로 완료되었습니다."}

Response fields

Path Type Description Required

code

String

응답 코드

required

message

String

오류 메시지

required

result.agent.agentId

Number

대행사 UID

required

result.agent.name

String

대행사 이름

required

result.agent.uniqueCode

String

고유 코드

required

result.agent.representativeName

String

대행사 대표자명

required

result.agent.businessRegistrationNumber

String

사업자 등록 번호

required

result.agent.status

String

NORMAL : 활성화 STOP : 비활성화

required

result.agent.domainName

String

도메인 이름

required

result.departments[].departmentId

Number

부서 UID

optional

result.departments[].parentId

Null

상위 부서 UID

optional

result.departments[].name

String

부서 이름

optional

result.departments[].displayOrder

Number

부서 보여져야할 순서

optional

result.departments[].totalUserCount

Number

부서 내 총 사용자 수 (하위부서 포함)

optional

result.departments[].users

Array

부서에 속한 회원 목록

optional

result.departments[].users[].userId

Number

사용자 UID

optional

result.departments[].users[].agentId

Number

소속 대행사 UID

optional

result.departments[].users[].id

String

사용자 로그인 ID(이메일)

optional

result.departments[].users[].status

String

사용자 상태

optional

result.departments[].users[].type

String

사용자 유형

optional

result.departments[].users[].name

String

사용자 이름

optional

result.departments[].users[].phoneNumber

String

사용자 전화번호

optional

result.departments[].children

Array

하위 부서 목록

optional

result.departments[].children[].departmentId

Number

하위 부서 UID

optional

result.departments[].children[].parentId

Number

상위 부서 UID (부모 부서)

optional

result.departments[].children[].name

String

하위 부서 이름

optional

result.departments[].children[].displayOrder

Number

하위 부서 보여져야할 순서

optional

result.departments[].children[].totalUserCount

Number

하위 부서 내 총 사용자 수

optional

result.departments[].children[].users

Array

하위 부서에 속한 회원 목록

optional

result.departments[].children[].users[].userId

Number

사용자 UID

optional

result.departments[].children[].users[].agentId

Number

소속 대행사 UID

optional

result.departments[].children[].users[].id

String

사용자 로그인 ID(이메일)

optional

result.departments[].children[].users[].status

String

사용자 상태

optional

result.departments[].children[].users[].type

String

사용자 유형

optional

result.departments[].children[].users[].name

String

사용자 이름

optional

result.departments[].children[].users[].phoneNumber

String

사용자 전화번호

optional

result.departments[].children[].children

Array

4계층 하위 부서 목록

optional

2. 대행사 부서 등록 및 수정(ADG002)

HTTP request

PUT /core/api/v1/agents/1/departments HTTP/1.1
Content-Type: application/json
Content-Length: 177
Host: localhost:8080

{"departments":[{"departmentName":"부서 이름","displayOrder":1,"userIds":[1],"children":[{"departmentName":"부서이름1","displayOrder":1,"userIds":null,"children":[]}]}]}

HTTP response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 87

{"result":null,"code":"0","message":"요청이 성공적으로 완료되었습니다."}

Path parameters

Table 1. /core/api/v1/agents/{agentId}/departments
Parameter Description

agentId

대행사 UID

Request body

{"departments":[{"departmentName":"부서 이름","displayOrder":1,"userIds":[1],"children":[{"departmentName":"부서이름1","displayOrder":1,"userIds":null,"children":[]}]}]}

Request fields

Path Type Description Required

departments[].departmentName

String

대행사 부서 이름

required

departments[].displayOrder

Number

부서 보여지는 순서

required

departments[].userIds

Array

부서 속 회원 UID

required

departments[].children[].departmentName

String

하위 부서 속 부서 이름

optional

departments[].children[].displayOrder

Number

하위 부서 보여지는 순서

optional

departments[].children[].userIds

Null

하위 부서 속 회원 UID

optional

departments[].children[].children[]

Array

하위 부서 아래 하위 부서 정보

optional

Response body

{"result":null,"code":"0","message":"요청이 성공적으로 완료되었습니다."}

Response fields

Path Type Description Required

code

String

응답 코드

required

message

String

오류 메시지

required

result

Null

결과

required

3. 대행사 회원 메일 인증 코드 확인 (ADG003)

HTTP request

GET /core/api/v1/agents/users/mail-verifications?agentCode=AAAA&userCode=BBBB HTTP/1.1
Content-Type: application/json
Host: localhost:8080

HTTP response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 483

{"result":{"adminAgentResponseDto":{"agentId":1,"name":"대행사 이름","uniqueCode":"고유 코드","representativeName":"대표자 이름","businessRegistrationNumber":"사업자 등록 번호","status":"NORMAL","domainName":"도메인 이름"},"userResponseDto":{"userId":1,"agentId":1,"id":"아이디","status":"NORMAL","type":"ADVERTISER","name":"이름","phoneNumber":"전화번호"},"isVerified":true},"code":"0","message":"요청이 성공적으로 완료되었습니다."}

Query parameters

Parameter Description Required

agentCode

대행사 고유코드

required

userCode

회원 인증코드

required

Response body

{"result":{"adminAgentResponseDto":{"agentId":1,"name":"대행사 이름","uniqueCode":"고유 코드","representativeName":"대표자 이름","businessRegistrationNumber":"사업자 등록 번호","status":"NORMAL","domainName":"도메인 이름"},"userResponseDto":{"userId":1,"agentId":1,"id":"아이디","status":"NORMAL","type":"ADVERTISER","name":"이름","phoneNumber":"전화번호"},"isVerified":true},"code":"0","message":"요청이 성공적으로 완료되었습니다."}

Response fields

Path Type Description Required

code

String

응답 코드

required

message

String

오류 메시지

required

result.userResponseDto.userId

Number

대행사 회원 UID

required

result.userResponseDto.agentId

Number

대행사 UID

required

result.userResponseDto.id

String

대행사 ID

required

result.userResponseDto.status

String

NORMAL : 활성화 STOP : 비활성화 TEMP : 임시

required

result.userResponseDto.type

String

ASSOCIATE_ADVERTISER : 준광고주 ADVERTISER : 광고주 AGENCY_GROUP_MEMBER : 대행사 그룹원 AGENCY_GROUP_MANAGER : 대행사 그룹장 AGENCY_GROUP_MASTER : 대행사 최상위 그룹장 OPERATIONS_MANAGER : 운영관리자 SYSTEM_ADMINISTRATOR : 시스템 관리자

required

result.userResponseDto.name

String

회원 이름

required

result.userResponseDto.phoneNumber

String

회원 전화번호

required

result.adminAgentResponseDto.agentId

Number

대행사 UID

required

result.adminAgentResponseDto.name

String

대행사 이름

required

result.adminAgentResponseDto.uniqueCode

String

대행사 고유코드

required

result.adminAgentResponseDto.representativeName

String

대행사 대표자 이름

required

result.adminAgentResponseDto.businessRegistrationNumber

String

대행사 사업자 등록 번호

required

result.adminAgentResponseDto.status

String

NORMAL : 활성화 STOP : 비활성화

required

result.adminAgentResponseDto.domainName

String

대행사 도메인 이름

required

result.isVerified

Boolean

true isVerified: 인증 완료 , false : 인증 미완료

required

4. 대행사 비밀번호 설정 또는 비밀번호 재설정 (ADG004)

HTTP request

POST /core/api/v1/agents/1/users/1/password?agentId=1&userId=1 HTTP/1.1
Content-Type: application/json
Content-Length: 88
Host: localhost:8080

{"password":"회원 패스워드","phoneNumber":"회원 전화번호","type":"REGISTER"}

HTTP response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 87

{"result":null,"code":"0","message":"요청이 성공적으로 완료되었습니다."}

Path parameters

Table 1. /core/api/v1/agents/{agentId}/users/{userId}/password
Parameter Description

agentId

대행사 UID

userId

회원 UID

Request body

{"password":"회원 패스워드","phoneNumber":"회원 전화번호","type":"REGISTER"}

Request fields

Path Type Description Required

password

String

등록할 패스워드

required

phoneNumber

String

등록할 전화번호

optional

type

String

REGISTER : 등록 RESET : 재설정

required

Response body

{"result":null,"code":"0","message":"요청이 성공적으로 완료되었습니다."}

Response fields

Path Type Description Required

code

String

응답 코드

required

message

String

오류 메시지

required

result

Null

결과 정보

required

5. 대행사 도메인 이름 조회 (ADG005)

HTTP request

GET /core/api/v1/agents?agentCode=AAAA HTTP/1.1
Content-Type: application/json
Host: localhost:8080

HTTP response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 296

{"result":{"agentId":1,"name":"대행사 이름","uniqueCode":"고유 코드","representativeName":"대표자 이름","businessRegistrationNumber":"사업자 등록 번호","status":"NORMAL","domainName":"도메인 이름"},"code":"0","message":"요청이 성공적으로 완료되었습니다."}

Query parameters

Parameter Description Required

agentCode

대행사 고유코드

required

Response body

{"result":{"agentId":1,"name":"대행사 이름","uniqueCode":"고유 코드","representativeName":"대표자 이름","businessRegistrationNumber":"사업자 등록 번호","status":"NORMAL","domainName":"도메인 이름"},"code":"0","message":"요청이 성공적으로 완료되었습니다."}

Response fields

Path Type Description Required

code

String

응답 코드

required

message

String

오류 메시지

required

result.agentId

Number

대행사 회원 UID

required

result.name

String

대행사 이름

required

result.uniqueCode

String

대행사 고유코드

required

result.representativeName

String

대행사 대표자명

required

result.businessRegistrationNumber

String

대행사 사업자 등록 번호

required

result.status

String

NORMAL : 활성화 STOP : 비활성화

required

result.domainName

String

대행사 도메인 이름

required

대행사 기준 API 목록

1. 대행사 본인 및 하위 회원 정보 조회(SAG001)

HTTP request

GET /core/service/api/v1/agents/1/users/1 HTTP/1.1
Content-Type: application/json
Host: localhost:8080

HTTP response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 551

{"result":{"agent":{"agentId":1,"name":"대행사 이름","uniqueCode":"고유 코드","representativeName":"대표자 이름","businessRegistrationNumber":"사업자 등록 번호","status":"NORMAL","domainName":"도메인 이름"},"user":{"user":{"userId":1,"agentId":1,"loginId":"아이디","status":"NORMAL","isDelete":false,"type":"ADVERTISER","name":"이름","phoneNumber":"전화번호"},"department":{"departmentId":1,"agentId":1,"parentId":null,"name":"부서이름"}}},"code":"0","message":"요청이 성공적으로 완료되었습니다."}

Path parameters

Table 1. /core/service/api/v1/agents/{agentId}/users/{userId}
Parameter Description

agentId

대행사 UID

userId

회원 UID

Response body

{"result":{"agent":{"agentId":1,"name":"대행사 이름","uniqueCode":"고유 코드","representativeName":"대표자 이름","businessRegistrationNumber":"사업자 등록 번호","status":"NORMAL","domainName":"도메인 이름"},"user":{"user":{"userId":1,"agentId":1,"loginId":"아이디","status":"NORMAL","isDelete":false,"type":"ADVERTISER","name":"이름","phoneNumber":"전화번호"},"department":{"departmentId":1,"agentId":1,"parentId":null,"name":"부서이름"}}},"code":"0","message":"요청이 성공적으로 완료되었습니다."}

Response fields

Path Type Description Required

code

String

응답 코드

required

message

String

오류 메시지

required

result.agent.agentId

Number

에이전트 UID

required

result.agent.name

String

대행사 이름

required

result.agent.uniqueCode

String

고유 코드

required

result.agent.representativeName

String

대행사 대표자명

required

result.agent.businessRegistrationNumber

String

사업자 등록 번호

required

result.agent.status

String

NORMAL : 활성화 STOP : 비활성화

required

result.agent.domainName

String

도메인 이름

required

result.user.user.userId

Number

회원 UID

required

result.user.user.agentId

Number

대행사 UID

required

result.user.user.loginId

String

회원 로그인 ID

required

result.user.user.isDelete

Boolean

회원 삭제 여부

required

result.user.user.status

String

NORMAL : 활성화 STOP : 비활성화 TEMP : 임시

required

result.user.user.type

String

ASSOCIATE_ADVERTISER : 준광고주 ADVERTISER : 광고주 AGENCY_GROUP_MEMBER : 대행사 그룹원 AGENCY_GROUP_MANAGER : 대행사 그룹장 AGENCY_GROUP_MASTER : 대행사 최상위 그룹장 OPERATIONS_MANAGER : 운영관리자 SYSTEM_ADMINISTRATOR : 시스템 관리자

required

result.user.user.name

String

회원 이름

required

result.user.user.phoneNumber

String

회원 전화번호

optional

result.user.department.departmentId

Number

부서 UID

required

result.user.department.agentId

Number

대행사 UID

required

result.user.department.parentId

Null

부서 상위 UID

optional

result.user.department.name

String

부서 이름

required

2. 하위 부서 회원 정보 조회(SAG002)

HTTP request

GET /core/service/api/v1/agents/1/users/1/subordinate-departments-users?page=1&size=10&keyword=%EA%B2%80%EC%83%89%ED%95%A0+%ED%82%A4%EC%9B%8C%EB%93%9C&orderType=REGISTER_DT_DESC HTTP/1.1
Content-Type: application/json
Host: localhost:8080

HTTP response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 322

{"result":{"content":[{"userId":1,"userType":"AGENCY_GROUP_MASTER","userName":"회원 이름","status":"NORMAL","registerDt":"2025-06-27T12:13:52.682706529","emailAddress":"회원 이메일(로그인 아이디)"}],"page":2,"size":10,"totalCount":11},"code":"0","message":"요청이 성공적으로 완료되었습니다."}

Path parameters

Table 1. /core/service/api/v1/agents/{agentId}/users/{userId}/subordinate-departments-users
Parameter Description

agentId

대행사 UID

userId

회원 UID

Query parameters

Parameter Description Required

page

페이지 번호 (1부터 시작)

required

size

페이지 크기

required

sort

해당 부분 사용하지 않음, OrderType을 통해 정렬 기준 제어

optional

keyword

대행사, 회원명, 이메일 검색 키워드

optional

orderType

ASSOCIATE_ADVERTISER : 준광고주 ADVERTISER : 광고주 AGENCY_GROUP_MEMBER : 대행사 그룹원 AGENCY_GROUP_MANAGER : 대행사 그룹장 AGENCY_GROUP_MASTER : 대행사 최상위 그룹장 OPERATIONS_MANAGER : 운영관리자 SYSTEM_ADMINISTRATOR : 시스템 관리자

optional

Response body

{"result":{"content":[{"userId":1,"userType":"AGENCY_GROUP_MASTER","userName":"회원 이름","status":"NORMAL","registerDt":"2025-06-27T12:13:52.682706529","emailAddress":"회원 이메일(로그인 아이디)"}],"page":2,"size":10,"totalCount":11},"code":"0","message":"요청이 성공적으로 완료되었습니다."}

Response fields

Path Type Description Required

code

String

응답 코드

required

message

String

오류 메시지

required

result.content[].userId

Number

회원 UID

required

result.content[].userType

String

ASSOCIATE_ADVERTISER : 준광고주 ADVERTISER : 광고주 AGENCY_GROUP_MEMBER : 대행사 그룹원 AGENCY_GROUP_MANAGER : 대행사 그룹장 AGENCY_GROUP_MASTER : 대행사 최상위 그룹장 OPERATIONS_MANAGER : 운영관리자 SYSTEM_ADMINISTRATOR : 시스템 관리자

required

result.content[].userName

String

회원 이름

required

result.content[].status

String

NORMAL : 활성화 STOP : 비활성화 TEMP : 임시

required

result.content[].emailAddress

String

회원 로그인 아이디

required

result.content[].registerDt

String

등록 시간

required

result.page

Number

페이지 번호

required

result.size

Number

사이즈

required

result.totalCount

Number

전체 갯수

required

3. 회원 정보 삭제(SAG003)

HTTP request

DELETE /core/service/api/v1/agents/1/users/1 HTTP/1.1
Content-Type: application/json
Host: localhost:8080

HTTP response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 87

{"result":null,"code":"0","message":"요청이 성공적으로 완료되었습니다."}

Path parameters

Table 1. /core/service/api/v1/agents/{agentId}/users/{userId}
Parameter Description

agentId

대행사 UID

userId

회원 UID

Response body

{"result":null,"code":"0","message":"요청이 성공적으로 완료되었습니다."}

Response fields

Path Type Description Required

code

String

응답 코드

required

message

String

오류 메시지

required

result

Null

결과 정보

required

4. 회원 정보 상태 변경(SAG004)

HTTP request

PATCH /core/service/api/v1/agents/1/users/1/status?status=STOP HTTP/1.1
Content-Type: application/json
Host: localhost:8080

HTTP response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 87

{"result":null,"code":"0","message":"요청이 성공적으로 완료되었습니다."}

Path parameters

Table 1. /core/service/api/v1/agents/{agentId}/users/{userId}/status
Parameter Description

agentId

대행사 UID

userId

회원 UID

Query parameters

Parameter Description Required

status

NORMAL : 활성화 STOP : 비활성화 TEMP : 임시

required

Response body

{"result":null,"code":"0","message":"요청이 성공적으로 완료되었습니다."}

Response fields

Path Type Description Required

code

String

응답 코드

required

message

String

오류 메시지

required

result

Null

결과 정보

required

5. 하위 부서 조회(SAG005)

HTTP request

GET /core/service/api/v1/agents/1/users/1/subordinate-departments HTTP/1.1
Content-Type: application/json
Host: localhost:8080

HTTP response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 283

{"result":{"departmentId":3,"agentId":2,"parentId":2,"name":"두번째 부서","displayOrder":1,"children":[{"departmentId":3,"agentId":2,"parentId":2,"name":"두번째 부서","displayOrder":1,"children":[]}]},"code":"0","message":"요청이 성공적으로 완료되었습니다."}

Path parameters

Table 1. /core/service/api/v1/agents/{agentId}/users/{userId}/subordinate-departments
Parameter Description

agentId

대행사 UID

userId

회원 UID

Response body

{"result":{"departmentId":3,"agentId":2,"parentId":2,"name":"두번째 부서","displayOrder":1,"children":[{"departmentId":3,"agentId":2,"parentId":2,"name":"두번째 부서","displayOrder":1,"children":[]}]},"code":"0","message":"요청이 성공적으로 완료되었습니다."}

Response fields

Path Type Description Required

code

String

응답 코드

required

message

String

오류 메시지

required

result.children[].children[]

Array

손자 부서 정보

optional

result.children[]

Array

아들 부서 정보

optional

result.children[].departmentId

Number

부서 UID

required

result.children[].agentId

Number

대행사 UID

required

result.children[].parentId

Number

부모 부서 UID

optional

result.children[].name

String

부서 이름

required

result.children[].displayOrder

Number

부서 보여지는 순서

required

result.departmentId

Number

부서 UID

required

result.agentId

Number

대행사 UID

required

result.parentId

Number

부모 부서 UID

optional

result.name

String

부서 이름

required

result.displayOrder

Number

부서 보여지는 순서

required

5. 회원 가입 메일 발송(SAG006)

HTTP request

POST /core/service/api/v1/agents/1/users/email HTTP/1.1
Content-Type: application/json
Content-Length: 108
Host: localhost:8080

{"departmentId":1,"type":"AGENCY_GROUP_MANAGER","emailAddress":"회원 로그인 ID","name":"회원 이름"}

HTTP response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 87

{"result":null,"code":"0","message":"요청이 성공적으로 완료되었습니다."}

Path parameters

Table 1. /core/service/api/v1/agents/{agentId}/users/email
Parameter Description

agentId

대행사 UID

Request body

{"departmentId":1,"type":"AGENCY_GROUP_MANAGER","emailAddress":"회원 로그인 ID","name":"회원 이름"}

Request fields

Path Type Description Required

departmentId

Number

부서 UID

required

type

String

ASSOCIATE_ADVERTISER : 준광고주 ADVERTISER : 광고주 AGENCY_GROUP_MEMBER : 대행사 그룹원 AGENCY_GROUP_MANAGER : 대행사 그룹장 AGENCY_GROUP_MASTER : 대행사 최상위 그룹장 OPERATIONS_MANAGER : 운영관리자 SYSTEM_ADMINISTRATOR : 시스템 관리자

required

name

String

회원 이름

required

emailAddress

String

이메일

required

Response body

{"result":null,"code":"0","message":"요청이 성공적으로 완료되었습니다."}

Response fields

Path Type Description Required

code

String

응답 코드

required

message

String

오류 메시지

required

result

Null

결과

required

6. 회원 직접 등록(SAG007)

HTTP request

POST /core/service/api/v1/agents/1/users HTTP/1.1
Content-Type: application/json
Content-Length: 148
Host: localhost:8080

{"departmentId":1,"type":"AGENCY_GROUP_MANAGER","name":"회원 이름","emailAddress":"test@test.com","password":"1234","phoneNumber":"01011111111"}

HTTP response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 87

{"result":null,"code":"0","message":"요청이 성공적으로 완료되었습니다."}

Path parameters

Table 1. /core/service/api/v1/agents/{agentId}/users
Parameter Description

agentId

대행사 UID

Request body

{"departmentId":1,"type":"AGENCY_GROUP_MANAGER","name":"회원 이름","emailAddress":"test@test.com","password":"1234","phoneNumber":"01011111111"}

Request fields

Path Type Description Required

departmentId

Number

부서 UID

required

type

String

ASSOCIATE_ADVERTISER : 준광고주 ADVERTISER : 광고주 AGENCY_GROUP_MEMBER : 대행사 그룹원 AGENCY_GROUP_MANAGER : 대행사 그룹장 AGENCY_GROUP_MASTER : 대행사 최상위 그룹장 OPERATIONS_MANAGER : 운영관리자 SYSTEM_ADMINISTRATOR : 시스템 관리자

required

name

String

회원 이름

required

emailAddress

String

이메일

required

password

String

비밀번호

required

phoneNumber

String

전화번호

optional

Response body

{"result":null,"code":"0","message":"요청이 성공적으로 완료되었습니다."}

Response fields

Path Type Description Required

code

String

응답 코드

required

message

String

오류 메시지

required

result

Null

결과

required

7. 마케터 API 라이선스 등록 및 수정(SAG008)

HTTP request

POST /core/service/api/v1/agents/1/users/1/api-license HTTP/1.1
Content-Type: application/json
Content-Length: 59
Host: localhost:8080

{"customerId":1,"apiKey":"API Key","secretKey":"비밀키"}

HTTP response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 87

{"result":null,"code":"0","message":"요청이 성공적으로 완료되었습니다."}

Path parameters

Table 1. /core/service/api/v1/agents/{agentId}/users/{userId}/api-license
Parameter Description

agentId

대행사 UID

userId

사용자 UID

Request body

{"customerId":1,"apiKey":"API Key","secretKey":"비밀키"}

Request fields

Path Type Description Required

customerId

Number

마케터 네이버 API ID

required

apiKey

String

마케터 네이버 API Key

required

secretKey

String

마케터 네이버 비밀키

required

Response body

{"result":null,"code":"0","message":"요청이 성공적으로 완료되었습니다."}

Response fields

Path Type Description Required

code

String

응답 코드

required

message

String

오류 메시지

required

result

Null

결과

required

8. 마케터 API 라이선스 조회(SAG009)

HTTP request

GET /core/service/api/v1/agents/1/users/1/api-license HTTP/1.1
Content-Type: application/json
Host: localhost:8080

HTTP response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 160

{"result":{"userId":1,"customerId":1,"accessLicense":"API Key","secretKey":"비밀키"},"code":"0","message":"요청이 성공적으로 완료되었습니다."}

Path parameters

Table 1. /core/service/api/v1/agents/{agentId}/users/{userId}/api-license
Parameter Description

agentId

대행사 UID

userId

회원 UID

Response body

{"result":{"userId":1,"customerId":1,"accessLicense":"API Key","secretKey":"비밀키"},"code":"0","message":"요청이 성공적으로 완료되었습니다."}

Response fields

Path Type Description Required

code

String

응답 코드

required

message

String

오류 메시지

required

result.userId

Number

회원 UID

required

result.customerId

Number

Customer Id

required

result.accessLicense

String

api key

required

result.secretKey

String

비밀키

required

10. 마케터 API 라이선스 삭제(SAG011)

HTTP request

DELETE /core/service/api/v1/agents/1/users/1/api-license HTTP/1.1
Content-Type: application/json
Host: localhost:8080

HTTP response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 87

{"result":null,"code":"0","message":"요청이 성공적으로 완료되었습니다."}

Path parameters

Table 1. /core/service/api/v1/agents/{agentId}/users/{userId}/api-license
Parameter Description

agentId

대행사 UID

userId

사용자 UID

Response body

{"result":null,"code":"0","message":"요청이 성공적으로 완료되었습니다."}

Response fields

Path Type Description Required

code

String

응답 코드

required

message

String

오류 메시지

required

result

Null

결과

required

11. 광고주 리스트 페이지네이션 조회(SAG012)

HTTP request

GET /core/service/api/v1/agents/1/users/1/advertiser-list?page=1&size=10&keyword=%EA%B2%80%EC%83%89%ED%95%A0+%ED%82%A4%EC%9B%8C%EB%93%9C&orderType=ADVERTISER_REGISTER_ASC HTTP/1.1
Content-Type: application/json
Host: localhost:8080

HTTP response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 443

{"result":{"content":[{"advertiserId":1,"customerId":1,"id":"광고주 로그인 ID","nickname":"광고주 닉네임","name":"광고주명","isAdvertiserRegister":true,"syncType":"SYNC","jobStatus":"DONE","isBizMoneySync":true,"description":"실패 이유","isLossPrivilege":true,"registerOrUpdateDt":"2025-06-27T12:13:52.776921021"}],"page":2,"size":10,"totalCount":11},"code":"0","message":"요청이 성공적으로 완료되었습니다."}

Path parameters

Table 1. /core/service/api/v1/agents/{agentId}/users/{userId}/advertiser-list
Parameter Description

agentId

대행사 UID

userId

회원 UID

Query parameters

Parameter Description Required

page

페이지 번호 (1부터 시작)

required

size

페이지 크기

required

sort

해당 부분 사용하지 않음, OrderType을 통해 정렬 기준 제어

optional

keyword

대행사, 회원명, 이메일 검색 키워드

optional

orderType

ADVERTISER_REGISTER_ASC ADVERTISER_REGISTER_DESC ADVERTISER_SYNC_ASC ADVERTISER_SYNC_DESC ADVERTISER_REGISTER_TIME_ASC ADVERTISER_REGISTER_TIME_DESC

optional

Response body

{"result":{"content":[{"advertiserId":1,"customerId":1,"id":"광고주 로그인 ID","nickname":"광고주 닉네임","name":"광고주명","isAdvertiserRegister":true,"syncType":"SYNC","jobStatus":"DONE","isBizMoneySync":true,"description":"실패 이유","isLossPrivilege":true,"registerOrUpdateDt":"2025-06-27T12:13:52.776921021"}],"page":2,"size":10,"totalCount":11},"code":"0","message":"요청이 성공적으로 완료되었습니다."}

Response fields

Path Type Description Required

code

String

응답 코드

required

message

String

오류 메시지

required

result.content[].advertiserId

Number

광고주 UID

required

result.content[].customerId

Number

customer ID

required

result.content[].id

String

광고주 로그인 ID

required

result.content[].nickname

String

광고주 닉네임

required

result.content[].name

String

광고주명

required

result.content[].isAdvertiserRegister

Boolean

true : 등록 , false : 미등록

required

result.content[].syncType

String

SYNC UNSYNC FAIL

required

result.content[].jobStatus

String

BEFORE_PROGRESS : 작업 실행 전 IN_PROGRESS : 작업 중 DONE : 작업 완료

required

result.content[].isBizMoneySync

Boolean

true : 동기화 완료, false : 비동기화

required

result.content[].description

String

동기화 실패 이유

optional

result.content[].isLossPrivilege

Boolean

권한 해제 여부 true : 해제 , false : 정상

required

result.content[].registerOrUpdateDt

String

등록 또는 수정 중 최신 시간

required

result.page

Number

페이지 번호

required

result.size

Number

사이즈

required

result.totalCount

Number

전체 갯수

required

12. 광고주 데이터 동기화(SAG013)

HTTP request

POST /core/service/api/v1/agents/1/users/1/advertiser/sync HTTP/1.1
Content-Type: application/json
Content-Length: 69
Host: localhost:8080

{"advertiserIds":[1],"startDate":"2025-06-27","endDate":"2025-06-27"}

HTTP response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 87

{"result":null,"code":"0","message":"요청이 성공적으로 완료되었습니다."}

Path parameters

Table 1. /core/service/api/v1/agents/{agentId}/users/{userId}/advertiser/sync
Parameter Description

agentId

대행사 UID

userId

사용자 UID

Request body

{"advertiserIds":[1],"startDate":"2025-06-27","endDate":"2025-06-27"}

Request fields

Path Type Description Required

advertiserIds[]

Array

등록하고자 하는 광고주 UID

required

startDate

String

수동 데이터 수집 시작 날짜

optional

endDate

String

수동 데이터 수집 종료 날짜

optional

Response body

{"result":null,"code":"0","message":"요청이 성공적으로 완료되었습니다."}

Response fields

Path Type Description Required

code

String

응답 코드

required

message

String

오류 메시지

required

result

Null

결과

required

13. 광고주 데이터 동기화 해제(SAG014)

HTTP request

DELETE /core/service/api/v1/agents/1/users/1/advertiser/sync HTTP/1.1
Content-Type: application/json
Content-Length: 21
Host: localhost:8080

{"advertiserIds":[1]}

HTTP response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 87

{"result":null,"code":"0","message":"요청이 성공적으로 완료되었습니다."}

Path parameters

Table 1. /core/service/api/v1/agents/{agentId}/users/{userId}/advertiser/sync
Parameter Description

agentId

대행사 UID

userId

사용자 UID

Request body

{"advertiserIds":[1]}

Request fields

Path Type Description Required

advertiserIds[]

Array

등록하고자 하는 광고주 UID

required

Response body

{"result":null,"code":"0","message":"요청이 성공적으로 완료되었습니다."}

Response fields

Path Type Description Required

code

String

응답 코드

required

message

String

오류 메시지

required

result

Null

결과

required

14. 광고주 데이터 동기화 작업 상태 변경(SAG015)

HTTP request

POST /core/service/api/v1/agents/1/users/1/advertiser/sync/job-status HTTP/1.1
Content-Type: application/json
Content-Length: 45
Host: localhost:8080

{"advertiserId":1,"status":"BEFORE_PROGRESS"}

HTTP response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 176

{"result":null,"code":"20","message":"요청을 처리하는데에 있어 문제가 발생하였습니다. 계속 문제가 발생할 시 고객센터로 연락 바랍니다."}

Path parameters

Table 1. /core/service/api/v1/agents/{agentId}/users/{userId}/advertiser/sync/job-status
Parameter Description

agentId

대행사 UID

userId

사용자 UID

Request body

{"advertiserId":1,"status":"BEFORE_PROGRESS"}

Request fields

Path Type Description Required

advertiserId

Number

등록하고자 하는 광고주 UID

required

status

String

BEFORE_PROGRESS : 작업 실행 전 IN_PROGRESS : 작업 중 DONE : 작업 완료

required

Response body

{"result":null,"code":"20","message":"요청을 처리하는데에 있어 문제가 발생하였습니다. 계속 문제가 발생할 시 고객센터로 연락 바랍니다."}

Response fields

Path Type Description Required

code

String

응답 코드

required

message

String

오류 메시지

required

result

Null

결과

required

15. 광고주 데이터 동기화 작업별 리스트 조회(SAG016)

HTTP request

GET /core/service/api/v1/agents/1/users/1/advertisers-job-type-list?type=IN_PROGRESS HTTP/1.1
Content-Type: application/json
Host: localhost:8080

HTTP response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 509

{"result":[{"advertiserId":1,"userId":1,"customerId":1,"id":"아이디","nickName":"닉네임","representativeName":"대표자명","businessRegistrationNumber":"광고주 사업자 등록 번호","phoneNumber":"전화번호","emailAddress":"이메일","status":"WAIT_REVIEW","name":"광고주명","roleId":1,"sync":{"advertiserSyncId":1,"advertiserId":1,"syncStatus":"SYNC","jobStatus":"DONE","isBizMoneySync":true,"description":null}}],"code":"0","message":"요청이 성공적으로 완료되었습니다."}

Path parameters

Table 1. /core/service/api/v1/agents/{agentId}/users/{userId}/advertisers-job-type-list
Parameter Description

agentId

대행사 UID

userId

회원 UID

Query parameters

Parameter Description Required

type

BEFORE_PROGRESS : 작업 실행 전 IN_PROGRESS : 작업 중 DONE : 작업 완료

required

Response body

{"result":[{"advertiserId":1,"userId":1,"customerId":1,"id":"아이디","nickName":"닉네임","representativeName":"대표자명","businessRegistrationNumber":"광고주 사업자 등록 번호","phoneNumber":"전화번호","emailAddress":"이메일","status":"WAIT_REVIEW","name":"광고주명","roleId":1,"sync":{"advertiserSyncId":1,"advertiserId":1,"syncStatus":"SYNC","jobStatus":"DONE","isBizMoneySync":true,"description":null}}],"code":"0","message":"요청이 성공적으로 완료되었습니다."}

Response fields

Path Type Description Required

code

String

응답 코드

required

message

String

오류 메시지

required

result[].advertiserId

Number

광고주 UID

required

result[].userId

Number

회원 UID

required

result[].customerId

Number

customer UID

required

result[].id

String

광고주 아이디

required

result[].nickName

String

광고주 닉네임

required

result[].representativeName

String

광고 대표자명

required

result[].businessRegistrationNumber

String

광고주 사업자 등록 번호

required

result[].phoneNumber

String

광고주 전화번호

optional

result[].emailAddress

String

등록 또는 수정 중 최신 시간

optional

result[].status

String

UNSYNC_ADVERTISER : 광고주 비동기화 APPLICABLE : 신청 가능 WAIT_REVIEW : 심사 대기 REJECT : 심사 반려 OPERATION_REVIEW : 운영 검토 대기 OPERATION_REJECT : 운영 검토 거절 OPERATION_REVIEW_SUCCESS : 운영 검토 완료 ADVERTISER_AGREE_WAIT : 광고주 동의 대기 ADVERTISER_AGREE_TIME_EXPIRE : 광고주 동의 기한 만료 CANCEL : 신청 취소 REGISTER_WITHDRAW_ACCOUNT_FAIL : 출금 계좌 등록 실패 OPERATION : 운영중 PAUSE : 일시중지 TERMINATE_WAIT : 해지 대기 TERMINATE : 해지

optional

result[].name

String

광고주 이름

optional

result[].roleId

Number

광고주 역할 UID

optional

result[].sync.advertiserSyncId

Number

동기화 UID

required

result[].sync.advertiserId

Number

광고주 UID

required

result[].sync.syncStatus

String

SYNC UNSYNC FAIL

required

result[].sync.jobStatus

String

BEFORE_PROGRESS : 작업 실행 전 IN_PROGRESS : 작업 중 DONE : 작업 완료

required

result[].sync.isBizMoneySync

Boolean

비즈머니 동기화 여부 true : 동기환, false : 비동기화

required

result[].sync.description

Null

실패 사유

optional

16. 광고주 비즈머니 데이터 동기화(SAG017)

HTTP request

POST /core/service/api/v1/agents/1/users/1/advertisers/biz-money HTTP/1.1
Content-Type: application/json
Content-Length: 21
Host: localhost:8080

{"advertiserIds":[1]}

HTTP response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 87

{"result":null,"code":"0","message":"요청이 성공적으로 완료되었습니다."}

Path parameters

Table 1. /core/service/api/v1/agents/{agentId}/users/{userId}/advertisers/biz-money
Parameter Description

agentId

대행사 UID

userId

사용자 UID

Request fields

Path Type Description Required

advertiserIds[]

Array

비즈머니 동기화하고자 하는 광고주 UID

required

Request body

{"advertiserIds":[1]}

Response body

{"result":null,"code":"0","message":"요청이 성공적으로 완료되었습니다."}

Response fields

Path Type Description Required

code

String

응답 코드

required

message

String

오류 메시지

required

result

Null

결과

required

17. 광고주 비즈머니 리스트 페이지네이션 조회(SAG018)

HTTP request

GET /core/service/api/v1/agents/1/users/1/advertisers/biz-money?page=1&size=10&keyword=%EA%B2%80%EC%83%89%ED%95%A0+%ED%82%A4%EC%9B%8C%EB%93%9C&orderType=REGISTER_DESC HTTP/1.1
Content-Type: application/json
Host: localhost:8080

HTTP response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 310

{"result":{"content":[{"customerId":1,"id":"광고주 로그인 ID","nickName":"광고주 닉네임","name":"광고주명","bizMoneyAmount":10000,"registerOrUpdateTime":"2025-06-27T12:13:52.588394605"}],"page":1,"size":10,"totalCount":1},"code":"0","message":"요청이 성공적으로 완료되었습니다."}

Path parameters

Table 1. /core/service/api/v1/agents/{agentId}/users/{userId}/advertisers/biz-money
Parameter Description

agentId

대행사 UID

userId

회원 UID

Query parameters

Parameter Description Required

page

페이지 번호 (1부터 시작)

required

size

페이지 크기

required

sort

해당 부분 사용하지 않음, OrderType을 통해 정렬 기준 제어

optional

keyword

대행사, 회원명, 이메일 검색 키워드

optional

orderType

CUSTOMER_ASC CUSTOMER_DESC ADVERTISER_ID_ASC ADVERTISER_ID_DESC ADVERTISER_NICKNAME_ASC ADVERTISER_NICKNAME_DESC ADVERTISER_NAME_ASC ADVERTISER_NAME_DESC BIZ_MONEY_ASC BIZ_MONEY_DESC REGISTER_ASC REGISTER_DESC

optional

Response body

{"result":{"content":[{"customerId":1,"id":"광고주 로그인 ID","nickName":"광고주 닉네임","name":"광고주명","bizMoneyAmount":10000,"registerOrUpdateTime":"2025-06-27T12:13:52.588394605"}],"page":1,"size":10,"totalCount":1},"code":"0","message":"요청이 성공적으로 완료되었습니다."}

Response fields

Path Type Description Required

code

String

응답 코드

required

message

String

오류 메시지

required

result.content[].customerId

Number

광고주 customer ID

required

result.content[].id

String

광고주 로그인 ID

required

result.content[].nickName

String

광고주 닉네임

required

result.content[].name

String

광고주명

optional

result.content[].bizMoneyAmount

Number

비즈머니 잔액

required

result.content[].registerOrUpdateTime

String

비즈머니 동기화 등록 또는 수정 시간

required

result.page

Number

페이지 번호

required

result.size

Number

사이즈

required

result.totalCount

Number

전체 갯수

required

18. 광고주 상태 리스트 페이지네이션 조회(SAG019)

HTTP request

GET /core/service/api/v1/agents/1/users/1/advertisers/status-list?page=1&size=10&keyword=%EA%B2%80%EC%83%89%ED%95%A0+%ED%82%A4%EC%9B%8C%EB%93%9C&orderType=ADVERTISER_REGISTER_DESC HTTP/1.1
Content-Type: application/json
Host: localhost:8080

HTTP response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 502

{"result":{"content":[{"userId":1,"userName":"회원 이름","advertiserId":1,"advertiserCustomerId":1,"advertiserLoginId":"광고주 로그인 Id","advertiserName":"광고주명","advertiserType":"WAIT_REVIEW","description":"반려 사유","descriptionRegisterDt":"2025-06-27T12:13:53.062853133","registerOrUpdateDt":"2025-06-27T12:13:53.062863222","isMyAdvertiser":true,"advertiserFormId":1}],"page":1,"size":10,"totalCount":1},"code":"0","message":"요청이 성공적으로 완료되었습니다."}

Path parameters

Table 1. /core/service/api/v1/agents/{agentId}/users/{userId}/advertisers/status-list
Parameter Description

agentId

대행사 UID

userId

회원 UID

Query parameters

Parameter Description Required

page

페이지 번호 (1부터 시작)

required

size

페이지 크기

required

sort

해당 부분 사용하지 않음, OrderType을 통해 정렬 기준 제어

optional

keyword

광고주 로그인 ID, 광고주명 , 광고주 CustomerId 검색 키워드

optional

orderType

ADVERTISER_REGISTER_DESC ADVERTISER_REGISTER_ASC ADVERTISER_STATUS_DESC ADVERTISER_STATUS_ASC ADVERTISER_NAME_DESC ADVERTISER_NAME_ASC ADVERTISER_ID_DESC ADVERTISER_ID_ASC ADVERTISER_CUSTOMER_ID_DESC ADVERTISER_CUSTOMER_ID_ASC

optional

Response body

{"result":{"content":[{"userId":1,"userName":"회원 이름","advertiserId":1,"advertiserCustomerId":1,"advertiserLoginId":"광고주 로그인 Id","advertiserName":"광고주명","advertiserType":"WAIT_REVIEW","description":"반려 사유","descriptionRegisterDt":"2025-06-27T12:13:53.062853133","registerOrUpdateDt":"2025-06-27T12:13:53.062863222","isMyAdvertiser":true,"advertiserFormId":1}],"page":1,"size":10,"totalCount":1},"code":"0","message":"요청이 성공적으로 완료되었습니다."}

Response fields

Path Type Description Required

code

String

응답 코드

required

message

String

오류 메시지

required

result.content[].userId

Number

회원 UID

required

result.content[].userName

String

회원명

required

result.content[].advertiserId

Number

광고주 Customer Id

required

result.content[].advertiserCustomerId

Number

광고주 Customer Id

required

result.content[].advertiserLoginId

String

광고주 로그인 Id

required

result.content[].advertiserName

String

광고주명

optional

result.content[].advertiserType

String

UNSYNC_ADVERTISER : 광고주 비동기화 APPLICABLE : 신청 가능 WAIT_REVIEW : 심사 대기 REJECT : 심사 반려 OPERATION_REVIEW : 운영 검토 대기 OPERATION_REJECT : 운영 검토 거절 OPERATION_REVIEW_SUCCESS : 운영 검토 완료 ADVERTISER_AGREE_WAIT : 광고주 동의 대기 ADVERTISER_AGREE_TIME_EXPIRE : 광고주 동의 기한 만료 CANCEL : 신청 취소 REGISTER_WITHDRAW_ACCOUNT_FAIL : 출금 계좌 등록 실패 OPERATION : 운영중 PAUSE : 일시중지 TERMINATE_WAIT : 해지 대기 TERMINATE : 해지

required

result.content[].description

String

반려 사유

optional

result.content[].descriptionRegisterDt

String

반려 사유 등록 시간

optional

result.content[].registerOrUpdateDt

String

광고주 등록 또는 수정 시간

required

result.content[].isMyAdvertiser

Boolean

내 광고주인지 여부 true : 나와 매핑된 광고주 false : 하위 부서 마케터와 연결된 광고주

required

result.content[].advertiserFormId

Number

신청 이력 최신 UID

required

result.page

Number

페이지 번호

required

result.size

Number

사이즈

required

result.totalCount

Number

전체 갯수

required

19. 광고주 상태 갯수 조회(SAG020)

HTTP request

GET /core/service/api/v1/agents/1/users/1/advertisers/status-count-list HTTP/1.1
Content-Type: application/json
Host: localhost:8080

HTTP response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 411

{"result":{"totalCount":14,"waitReviewCount":1,"rejectCount":1,"operationReviewCount":1,"operationRejectCount":1,"operationReviewSuccessCount":1,"advertiserAgreeWaitCount":1,"advertiserAgreeTimeExpireCount":1,"cancelCount":1,"registerWithDrawAccountFailCount":1,"operationCount":1,"pauseCount":1,"terminateWaitCount":1,"terminateCount":1},"code":"0","message":"요청이 성공적으로 완료되었습니다."}

Path parameters

Table 1. /core/service/api/v1/agents/{agentId}/users/{userId}/advertisers/status-count-list
Parameter Description

agentId

대행사 UID

userId

회원 UID

Response body

{"result":{"totalCount":14,"waitReviewCount":1,"rejectCount":1,"operationReviewCount":1,"operationRejectCount":1,"operationReviewSuccessCount":1,"advertiserAgreeWaitCount":1,"advertiserAgreeTimeExpireCount":1,"cancelCount":1,"registerWithDrawAccountFailCount":1,"operationCount":1,"pauseCount":1,"terminateWaitCount":1,"terminateCount":1},"code":"0","message":"요청이 성공적으로 완료되었습니다."}

Response fields

Path Type Description Required

code

String

응답 코드

required

message

String

오류 메시지

required

result.totalCount

Number

전체 상태 갯수

required

result.waitReviewCount

Number

심사 대기 갯수

required

result.rejectCount

Number

심사 반려 갯수

required

result.operationReviewCount

Number

운영 검토 대기 갯수

required

result.operationRejectCount

Number

운영 검토 거절 갯수

required

result.operationReviewSuccessCount

Number

운영 검토 완료 갯수

required

result.advertiserAgreeWaitCount

Number

광고주 동의 대기 갯수

required

result.advertiserAgreeTimeExpireCount

Number

광고주 동의 기한 만료 갯수

required

result.cancelCount

Number

신청 취소 갯수

required

result.registerWithDrawAccountFailCount

Number

출금 계좌 등록 실패 갯수

required

result.operationCount

Number

운영중 갯수

required

result.pauseCount

Number

일시중지 갯수

required

result.terminateWaitCount

Number

해지 대기 갯수

required

result.terminateCount

Number

해지 갯수

required

20. 광고주 상태 변경(SAG021)

HTTP request

POST /core/service/api/v1/agents/1/users/1/advertiser/1/status HTTP/1.1
Content-Type: application/json
Content-Length: 18
Host: localhost:8080

{"status":"PAUSE"}

HTTP response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 87

{"result":null,"code":"0","message":"요청이 성공적으로 완료되었습니다."}

Path parameters

Table 1. /core/service/api/v1/agents/{agentId}/users/{userId}/advertiser/{advertiserId}/status
Parameter Description

agentId

대행사 UID

userId

사용자 UID

advertiserId

광고주 UID

Request body

{"status":"PAUSE"}

Request fields

Path Type Description Required

status

String

UNSYNC_ADVERTISER : 광고주 비동기화 APPLICABLE : 신청 가능 WAIT_REVIEW : 심사 대기 REJECT : 심사 반려 OPERATION_REVIEW : 운영 검토 대기 OPERATION_REJECT : 운영 검토 거절 OPERATION_REVIEW_SUCCESS : 운영 검토 완료 ADVERTISER_AGREE_WAIT : 광고주 동의 대기 ADVERTISER_AGREE_TIME_EXPIRE : 광고주 동의 기한 만료 CANCEL : 신청 취소 REGISTER_WITHDRAW_ACCOUNT_FAIL : 출금 계좌 등록 실패 OPERATION : 운영중 PAUSE : 일시중지 TERMINATE_WAIT : 해지 대기 TERMINATE : 해지

required

Response body

{"result":null,"code":"0","message":"요청이 성공적으로 완료되었습니다."}

Response fields

Path Type Description Required

code

String

응답 코드

required

message

String

오류 메시지

required

result

Null

결과

required

21. 광고주 smPay 신청 관리 리스트 조회(SAG022)

HTTP request

GET /core/service/api/v1/agents/1/users/1/advertisers-apply-list?keyword=%EA%B2%80%EC%83%89%ED%95%A0+%ED%82%A4%EC%9B%8C%EB%93%9C&orderType=ADVERTISER_REGISTER_DESC&page=1&size=10 HTTP/1.1
Content-Type: application/json
Host: localhost:8080

HTTP response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 388

{"result":{"content":[{"advertiserId":1,"advertiserCustomerId":1,"advertiserLoginId":"광고주 로그인 ID","advertiserNickName":"광고주 닉네임","advertiserName":"광고주명","advertiserType":"ADVERTISER_AGREE_WAIT","registerOrUpdateDt":"2025-06-27T12:13:53.287332287"}],"page":1,"size":10,"totalCount":1},"code":"0","message":"요청이 성공적으로 완료되었습니다."}

Path parameters

Table 1. /core/service/api/v1/agents/{agentId}/users/{userId}/advertisers-apply-list
Parameter Description

agentId

대행사 UID

userId

회원 UID

Query parameters

Parameter Description Required

page

페이지 번호 (1부터 시작)

required

size

페이지 크기

required

sort

해당 부분 사용하지 않음, OrderType을 통해 정렬 기준 제어

optional

keyword

Customer Id, 광고주 로그인 ID, 광고주명 검색 키워드

optional

orderType

ADVERTISER_REGISTER_DESC ADVERTISER_REGISTER_ASC ADVERTISER_STATUS_DESC ADVERTISER_STATUS_ASC ADVERTISER_NAME_DESC ADVERTISER_NAME_ASC ADVERTISER_NICK_NAME_DESC ADVERTISER_NICK_NAME_ASC ADVERTISER_ID_DESC ADVERTISER_ID_ASC ADVERTISER_CUSTOMER_ID_DESC ADVERTISER_CUSTOMER_ID_ASC

optional

Response body

{"result":{"content":[{"advertiserId":1,"advertiserCustomerId":1,"advertiserLoginId":"광고주 로그인 ID","advertiserNickName":"광고주 닉네임","advertiserName":"광고주명","advertiserType":"ADVERTISER_AGREE_WAIT","registerOrUpdateDt":"2025-06-27T12:13:53.287332287"}],"page":1,"size":10,"totalCount":1},"code":"0","message":"요청이 성공적으로 완료되었습니다."}

Response fields

Path Type Description Required

code

String

응답 코드

required

message

String

오류 메시지

required

result.content[].advertiserId

Number

광고주 UId

required

result.content[].advertiserCustomerId

Number

광고주 customer Id

required

result.content[].advertiserLoginId

String

광고주 로그인 ID

required

result.content[].advertiserNickName

String

광고주 닉네임

required

result.content[].advertiserName

String

광고주명

optional

result.content[].advertiserType

String

UNSYNC_ADVERTISER : 광고주 비동기화 APPLICABLE : 신청 가능 WAIT_REVIEW : 심사 대기 REJECT : 심사 반려 OPERATION_REVIEW : 운영 검토 대기 OPERATION_REJECT : 운영 검토 거절 OPERATION_REVIEW_SUCCESS : 운영 검토 완료 ADVERTISER_AGREE_WAIT : 광고주 동의 대기 ADVERTISER_AGREE_TIME_EXPIRE : 광고주 동의 기한 만료 CANCEL : 신청 취소 REGISTER_WITHDRAW_ACCOUNT_FAIL : 출금 계좌 등록 실패 OPERATION : 운영중 PAUSE : 일시중지 TERMINATE_WAIT : 해지 대기 TERMINATE : 해지

required

result.content[].registerOrUpdateDt

String

광고주 등록 또는 업데이트 시간

required

result.page

Number

페이지 번호

required

result.size

Number

사이즈

required

result.totalCount

Number

전체 갯수

required

22. 광고주 detail 등록 및 수정(SAG023)

HTTP request

PUT /core/service/api/v1/agents/1/users/1/advertisers/1/details HTTP/1.1
Content-Type: application/json
Content-Length: 172
Host: localhost:8080

{"name":"광고주명","representativeName":"대표자명","representativeNumber":"대표 사업자 등록번호","phoneNumber":"01011111111","email":"pgw111111@naver.com"}

HTTP response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 87

{"result":null,"code":"0","message":"요청이 성공적으로 완료되었습니다."}

Path parameters

Table 1. /core/service/api/v1/agents/{agentId}/users/{userId}/advertisers/{advertiserId}/details
Parameter Description

agentId

대행사 UID

userId

회원 UID

advertiserId

광고주 UID

Request body

{"name":"광고주명","representativeName":"대표자명","representativeNumber":"대표 사업자 등록번호","phoneNumber":"01011111111","email":"pgw111111@naver.com"}

Request fields

Path Type Description Required

name

String

광고주명

required

representativeName

String

대표자명

required

representativeNumber

String

대표 사업자 등록 번호

required

phoneNumber

String

전화번호

required

email

String

이메일

required

Response body

{"result":null,"code":"0","message":"요청이 성공적으로 완료되었습니다."}

Response fields

Path Type Description Required

code

String

응답 코드

required

message

String

오류 메시지

required

result

Null

결과

required

23. 광고주 detail 조회(SAG024)

HTTP request

GET /core/service/api/v1/agents/1/users/1/advertisers/1/details HTTP/1.1
Content-Type: application/json
Host: localhost:8080

HTTP response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 405

{"result":{"advertiserId":1,"userId":1,"customerId":1,"id":"아이디","nickName":"닉네임","name":"광고주명","representativeName":"대표자명","businessRegistrationNumber":"광고주 사업자 등록 번호","phoneNumber":"전화번호","emailAddress":"이메일","status":"WAIT_REVIEW","roleId":1,"isLossPrivileges":false},"code":"0","message":"요청이 성공적으로 완료되었습니다."}

Path parameters

Table 1. /core/service/api/v1/agents/{agentId}/users/{userId}/advertisers/{advertiserId}/details
Parameter Description

agentId

대행사 UID

userId

회원 UID

advertiserId

광고주 UID

Response body

{"result":{"advertiserId":1,"userId":1,"customerId":1,"id":"아이디","nickName":"닉네임","name":"광고주명","representativeName":"대표자명","businessRegistrationNumber":"광고주 사업자 등록 번호","phoneNumber":"전화번호","emailAddress":"이메일","status":"WAIT_REVIEW","roleId":1,"isLossPrivileges":false},"code":"0","message":"요청이 성공적으로 완료되었습니다."}

Response fields

Path Type Description Required

code

String

응답 코드

required

message

String

오류 메시지

required

result.advertiserId

Number

광고주 UID

required

result.userId

Number

광고주 매핑 마케터 UID

required

result.customerId

Number

광고주 customer Id

required

result.id

String

광고주 로그인 ID

required

result.nickName

String

광고주 닉네임

required

result.name

String

광고주명

optional

result.representativeName

String

광고주 대표자명

optional

result.businessRegistrationNumber

String

광고주 사업자 등록 번호

optional

result.phoneNumber

String

광고주 전화번호

optional

result.emailAddress

String

광고주 이메일

optional

result.status

String

UNSYNC_ADVERTISER : 광고주 비동기화 APPLICABLE : 신청 가능 WAIT_REVIEW : 심사 대기 REJECT : 심사 반려 OPERATION_REVIEW : 운영 검토 대기 OPERATION_REJECT : 운영 검토 거절 OPERATION_REVIEW_SUCCESS : 운영 검토 완료 ADVERTISER_AGREE_WAIT : 광고주 동의 대기 ADVERTISER_AGREE_TIME_EXPIRE : 광고주 동의 기한 만료 CANCEL : 신청 취소 REGISTER_WITHDRAW_ACCOUNT_FAIL : 출금 계좌 등록 실패 OPERATION : 운영중 PAUSE : 일시중지 TERMINATE_WAIT : 해지 대기 TERMINATE : 해지

required

result.roleId

Number

광고주 역할 UID

required

result.isLossPrivileges

Boolean

권한 상실 여부 true : 상실 false : 비상실

required

24. 광고주 smPay 신청 이력 리스트 조회(SAG025)

HTTP request

GET /core/service/api/v1/agents/1/users/1/advertisers/1/apply-form-list HTTP/1.1
Content-Type: application/json
Host: localhost:8080

HTTP response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1252

{"result":[{"chargeRules":[{"advertiserFormChargeRuleId":1,"advertiserFormId":1,"rangeType":"UP","boundType":"FIXED_AMOUNT","changePercentOrValue":1}],"accounts":[{"advertiserFormAccountId":1,"advertiserFormId":1,"advertiserAccountCode":"002","advertiserAccountCodeName":"은행명","advertiserAccountNumber":"계좌번호","advertiserAccountName":"예금주","advertiserAccountType":"DEPOSIT"}],"advertiserFormId":1,"advertiserId":1,"advertiserStatus":"ADVERTISER_AGREE_TIME_EXPIRE","advertiserName":"광고주명","advertiserNickname":"광고주 닉네임","advertiserLoginId":"광고주 로그인 ID","advertiserCustomerId":1231231,"advertiserRepresentativeName":"광고주 대표자명","advertiserPhoneNumber":"0101111111","advertiserEmailAddress":"pgw111111@naver.com","advertiserOperationPeriod":1,"advertiserDailyAverageRoas":0.01,"advertiserMonthlyConvAmt":0.01,"advertiserDailySalesAmt":0.01,"advertiserRecommendRoasPercent":0.01,"advertiserStandardRoasPercent":1,"advertiserRejectDescription":"반려 사유","initialAmount":1,"maxChargeLimit":1,"minChargeLimit":1,"reviewerMemo":"심사자 메모","approvalMemo":"운영자 메모","registerDt":null,"updateDt":null}],"code":"0","message":"요청이 성공적으로 완료되었습니다."}

Path parameters

Table 1. /core/service/api/v1/agents/{agentId}/users/{userId}/advertisers/{advertiserId}/apply-form-list
Parameter Description

agentId

대행사 UID

userId

회원 UID

advertiserId

광고주 UID

Response body

{"result":[{"chargeRules":[{"advertiserFormChargeRuleId":1,"advertiserFormId":1,"rangeType":"UP","boundType":"FIXED_AMOUNT","changePercentOrValue":1}],"accounts":[{"advertiserFormAccountId":1,"advertiserFormId":1,"advertiserAccountCode":"002","advertiserAccountCodeName":"은행명","advertiserAccountNumber":"계좌번호","advertiserAccountName":"예금주","advertiserAccountType":"DEPOSIT"}],"advertiserFormId":1,"advertiserId":1,"advertiserStatus":"ADVERTISER_AGREE_TIME_EXPIRE","advertiserName":"광고주명","advertiserNickname":"광고주 닉네임","advertiserLoginId":"광고주 로그인 ID","advertiserCustomerId":1231231,"advertiserRepresentativeName":"광고주 대표자명","advertiserPhoneNumber":"0101111111","advertiserEmailAddress":"pgw111111@naver.com","advertiserOperationPeriod":1,"advertiserDailyAverageRoas":0.01,"advertiserMonthlyConvAmt":0.01,"advertiserDailySalesAmt":0.01,"advertiserRecommendRoasPercent":0.01,"advertiserStandardRoasPercent":1,"advertiserRejectDescription":"반려 사유","initialAmount":1,"maxChargeLimit":1,"minChargeLimit":1,"reviewerMemo":"심사자 메모","approvalMemo":"운영자 메모","registerDt":null,"updateDt":null}],"code":"0","message":"요청이 성공적으로 완료되었습니다."}

Response fields

Path Type Description Required

code

String

응답 코드

required

message

String

오류 메시지

required

result[].accounts[].advertiserFormAccountId

Number

광고주 연결 계좌 UID

required

result[].accounts[].advertiserFormId

Number

광고주 신청서 ID

required

result[].accounts[].advertiserAccountCode

String

BANK_002 BANK_003 BANK_004 BANK_007 BANK_011 BANK_012 BANK_020 BANK_023 BANK_027 BANK_031 BANK_032 BANK_034 BANK_035 BANK_037 BANK_039 BANK_045 BANK_048 BANK_050 BANK_052 BANK_054 BANK_055 BANK_057 BANK_058 BANK_059 BANK_060 BANK_061 BANK_062 BANK_063 BANK_064 BANK_065 BANK_066 BANK_067 BANK_071 BANK_081 BANK_088 BANK_089 BANK_090 BANK_092 BANK_209 BANK_218 BANK_238 BANK_240 BANK_243 BANK_247 BANK_261 BANK_262 BANK_263 BANK_264 BANK_265 BANK_266 BANK_267 BANK_269 BANK_270 BANK_278 BANK_279 BANK_280 BANK_287 BANK_288 BANK_290 BANK_291 BANK_292 BANK_293 BANK_294

required

result[].accounts[].advertiserAccountCodeName

String

광고주 연결 은행명

required

result[].accounts[].advertiserAccountNumber

String

광고주 연결 계좌 번호

required

result[].accounts[].advertiserAccountName

String

광고주 연결 계좌 예금주

required

result[].accounts[].advertiserAccountType

String

DEPOSIT WITHDRAW

required

result[].advertiserFormId

Number

광고주 신청서 ID

required

result[].advertiserId

Number

광고주 UID

required

result[].advertiserStatus

String

UNSYNC_ADVERTISER : 광고주 비동기화 APPLICABLE : 신청 가능 WAIT_REVIEW : 심사 대기 REJECT : 심사 반려 OPERATION_REVIEW : 운영 검토 대기 OPERATION_REJECT : 운영 검토 거절 OPERATION_REVIEW_SUCCESS : 운영 검토 완료 ADVERTISER_AGREE_WAIT : 광고주 동의 대기 ADVERTISER_AGREE_TIME_EXPIRE : 광고주 동의 기한 만료 CANCEL : 신청 취소 REGISTER_WITHDRAW_ACCOUNT_FAIL : 출금 계좌 등록 실패 OPERATION : 운영중 PAUSE : 일시중지 TERMINATE_WAIT : 해지 대기 TERMINATE : 해지

required

result[].advertiserName

String

광고주명

required

result[].advertiserNickname

String

광고주 닉네임

required

result[].advertiserLoginId

String

광고주 로그인 Id

required

result[].advertiserCustomerId

Number

광고주 Customer Id

required

result[].advertiserRepresentativeName

String

광고주 대표자명

required

result[].advertiserPhoneNumber

String

광고주 전화번호

required

result[].advertiserEmailAddress

String

광고주 이메일

required

result[].advertiserOperationPeriod

Number

광고주 운영 기간 (개월)

required

result[].advertiserDailyAverageRoas

Number

일일 평균 ROAS

required

result[].advertiserMonthlyConvAmt

Number

월 평균 전환 금액

required

result[].advertiserDailySalesAmt

Number

일일 매출 금액

required

result[].advertiserRecommendRoasPercent

Number

권장 ROAS 비율

required

result[].advertiserStandardRoasPercent

Number

기준 ROAS

required

result[].chargeRules[].advertiserFormChargeRuleId

Number

충전 규칙 UID

required

result[].chargeRules[].advertiserFormId

Number

심사 스냅샷 UID

required

result[].chargeRules[].rangeType

String

UP DOWN

required

result[].chargeRules[].boundType

String

FIXED_AMOUNT PERCENTAGE

required

result[].chargeRules[].changePercentOrValue

Number

상승 퍼센테이지 또는 상승금액

required

result[].initialAmount

Number

초기 금액

required

result[].maxChargeLimit

Number

최대 충전 한도

required

result[].minChargeLimit

Number

최소 충전 한도

required

result[].reviewerMemo

String

검토자 메모

optional

result[].approvalMemo

String

승인 메모

optional

result[].registerDt

Null

등록 일시

required

result[].updateDt

Null

수정 일시

optional

result[].advertiserRejectDescription

String

거절 사유

optional

25. 광고주 smPay 신청 이력 상세 조회(SAG026)

HTTP request

GET /core/service/api/v1/agents/1/users/1/advertisers/1/form/1 HTTP/1.1
Content-Type: application/json
Host: localhost:8080

HTTP response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1250

{"result":{"chargeRules":[{"advertiserFormChargeRuleId":1,"advertiserFormId":1,"rangeType":"UP","boundType":"FIXED_AMOUNT","changePercentOrValue":1}],"accounts":[{"advertiserFormAccountId":1,"advertiserFormId":1,"advertiserAccountCode":"002","advertiserAccountCodeName":"은행명","advertiserAccountNumber":"계좌번호","advertiserAccountName":"예금주","advertiserAccountType":"DEPOSIT"}],"advertiserFormId":1,"advertiserId":1,"advertiserStatus":"ADVERTISER_AGREE_TIME_EXPIRE","advertiserName":"광고주명","advertiserNickname":"광고주 닉네임","advertiserLoginId":"광고주 로그인 ID","advertiserCustomerId":1231231,"advertiserRepresentativeName":"광고주 대표자명","advertiserPhoneNumber":"0101111111","advertiserEmailAddress":"pgw111111@naver.com","advertiserOperationPeriod":1,"advertiserDailyAverageRoas":0.01,"advertiserMonthlyConvAmt":0.01,"advertiserDailySalesAmt":0.01,"advertiserRecommendRoasPercent":0.01,"advertiserStandardRoasPercent":1,"advertiserRejectDescription":"반려 사유","initialAmount":1,"maxChargeLimit":1,"minChargeLimit":1,"reviewerMemo":"심사자 메모","approvalMemo":"운영자 메모","registerDt":null,"updateDt":null},"code":"0","message":"요청이 성공적으로 완료되었습니다."}

Path parameters

Table 1. /core/service/api/v1/agents/{agentId}/users/{userId}/advertisers/{advertiserId}/form/{formId}
Parameter Description

agentId

대행사 UID

userId

회원 UID

advertiserId

광고주 UID

formId

심사 이력 UID

Response body

{"result":{"chargeRules":[{"advertiserFormChargeRuleId":1,"advertiserFormId":1,"rangeType":"UP","boundType":"FIXED_AMOUNT","changePercentOrValue":1}],"accounts":[{"advertiserFormAccountId":1,"advertiserFormId":1,"advertiserAccountCode":"002","advertiserAccountCodeName":"은행명","advertiserAccountNumber":"계좌번호","advertiserAccountName":"예금주","advertiserAccountType":"DEPOSIT"}],"advertiserFormId":1,"advertiserId":1,"advertiserStatus":"ADVERTISER_AGREE_TIME_EXPIRE","advertiserName":"광고주명","advertiserNickname":"광고주 닉네임","advertiserLoginId":"광고주 로그인 ID","advertiserCustomerId":1231231,"advertiserRepresentativeName":"광고주 대표자명","advertiserPhoneNumber":"0101111111","advertiserEmailAddress":"pgw111111@naver.com","advertiserOperationPeriod":1,"advertiserDailyAverageRoas":0.01,"advertiserMonthlyConvAmt":0.01,"advertiserDailySalesAmt":0.01,"advertiserRecommendRoasPercent":0.01,"advertiserStandardRoasPercent":1,"advertiserRejectDescription":"반려 사유","initialAmount":1,"maxChargeLimit":1,"minChargeLimit":1,"reviewerMemo":"심사자 메모","approvalMemo":"운영자 메모","registerDt":null,"updateDt":null},"code":"0","message":"요청이 성공적으로 완료되었습니다."}

Response fields

Path Type Description Required

code

String

응답 코드

required

message

String

오류 메시지

required

result.accounts[].advertiserFormAccountId

Number

광고주 연결 계좌 UID

required

result.accounts[].advertiserFormId

Number

광고주 신청서 ID

required

result.accounts[].advertiserAccountCode

String

BANK_002 BANK_003 BANK_004 BANK_007 BANK_011 BANK_012 BANK_020 BANK_023 BANK_027 BANK_031 BANK_032 BANK_034 BANK_035 BANK_037 BANK_039 BANK_045 BANK_048 BANK_050 BANK_052 BANK_054 BANK_055 BANK_057 BANK_058 BANK_059 BANK_060 BANK_061 BANK_062 BANK_063 BANK_064 BANK_065 BANK_066 BANK_067 BANK_071 BANK_081 BANK_088 BANK_089 BANK_090 BANK_092 BANK_209 BANK_218 BANK_238 BANK_240 BANK_243 BANK_247 BANK_261 BANK_262 BANK_263 BANK_264 BANK_265 BANK_266 BANK_267 BANK_269 BANK_270 BANK_278 BANK_279 BANK_280 BANK_287 BANK_288 BANK_290 BANK_291 BANK_292 BANK_293 BANK_294

required

result.accounts[].advertiserAccountCodeName

String

광고주 연결 은행명

required

result.accounts[].advertiserAccountNumber

String

광고주 연결 계좌 번호

required

result.accounts[].advertiserAccountName

String

광고주 연결 계좌 예금주

required

result.accounts[].advertiserAccountType

String

DEPOSIT WITHDRAW

required

result.advertiserFormId

Number

광고주 신청서 ID

required

result.advertiserId

Number

광고주 UID

required

result.advertiserStatus

String

UNSYNC_ADVERTISER : 광고주 비동기화 APPLICABLE : 신청 가능 WAIT_REVIEW : 심사 대기 REJECT : 심사 반려 OPERATION_REVIEW : 운영 검토 대기 OPERATION_REJECT : 운영 검토 거절 OPERATION_REVIEW_SUCCESS : 운영 검토 완료 ADVERTISER_AGREE_WAIT : 광고주 동의 대기 ADVERTISER_AGREE_TIME_EXPIRE : 광고주 동의 기한 만료 CANCEL : 신청 취소 REGISTER_WITHDRAW_ACCOUNT_FAIL : 출금 계좌 등록 실패 OPERATION : 운영중 PAUSE : 일시중지 TERMINATE_WAIT : 해지 대기 TERMINATE : 해지

required

result.advertiserName

String

광고주명

required

result.advertiserNickname

String

광고주 닉네임

required

result.advertiserLoginId

String

광고주 로그인 Id

required

result.advertiserCustomerId

Number

광고주 Customer Id

required

result.advertiserRepresentativeName

String

광고주 대표자명

required

result.advertiserPhoneNumber

String

광고주 전화번호

required

result.advertiserEmailAddress

String

광고주 이메일

required

result.advertiserOperationPeriod

Number

광고주 운영 기간 (개월)

required

result.advertiserDailyAverageRoas

Number

일일 평균 ROAS

required

result.advertiserMonthlyConvAmt

Number

월 평균 전환 금액

required

result.advertiserDailySalesAmt

Number

일일 매출 금액

required

result.advertiserRecommendRoasPercent

Number

권장 ROAS 비율

required

result.advertiserStandardRoasPercent

Number

기준 ROAS

required

result.chargeRules[].advertiserFormChargeRuleId

Number

충전 규칙 UID

required

result.chargeRules[].advertiserFormId

Number

심사 스냅샷 UID

required

result.chargeRules[].rangeType

String

UP DOWN

required

result.chargeRules[].boundType

String

FIXED_AMOUNT PERCENTAGE

required

result.chargeRules[].changePercentOrValue

Number

상승 퍼센테이지 또는 상승금액

required

result.initialAmount

Number

초기 금액

required

result.maxChargeLimit

Number

최대 충전 한도

required

result.minChargeLimit

Number

최소 충전 한도

required

result.reviewerMemo

String

검토자 메모

optional

result.approvalMemo

String

승인 메모

optional

result.registerDt

Null

등록 일시

required

result.updateDt

Null

수정 일시

optional

result.advertiserRejectDescription

String

거절 사유

optional

26. 광고주 일 별 성과 조회(28일)(SAG027)

HTTP request

GET /core/service/api/v1/agents/1/users/1/advertisers/1/daily-stat HTTP/1.1
Content-Type: application/json
Host: localhost:8080

HTTP response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 228

{"result":[{"advertiserId":1,"impCnt":1,"clkCnt":1,"salesAmt":1,"avgRnk":1,"convAmt":1,"cpc":1,"ccnt":1,"crto":1,"cpConv":1,"ror":100,"date":"2025-06-27"}],"code":"0","message":"요청이 성공적으로 완료되었습니다."}

Path parameters

Table 1. /core/service/api/v1/agents/{agentId}/users/{userId}/advertisers/{advertiserId}/daily-stat
Parameter Description

agentId

대행사 UID

userId

회원 UID

advertiserId

광고주 UID

Response body

{"result":[{"advertiserId":1,"impCnt":1,"clkCnt":1,"salesAmt":1,"avgRnk":1,"convAmt":1,"cpc":1,"ccnt":1,"crto":1,"cpConv":1,"ror":100,"date":"2025-06-27"}],"code":"0","message":"요청이 성공적으로 완료되었습니다."}

Response fields

Path Type Description Required

code

String

응답 코드

required

message

String

오류 메시지

required

result[].advertiserId

Number

광고주 UID

required

result[].impCnt

Number

노출 수

required

result[].clkCnt

Number

클릭 수

required

result[].salesAmt

Number

광고비

required

result[].avgRnk

Number

평균 노출 순위

required

result[].convAmt

Number

전환 매출

required

result[].cpc

Number

클릭 단가

required

result[].ccnt

Number

전환 수

required

result[].crto

Number

전환율

required

result[].cpConv

Number

전환당 비용

required

result[].ror

Number

roas

required

result[].date

String

날짜

required

27. 광고주 성과 기반 참고용 심사 지표 조회(28일)(SAG028)

HTTP request

GET /core/service/api/v1/agents/1/users/1/advertisers/1/stat-indicator HTTP/1.1
Content-Type: application/json
Host: localhost:8080

HTTP response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 193

{"result":{"operationPeriod":1,"dailyAverageRoas":1.0,"monthlyConvAmt":1000.0,"dailySalesAmt":100.0,"recommendRoas":0.8},"code":"0","message":"요청이 성공적으로 완료되었습니다."}

Path parameters

Table 1. /core/service/api/v1/agents/{agentId}/users/{userId}/advertisers/{advertiserId}/stat-indicator
Parameter Description

agentId

대행사 UID

userId

회원 UID

advertiserId

광고주 UID

Response body

{"result":{"operationPeriod":1,"dailyAverageRoas":1.0,"monthlyConvAmt":1000.0,"dailySalesAmt":100.0,"recommendRoas":0.8},"code":"0","message":"요청이 성공적으로 완료되었습니다."}

Response fields

Path Type Description Required

code

String

응답 코드

required

message

String

오류 메시지

required

result.operationPeriod

Number

광고 운영 기간

required

result.dailyAverageRoas

Number

일 평균 ROAS

required

result.monthlyConvAmt

Number

월 평균 전환 매출

required

result.dailySalesAmt

Number

일 평균 소진 광고비

required

result.recommendRoas

Number

권장 ROAS

required

28. 광고주 smPay 등록(SAG029)

HTTP request

POST /core/service/api/v1/agents/1/users/1/advertisers/1/form HTTP/1.1
Content-Type: application/json
Content-Length: 353
Host: localhost:8080

{"statIndicator":{"operationPeriod":1,"dailyAverageRoas":1.0,"monthlyConvAmt":1.0,"dailySalesAmt":1.0,"recommendRoasPercent":1.0},"chargeRule":[{"standardRoasPercent":1,"rangeType":"UP","boundType":"FIXED_AMOUNT","changePercentOrValue":1}],"prePaymentSchedule":{"initialAmount":1,"maxChargeLimit":1,"minChargeLimit":1},"reviewerMemo":"심사자 메모"}

HTTP response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 87

{"result":null,"code":"0","message":"요청이 성공적으로 완료되었습니다."}

Path parameters

Table 1. /core/service/api/v1/agents/{agentId}/users/{userId}/advertisers/{advertiserId}/form
Parameter Description

agentId

대행사 UID

userId

회원 UID

advertiserId

광고주 UID

Request body

{"statIndicator":{"operationPeriod":1,"dailyAverageRoas":1.0,"monthlyConvAmt":1.0,"dailySalesAmt":1.0,"recommendRoasPercent":1.0},"chargeRule":[{"standardRoasPercent":1,"rangeType":"UP","boundType":"FIXED_AMOUNT","changePercentOrValue":1}],"prePaymentSchedule":{"initialAmount":1,"maxChargeLimit":1,"minChargeLimit":1},"reviewerMemo":"심사자 메모"}

Request fields

Path Type Description Required

statIndicator.operationPeriod

Number

운영 개월 수

required

statIndicator.dailyAverageRoas

Number

일 평균 ROAS

required

statIndicator.monthlyConvAmt

Number

월 평균 전환매출

required

statIndicator.dailySalesAmt

Number

일 평균 소진 광고비

required

statIndicator.recommendRoasPercent

Number

권장 ROAS

required

chargeRule[].standardRoasPercent

Number

기준 ROAS

required

chargeRule[].rangeType

String

이상 , 미만

required

chargeRule[].boundType

String

정률 , 정액

required

chargeRule[].changePercentOrValue

Number

변화 퍼센트

required

prePaymentSchedule.initialAmount

Number

최초 충전 금액

required

prePaymentSchedule.maxChargeLimit

Number

일 최대 한도

required

prePaymentSchedule.minChargeLimit

Number

일 최저 한도 , 10000원 고정

required

reviewerMemo

String

심사자 메모

required

Response body

{"result":null,"code":"0","message":"요청이 성공적으로 완료되었습니다."}

Response fields

Path Type Description Required

code

String

응답 코드

required

message

String

오류 메시지

required

result

Null

결과

required

29. 광고주 심사 관리 리스트 조회(최상위 그룹장 전용)(SAG030)

HTTP request

GET /core/service/api/v1/agents/1/users/1/advertisers/audit/list?page=1&size=10&keyword=%EA%B2%80%EC%83%89%ED%95%A0+%ED%82%A4%EC%9B%8C%EB%93%9C&orderType=ADVERTISER_REGISTER_DESC HTTP/1.1
Content-Type: application/json
Host: localhost:8080

HTTP response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 495

{"result":{"content":[{"userId":1,"userName":"담당자명","advertiserFormId":1,"advertiserId":1,"advertiserCustomerId":12312,"advertiserLoginId":"광고주 로그인 ID","advertiserNickname":"광고주 닉네임","advertiserName":"광고주명","advertiserType":"ADVERTISER_AGREE_WAIT","isApprovalRead":false,"isOperatorRead":true,"registerOrUpdateDt":"2025-06-27T12:13:53.307379704"}],"page":1,"size":10,"totalCount":1},"code":"0","message":"요청이 성공적으로 완료되었습니다."}

Path parameters

Table 1. /core/service/api/v1/agents/{agentId}/users/{userId}/advertisers/audit/list
Parameter Description

agentId

대행사 UID

userId

회원 UID

Query parameters

Parameter Description Required

page

페이지 번호 (1부터 시작)

required

size

페이지 크기

required

sort

해당 부분 사용하지 않음, OrderType을 통해 정렬 기준 제어

optional

keyword

대행사, 회원명, 이메일 검색 키워드

optional

orderType

ADVERTISER_REGISTER_DESC ADVERTISER_REGISTER_ASC ADVERTISER_STATUS_DESC ADVERTISER_STATUS_ASC ADVERTISER_NAME_DESC ADVERTISER_NAME_ASC ADVERTISER_NICK_NAME_DESC ADVERTISER_NICK_NAME_ASC ADVERTISER_ID_DESC ADVERTISER_ID_ASC ADVERTISER_CUSTOMER_ID_DESC ADVERTISER_CUSTOMER_ID_ASC USER_NAME_DESC USER_NAME_ASC

required

Response body

{"result":{"content":[{"userId":1,"userName":"담당자명","advertiserFormId":1,"advertiserId":1,"advertiserCustomerId":12312,"advertiserLoginId":"광고주 로그인 ID","advertiserNickname":"광고주 닉네임","advertiserName":"광고주명","advertiserType":"ADVERTISER_AGREE_WAIT","isApprovalRead":false,"isOperatorRead":true,"registerOrUpdateDt":"2025-06-27T12:13:53.307379704"}],"page":1,"size":10,"totalCount":1},"code":"0","message":"요청이 성공적으로 완료되었습니다."}

Response fields

Path Type Description Required

code

String

응답 코드

required

message

String

오류 메시지

required

result.content[].userId

Number

회원 UID

required

result.content[].userName

String

회원 이름

required

result.content[].advertiserFormId

Number

광고주 지난 이력 Form Id

required

result.content[].advertiserId

Number

광고주 UID

required

result.content[].advertiserCustomerId

Number

광고주 customerId

required

result.content[].advertiserLoginId

String

광고주 로그인 ID

required

result.content[].advertiserNickname

String

광고주 닉네임

required

result.content[].advertiserName

String

광고주명

required

result.content[].advertiserType

String

UNSYNC_ADVERTISER : 광고주 비동기화 APPLICABLE : 신청 가능 WAIT_REVIEW : 심사 대기 REJECT : 심사 반려 OPERATION_REVIEW : 운영 검토 대기 OPERATION_REJECT : 운영 검토 거절 OPERATION_REVIEW_SUCCESS : 운영 검토 완료 ADVERTISER_AGREE_WAIT : 광고주 동의 대기 ADVERTISER_AGREE_TIME_EXPIRE : 광고주 동의 기한 만료 CANCEL : 신청 취소 REGISTER_WITHDRAW_ACCOUNT_FAIL : 출금 계좌 등록 실패 OPERATION : 운영중 PAUSE : 일시중지 TERMINATE_WAIT : 해지 대기 TERMINATE : 해지

required

result.content[].isApprovalRead

Boolean

최상위 그룹장 읽었는지 여부 true : 읽음 , false : 안읽음

required

result.content[].isOperatorRead

Boolean

운영자 읽었는지 여부 true : 읽음 , false : 안읽음

required

result.content[].registerOrUpdateDt

String

광고주 등록 또는 수정 시간

required

result.page

Number

페이지 번호

required

result.size

Number

사이즈

required

result.totalCount

Number

전체 갯수

required

30. 광고주 심사 목록 읽음, 미읽음 상태 변경 (최상위 그룹장 전용)(SAG031)

HTTP request

PATCH /core/service/api/v1/agents/1/users/1/advertisers/1/alarm?isApprovalRead=false HTTP/1.1
Content-Type: application/json
Host: localhost:8080

HTTP response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 87

{"result":null,"code":"0","message":"요청이 성공적으로 완료되었습니다."}

Path parameters

Table 1. /core/service/api/v1/agents/{agentId}/users/{userId}/advertisers/{advertiserId}/alarm
Parameter Description

agentId

대행사 UID

userId

회원 UID

advertiserId

광고주 UID

Query parameters

Parameter Description Required

isApprovalRead

true : 읽음 , false : 미읽음

required

Response body

{"result":null,"code":"0","message":"요청이 성공적으로 완료되었습니다."}

Response fields

Path Type Description Required

code

String

응답 코드

required

message

String

오류 메시지

required

result

Null

결과

required

31. 광고주 심사 지표 조회 (최상위 그룹장 전용)(SAG032)

HTTP request

GET /core/service/api/v1/agents/1/users/1/advertisers/1/screening-indicator HTTP/1.1
Content-Type: application/json
Host: localhost:8080

HTTP response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 301

{"result":{"advertiserScreeningIndicatorId":1,"advertiserId":1,"advertiserOperationPeriod":1,"advertiserDailyAverageRoas":0.01,"advertiserMonthlyConvAmt":0.01,"advertiserDailySalesAmt":0.01,"advertiserRecommendRoasPercent":0.01},"code":"0","message":"요청이 성공적으로 완료되었습니다."}

Path parameters

Table 1. /core/service/api/v1/agents/{agentId}/users/{userId}/advertisers/{advertiserId}/screening-indicator
Parameter Description

agentId

대행사 UID

userId

회원 UID

advertiserId

광고주 UID

Response body

{"result":{"advertiserScreeningIndicatorId":1,"advertiserId":1,"advertiserOperationPeriod":1,"advertiserDailyAverageRoas":0.01,"advertiserMonthlyConvAmt":0.01,"advertiserDailySalesAmt":0.01,"advertiserRecommendRoasPercent":0.01},"code":"0","message":"요청이 성공적으로 완료되었습니다."}

Response fields

Path Type Description Required

code

String

응답 코드

required

message

String

오류 메시지

required

result.advertiserScreeningIndicatorId

Number

광고주 성과지표 UID

required

result.advertiserId

Number

광고주 UID

required

result.advertiserOperationPeriod

Number

광고주 운영 기간

required

result.advertiserDailyAverageRoas

Number

광고주 일 평균 ROAS

required

result.advertiserMonthlyConvAmt

Number

광고주 월 평균 전환매출

required

result.advertiserDailySalesAmt

Number

광고주 일 평균 소진 광고비

required

result.advertiserRecommendRoasPercent

Number

광고주 권장 ROAS

required

32. 광고주 충전 규칙 조회 (최상위 그룹장 전용)(SAG033)

HTTP request

GET /core/service/api/v1/agents/1/users/1/advertisers/1/charge-rule HTTP/1.1
Content-Type: application/json
Host: localhost:8080

HTTP response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 223

{"result":[{"advertiserChargeRuleId":1,"advertiserId":1,"standardRoasPercent":1,"changePercentOrValue":1,"rangeType":"UP","boundType":"FIXED_AMOUNT"}],"code":"0","message":"요청이 성공적으로 완료되었습니다."}

Path parameters

Table 1. /core/service/api/v1/agents/{agentId}/users/{userId}/advertisers/{advertiserId}/charge-rule
Parameter Description

agentId

대행사 UID

userId

회원 UID

advertiserId

광고주 UID

Response body

{"result":[{"advertiserChargeRuleId":1,"advertiserId":1,"standardRoasPercent":1,"changePercentOrValue":1,"rangeType":"UP","boundType":"FIXED_AMOUNT"}],"code":"0","message":"요청이 성공적으로 완료되었습니다."}

Response fields

Path Type Description Required

code

String

응답 코드

required

message

String

오류 메시지

required

result[].advertiserChargeRuleId

Number

광고주 충전규칙 UID

required

result[].advertiserId

Number

광고주 UID

required

result[].standardRoasPercent

Number

광고주 충전 설정 ROAS

required

result[].changePercentOrValue

Number

정률 인상 퍼센트 또는 정액 인상 금액

required

result[].rangeType

String

UP DOWN

required

result[].boundType

String

FIXED_AMOUNT PERCENTAGE

required

33. 광고주 선결제 스케줄 조회 (최상위 그룹장 전용)(SAG034)

HTTP request

GET /core/service/api/v1/agents/1/users/1/advertisers/1/pre-payment-schedule HTTP/1.1
Content-Type: application/json
Host: localhost:8080

HTTP response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 204

{"result":{"advertiserPrepaymentScheduleId":1,"advertiserId":1,"initialAmount":10000,"maxChargeLimit":10000,"minChargeLimit":10000},"code":"0","message":"요청이 성공적으로 완료되었습니다."}

Path parameters

Table 1. /core/service/api/v1/agents/{agentId}/users/{userId}/advertisers/{advertiserId}/pre-payment-schedule
Parameter Description

agentId

대행사 UID

userId

회원 UID

advertiserId

광고주 UID

Response body

{"result":{"advertiserPrepaymentScheduleId":1,"advertiserId":1,"initialAmount":10000,"maxChargeLimit":10000,"minChargeLimit":10000},"code":"0","message":"요청이 성공적으로 완료되었습니다."}

Response fields

Path Type Description Required

code

String

응답 코드

required

message

String

오류 메시지

required

result.advertiserPrepaymentScheduleId

Number

광고주 선결제 규칙 UID

required

result.advertiserId

Number

광고주 UID

required

result.initialAmount

Number

광고주 최초 충전 금액 설정

required

result.maxChargeLimit

Number

일 최대 충전 한도

required

result.minChargeLimit

Number

일 최저 충전 한도

required

34. 광고주 심사자 참고용 메모 조회 (최상위 그룹장 전용)(SAG035)

HTTP request

GET /core/service/api/v1/agents/1/users/1/advertisers/1/reviewer-memo HTTP/1.1
Content-Type: application/json
Host: localhost:8080

HTTP response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 144

{"result":{"advertiserReviewerMemosId":1,"description":"메모 내용"},"code":"0","message":"요청이 성공적으로 완료되었습니다."}

Path parameters

Table 1. /core/service/api/v1/agents/{agentId}/users/{userId}/advertisers/{advertiserId}/reviewer-memo
Parameter Description

agentId

대행사 UID

userId

회원 UID

advertiserId

광고주 UID

Response body

{"result":{"advertiserReviewerMemosId":1,"description":"메모 내용"},"code":"0","message":"요청이 성공적으로 완료되었습니다."}

Response fields

Path Type Description Required

code

String

응답 코드

required

message

String

오류 메시지

required

result.advertiserReviewerMemosId

Number

심사자 참고용 메모 UID

optional

result.description

String

메모 내용

optional

35. 광고주 심사 승인 /거절 (최상위 그룹장 전용)(SAG036)

HTTP request

POST /core/service/api/v1/agents/1/users/1/advertisers/1/reviewer-decision HTTP/1.1
Content-Type: application/json
Content-Length: 468
Host: localhost:8080

{"decisionType":"APPROVE","statIndicator":{"operationPeriod":1,"dailyAverageRoas":1.0,"monthlyConvAmt":1.0,"dailySalesAmt":1.0,"recommendRoasPercent":1.0},"chargeRule":[{"standardRoasPercent":1,"rangeType":"UP","boundType":"FIXED_AMOUNT","changePercentOrValue":1}],"prePaymentSchedule":{"initialAmount":1,"maxChargeLimit":1,"minChargeLimit":1},"reviewerMemo":"심사 리뷰어 메모","approvalMemo":"심사 승인자 메모","rejectStatusMemo":"심사 반려 메모"}

HTTP response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 87

{"result":null,"code":"0","message":"요청이 성공적으로 완료되었습니다."}

Path parameters

Table 1. /core/service/api/v1/agents/{agentId}/users/{userId}/advertisers/{advertiserId}/reviewer-decision
Parameter Description

agentId

대행사 UID

userId

회원 UID

advertiserId

광고주 UID

Response body

{"result":null,"code":"0","message":"요청이 성공적으로 완료되었습니다."}

Response fields

Path Type Description Required

code

String

응답 코드

required

message

String

오류 메시지

required

result

Null

결과

required

36. 광고주 동의 이메일, 문자발송(SAG037)

HTTP request

POST /core/service/api/v1/agents/1/users/1/advertisers/1/send-agree-notification HTTP/1.1
Content-Type: application/json
Host: localhost:8080

HTTP response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 87

{"result":null,"code":"0","message":"요청이 성공적으로 완료되었습니다."}

Path parameters

Table 1. /core/service/api/v1/agents/{agentId}/users/{userId}/advertisers/{advertiserId}/send-agree-notification
Parameter Description

agentId

대행사 UID

userId

사용자 UID

advertiserId

광고주 UID

Response body

{"result":null,"code":"0","message":"요청이 성공적으로 완료되었습니다."}

Response fields

Path Type Description Required

code

String

응답 코드

required

message

String

오류 메시지

required

result

Null

결과

required

메뉴

메뉴 API 목록

1. 메뉴 조회 API (MU001)

HTTP request

GET /core/api/v1/menus HTTP/1.1
Content-Type: application/json
Host: localhost:8080

HTTP response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 459

{"result":[{"menuId":1,"parentId":1,"name":"메뉴 이름","displayOrder":1,"registerDt":"2025-06-27T12:13:51.766205448","children":[{"menuId":2,"parentId":1,"name":"자식 메뉴1","displayOrder":1,"registerDt":"2025-06-27T12:13:51.76616884","children":[]},{"menuId":3,"parentId":1,"name":"자식 메뉴2","displayOrder":2,"registerDt":"2025-06-27T12:13:51.766196742","children":[]}]}],"code":"0","message":"요청이 성공적으로 완료되었습니다."}

Response body

{"result":[{"menuId":1,"parentId":1,"name":"메뉴 이름","displayOrder":1,"registerDt":"2025-06-27T12:13:51.766205448","children":[{"menuId":2,"parentId":1,"name":"자식 메뉴1","displayOrder":1,"registerDt":"2025-06-27T12:13:51.76616884","children":[]},{"menuId":3,"parentId":1,"name":"자식 메뉴2","displayOrder":2,"registerDt":"2025-06-27T12:13:51.766196742","children":[]}]}],"code":"0","message":"요청이 성공적으로 완료되었습니다."}

Response fields

Path Type Description Required

code

String

응답 코드

required

message

String

오류 메시지

required

result[].menuId

Number

메뉴 UID

required

result[].parentId

Number

부모 메뉴 UID

optional

result[].name

String

메뉴 이름

required

result[].displayOrder

Number

메뉴 보여져야 하는 순서

required

result[].registerDt

String

메뉴 생성시간

required

result[].children[].menuId

Number

메뉴 UID

required

result[].children[].parentId

Number

부모 메뉴 UID

required

result[].children[].name

String

메뉴 이름

required

result[].children[].displayOrder

Number

메뉴 보여져야 하는 순서

required

result[].children[].registerDt

String

메뉴 생성시간

required

result[].children[].children[]

Array

하위 메뉴 정보

required

광고주

공통 광고주 API 목록

1. 광고주 메일 인증 여부 조회(AD001)

HTTP request

GET /core/api/v1/advertisers/1/mail-verifications?advertiserCode=%EC%9D%B8%EC%A6%9D%EC%BD%94%EB%93%9C HTTP/1.1
Content-Type: application/json
Host: localhost:8080

HTTP response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 87

{"result":true,"code":"0","message":"요청이 성공적으로 완료되었습니다."}

Path parameters

Table 1. /core/api/v1/advertisers/{advertiserId}/mail-verifications
Parameter Description

advertiserId

광고주 UID

Query parameters

Parameter Description Required

advertiserCode

광고주 인증코드

required

Response body

{"result":true,"code":"0","message":"요청이 성공적으로 완료되었습니다."}

Response fields

Path Type Description Required

code

String

응답 코드

required

message

String

오류 메시지

required

result

Boolean

true : 인증 완료, false : 인증미완료

required

2. 광고주 은행 계좌 등록 및 운영 제출(AD002)

HTTP request

POST /core/api/v1/advertisers/1/register-account HTTP/1.1
Content-Type: application/json
Content-Length: 131
Host: localhost:8080

{"accounts":[{"bankCode":"002","bankCodeName":"국민은행","bankNumber":"1111111111111","name":"예금주명","type":"DEPOSIT"}]}

HTTP response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 87

{"result":null,"code":"0","message":"요청이 성공적으로 완료되었습니다."}

Request body

{"accounts":[{"bankCode":"002","bankCodeName":"국민은행","bankNumber":"1111111111111","name":"예금주명","type":"DEPOSIT"}]}

Request fields

Path Type Description Required

accounts[].bankCode

String

BANK_002 BANK_003 BANK_004 BANK_007 BANK_011 BANK_012 BANK_020 BANK_023 BANK_027 BANK_031 BANK_032 BANK_034 BANK_035 BANK_037 BANK_039 BANK_045 BANK_048 BANK_050 BANK_052 BANK_054 BANK_055 BANK_057 BANK_058 BANK_059 BANK_060 BANK_061 BANK_062 BANK_063 BANK_064 BANK_065 BANK_066 BANK_067 BANK_071 BANK_081 BANK_088 BANK_089 BANK_090 BANK_092 BANK_209 BANK_218 BANK_238 BANK_240 BANK_243 BANK_247 BANK_261 BANK_262 BANK_263 BANK_264 BANK_265 BANK_266 BANK_267 BANK_269 BANK_270 BANK_278 BANK_279 BANK_280 BANK_287 BANK_288 BANK_290 BANK_291 BANK_292 BANK_293 BANK_294

required

accounts[].bankCodeName

String

은행 이름

required

accounts[].bankNumber

String

1111111111

required

accounts[].name

String

예금주명

required

accounts[].type

String

DEPOSIT WITHDRAW

required

Response body

{"result":null,"code":"0","message":"요청이 성공적으로 완료되었습니다."}

Response fields

Path Type Description Required

code

String

응답 코드

required

message

String

오류 메시지

required

result

Null

결과

required

은행

공통 은행 API 목록

1. 은행 리스트 전체 조회(AC001)

HTTP request

GET /core/api/v1/accounts/all HTTP/1.1
Content-Type: application/json
Host: localhost:8080

HTTP response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 139

{"result":[{"accountId":1,"bankCode":"003","name":"국민은행"}],"code":"0","message":"요청이 성공적으로 완료되었습니다."}

Response body

{"result":[{"accountId":1,"bankCode":"003","name":"국민은행"}],"code":"0","message":"요청이 성공적으로 완료되었습니다."}

Response fields

Path Type Description Required

code

String

응답 코드

required

message

String

오류 메시지

required

result[].accountId

Number

은행 UID

required

result[].bankCode

String

002 003 004 007 011 012 020 023 027 031 032 034 035 037 039 045 048 050 052 054 055 057 058 059 060 061 062 063 064 065 066 067 071 081 088 089 090 092 209 218 238 240 243 247 261 262 263 264 265 266 267 269 270 278 279 280 287 288 290 291 292 293 294

required

result[].name

String

산업은행 기업은행 KB국민은행 수협은행 NH농협은행 농ㆍ축협 우리은행 SC제일은행 한국씨티은행 대구은행 부산은행 광주은행 제주은행 전북은행 경남은행 새마을금고 신협 저축은행 모건스탠리은행 HSBC은행 도이치은행 제이피모간체이스은행 미즈호은행 엠유에프지은행 BOA은행 비엔피파리바은행 중국공상은행 중국은행 산림조합중앙회 대화은행 교통은행 중국건설은행 우체국 하나은행 신한은행 케이뱅크 카카오뱅크 토스뱅크 유안타증권 KB증권 미래에셋대우 삼성증권 한국투자증권 NH투자증권 교보증권 하이투자증권 현대차증권 키움증권 이베스트투자증권 SK증권 대신증권 한화투자증권 하나금융투자 신한금융투자 DB금융투자 유진투자증권 메리츠증권 카카오페이증권 부국증권 신영증권 케이프투자증권 한국증권금융 한국포스증권

required

2. 은행 실명 인증 요청(AC002)

HTTP request

GET /core/api/v1/accounts/certification HTTP/1.1
Content-Type: application/json
Content-Length: 95
Host: localhost:8080

{"advertiserId":1,"bankCode":"004","accountNumber":"111111111111","accountName":"예금주명"}

HTTP response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 86

{"result":null,"code":"1002","message":"지원하지 않는 HTTP 메소드입니다."}

Request body

{"advertiserId":1,"bankCode":"004","accountNumber":"111111111111","accountName":"예금주명"}

Request fields

Path Type Description Required

advertiserId

Number

광고주 UID

required

bankCode

String

002 003 004 007 011 012 020 023 027 031 032 034 035 037 039 045 048 050 052 054 055 057 058 059 060 061 062 063 064 065 066 067 071 081 088 089 090 092 209 218 238 240 243 247 261 262 263 264 265 266 267 269 270 278 279 280 287 288 290 291 292 293 294

required

accountNumber

String

광고주 계좌번호

required

accountName

String

광고주 예금주

required

Response body

{"result":null,"code":"1002","message":"지원하지 않는 HTTP 메소드입니다."}

Response fields

Path Type Description Required

code

String

응답 코드

required

message

String

오류 메시지

required

result

Null

true : 실명인증 완료 , false : 실명인증 실패

required