> For the complete documentation index, see [llms.txt](https://help.citrusad.com/retail-media-interface/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.citrusad.com/retail-media-interface/integration/ko/data-api/api-overview.md). # API 개요 ## 어떻게 Epsilon Retail Media 작동하나요? API는 REST를 중심으로 구성되어 있습니다. API는 예측 가능한 리소스 지향 URL을 제공하며 HTTP 응답 코드를 사용하여 API 오류를 나타냅니다. API는 기성 HTTP 클라이언트가 이해할 수 있는 HTTP 인증 및 HTTP 메서드(HTTP verbs)를 포함한 기본 HTTP 기능을 사용합니다. API 인증은 API 키 사용을 통해 관리됩니다. API 키는 백엔드와 API 간의 통신 중에 사용됩니다. Integration API는 광고를 생성하는 데 사용되는 상품, 카탈로그, 고객 및 주문 데이터의 업로드를 지원합니다. Integration API를 사용하여 광고를 요청하고 해당 광고와의 상호작용에 대해 리포팅할 수 있습니다. ## 통합 엔드포인트 Epsilon Retail Media 에서는 다양한 엔드포인트를 사용하여 데이터를 동기화하고 광고를 생성합니다. 간략한 요약은 아래와 같습니다. | 엔드포인트 | 용도 | 설명 | | ------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | | `catalogs` | [Syncing catalog via API](/retail-media-interface/integration/ko/data-api/catalog-products-2/syncing-catalog-via-api.md) | API를 통해 카탈로그를 생성하는 데 사용됩니다. 단일 카탈로그 네임스페이스의 경우 기술 어카운트 매니저가 이를 준비해 드릴 수 있습니다. | | `catalog-products` | [Syncing products via API](/retail-media-interface/integration/ko/data-api/catalog-products-2/syncing-products-via-api.md) | 카탈로그 내의 상품 데이터를 생성하고 업데이트하는 데 사용됩니다. | | `customers` | [Syncing customer data via API](/retail-media-interface/integration/ko/data-api/customer-data/syncing-customer-data-via-api-1.md) | 카탈로그 내의 고객 데이터를 생성하고 업데이트하는 데 사용됩니다. | | `orders` | [Syncing order data via API](/retail-media-interface/integration/ko/data-api/order-data-1/syncing-order-data-via-api.md) | 주문 데이터를 전송하는 데 사용됩니다. | | `/resource/` | [Reporting impressions & clicks](/retail-media-interface/integration/ko/data-api/api-overview/reporting-impressions-clicks.md) [Syncing order data via API](/retail-media-interface/integration/ko/data-api/order-data-1/syncing-order-data-via-api.md) | 클릭 및 노출수뿐만 아니라 프론트엔드를 통해 리포팅하는 경우 주문을 리포팅하는 데 사용됩니다. | | `/ads/generate` | 광고 생성 | 상품 광고 및 배너 광고를 생성하는 데 사용됩니다. | | `/ads/bannerx` | 광고 생성 | 배너 x 광고를 생성하는 데 사용됩니다. | {% hint style="info" %} 카탈로그, 상품, 고객 및 주문 동기화를 위해 엔드포인트를 사용할 필요가 없습니다. Epsilon Retail Media 은(는) 파일을 통한 데이터 동기화를 지원하므로 귀하의 요구 사항에 적합할 수 있습니다. {% endhint %} ## 콘텐츠 유형 및 페이로드 데이터 페이로드는 JSON 형식입니다. `Content-Type` 의 이러한 엔드포인트는 `application/json`이며, 다음과 같이 요청의 헤더로 전달되어야 합니다. ``` -H "Content-Type: application/json" \ ``` ## 요청 인증 ### 기본 인증 모든 연동 리소스는 기본 인증을 사용하며, 다음과 같이 API 키와 함께 헤더로 전달되어야 합니다. ``` -H "Authorization: Basic 4ww25f70-b52s-40de-8f29-07b139b5cdc8" \ ``` API 키는 리테일러 팀의 연동 설정 섹션에서 확인할 수 있습니다. 시크릿 API 키만 있으면 됩니다. ### OAuth2.0 인증 Epsilon Retail Media의 광고 생성 엔드포인트는 OAuth2.0과 추가로 호환됩니다. 검토하십시오 [OAuth 2.0 인증](/retail-media-interface/integration/ko/data-api/api-overview/oauth-20-authentication.md) 자세한 정보는 다음을 참조하십시오. ## 기본 URL Epsilon Retail Media 은 스테이징 및 운영 환경에 서로 다른 기본 URL을 사용합니다. {% hint style="info" %} 스테이징 기본 URL을 받으려면 다음으로 문의하십시오 Epsilon Retail Media. 연동이 진행되면 운영 기본 URL을 제공해 드립니다. {% endhint %} --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://help.citrusad.com/retail-media-interface/integration/ko/data-api/api-overview.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.