콘텐츠로 이동
EasterAdEasterAdDocs

개요

EasterAd Core API는 대시보드 콘솔과 동일한 백엔드 기능을 프로그래밍 방식으로 제어할 수 있는 RESTful API입니다. API 키를 활용하여 게임 및 캠페인 관리, 지갑 잔액 조회, 충전 이력 수집, 성과 리포트 연동 등 다양한 사내 자동화 시스템 및 회계 대사(Reconciliation) 파이프라인을 구축할 수 있습니다.

1. Base URL 및 통신 규약

섹션 제목: “1. Base URL 및 통신 규약”

모든 Core API 요청은 보안 HTTPS 프로토콜을 통해서만 전송할 수 있습니다.

  • Base URL: https://www.easterad.com
  • 엔드포인트 경로 구조: 모든 리소스는 /api/core/... 하위에 배치되며, 대부분 특정 조직에 종속된 /api/core/organization/{organizationId}/... 형태의 계층 구조를 갖습니다.
  • 데이터 포맷: 일반 요청 본문과 응답은 application/json을 사용합니다. 파일 업로드는 multipart/form-data 예외이며 응답은 JSON입니다.
  • 인증 방식: HTTP 표준 Authorization: Bearer <API_KEY> 헤더를 사용합니다.

2. 5분 안에 첫 API 호출 완료하기

섹션 제목: “2. 5분 안에 첫 API 호출 완료하기”

가장 안전하고 빠른 첫 호출 절차를 안내합니다.

flowchart LR
    A["1. API 키 발급 (조회 권한)"] --> B["2. 조직 목록 호출 (인증 확인)"]
    B --> C["3. 지갑 잔액 호출 (비즈니스 연동)"]

1단계: API 키 및 조직 ID 준비

섹션 제목: “1단계: API 키 및 조직 ID 준비”

  1. EasterAd 콘솔에 로그인한 뒤 조직 설정 → 멤버 관리 → API 키 탭으로 이동합니다.

  2. 새 API 키를 생성하고 안전한 조회 전용 역할(예: Viewer)을 부여합니다.

  3. 콘솔의 조직 설정 → 조직 정보에서 24자리 조직 ID를 확인합니다.

2단계: 인증 테스트 (내 조직 목록 조회)

섹션 제목: “2단계: 인증 테스트 (내 조직 목록 조회)”

권한 요구사항이 가장 낮은 조직 목록 엔드포인트를 호출하여 API 키가 정상 작동하는지 확인합니다.

터미널 창
curl -X GET "https://www.easterad.com/api/core/organization" \
  -H "Authorization: Bearer ea_xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx_****************" \
  -H "Accept: application/json"

HTTP 200 OK와 함께 속한 조직 목록이 JSON 배열로 반환되면 인증이 성공한 것입니다.

3단계: 비즈니스 데이터 조회 (지갑 잔액 확인)

섹션 제목: “3단계: 비즈니스 데이터 조회 (지갑 잔액 확인)”

확인한 조직 ID(organizationId)를 경로에 넣어 잔액 엔드포인트를 호출해 봅니다.

터미널 창
curl -X GET "https://www.easterad.com/api/core/organization/{organizationId}/balance" \
  -H "Authorization: Bearer ea_xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx_****************" \
  -H "Accept: application/json"
{
  "balance": 100000,
  "balanceSpent": 250000,
  "cur": "CURRENCY_KRW"
}
  • balance: 집행 가능한 현재 잔여 예산입니다.
  • balanceSpent: 현재까지 소진된 총 누적 집행 금액입니다.
  • cur: 기본 통화 단위입니다 (CURRENCY_KRW 또는 CURRENCY_USD).

3. API 가이드 로드맵

섹션 제목: “3. API 가이드 로드맵”

Core API를 안전하고 효과적으로 연동하기 위해 아래 가이드를 참고하세요.