CitrusAd는 어떻게 작동하나요?
CitrusAd API는 REST를 중심으로 구성되어 있습니다. API에는 예측 가능한 자원 중심 URL이 있으며, HTTP 응답 코드를 사용하여 API 오류를 나타냅니다. API는 HTTP 인증 및 HTTP 동사 등의 내장 HTTP 기능을 사용하며, 이 기능은 재고 HTTP 클라이언트를 통해 인식됩니다.
CitrusAd API에 대한 인증은 API 키를 통해 관리됩니다. API 키는 백엔드와 CitrusAd API 사이 통신 중에 사용됩니다.
CitrusAd API는 광고를 생성하는 데 사용되는 제품, 카탈로그, 고객 및 주문 데이터의 업로드를 지원합니다. CitrusAd API를 사용하여 광고를 요청하고 이러한 광고와의 상호작용을 보고할 수 있습니다.
CitrusAd 엔드포인트
CitrusAd는 다양한 엔드포인트를 사용하여 데이터를 동기화하고 광고를 생성합니다. 간단한 요약 내용이 아래에 있습니다.
| 엔드포인트 | 사용 | 설명 |
|---|---|---|
catalogs | API를 통한 카탈로그 동기화 | API를 통해 카탈로그를 작성하는 데 사용됩니다. 단일 카탈로그 네임스페이스의 경우 이는 기술 계정 관리자가 사용자를 위해 조직할 수 있는 대상입니다. |
catalog-products | API를 통한 제품 동기화 | 카탈로그 내에서 제품 데이터를 작성하고 업데이트하는 데 사용됩니다. |
customers | API를 통한 고객 데이터 동기화 | 카탈로그 내에서 고객 데이터를 작성하고 업데이트하는 데 사용됩니다. |
orders | API를 통한 주문 데이터 동기화 | 주문 데이터를 CitrusAd에 전송하는 데 사용됩니다. |
/resource/ | 클릭 및 노출 수 보고, API를 통한 주문 데이터 동기화 | 프론트엔드를 통해 보고하는 경우 주문은 물론 클릭 수 및 노출 수를 보고하는 데 사용됩니다. |
/ads/generate | 광고 생성 | 제품 광고 및 배너 광고를 생성하는 데 사용됩니다. |
/ads/bannerx | 광고 생성 | 배너 x 광고를 생성하는 데 사용됩니다. |
카탈로그, 제품, 고객 및 주문 동기화에는 엔드포인트를 사용할 필요가 없습니다. CitrusAd는 파일을 통한 데이터 동기화를 지원하며, 이는 사용자의 요구 사항에 적합할 수 있습니다.
콘텐츠 유형 및 페이로드
데이터 페이로드는 JSON 형식입니다. 다음 Content-Type 은 application/json입니다. 이러한 엔드포인트에 대해 적용되며 다음과 같이 요청에서 헤더로 전달되어야 합니다.
-H "Content-Type: application/json" \
요청 인증
기본 인증
모든 통합 자원은 다음과 같이 API 키와 함께 헤더로 전달되어야 하는 기본 인증을 사용합니다.
-H "Authorization: Basic 4ww25f70-b52s-40de-8f29-07b139b5cdc8" \
사용자의 API 키는 소매업체 팀의 통합 설정 섹션에서 액세스할 수 있습니다. 비밀 API 키만 있으면 됩니다.
OAuth 2.0 인증
CitrusAd의 광고 생성 엔드포인트는 OAuth2.0과 추가로 호환됩니다. 자세한 정보는 OAuth 2.0 인증을 검토하십시오.
기본 URL
CitrusAd는 단계별 및 제작 환경별로 서로 다른 기본 URL을 사용합니다.
단계 기반 URL을 수신하려면 CitrusAd에 문의하십시오. 통합이 진행 중이면 제품 기반 URL이 제공됩니다.