📘

OAuth 2.0은 /ads 엔드포인트에서만 사용할 수 있습니다

API를 통해 주문 보고를 통합하는 경우 /orders 엔드포인트를 기본 인증 및 비밀 API 키와 통합해야 합니다.

클라이언트 ID 및 클라이언트 시크릿

다음 client_id 및 client_secret 기술 계정 관리자가 제공합니다. 클라이언트 시크릿은 개인용이므로 공유할 수 없습니다.

액세스 토큰 요청

액세스 토큰을 얻으려면 다음을 포함하는 요청을 보내야 합니다. client_id 및 client_secret. 이를 수행하려면 소매업체가 CitrusAd 인증 서버 엔드포인트에 대한 POST 요청을 작성해야 합니다.

https://$BASE_URL/v1/oauth2/token

📘

/oauth2/token 관련 토큰만 제공됩니다. 귀하는 이러한 토큰을 사용하여 다양한 통합 엔드포인트와 상호 작용할 수 있습니다.

요청 시 다음을 포함하는 인증 요청 헤더를 통해 전송된 기본 인증이 필요합니다. client_id 및 client_secret base64 인코딩:

Authorization: "Basic" + base64encode(client_id + ":" + client_secret)

다음을 사용하여 다음 매개 변수를 추가해야 합니다. application/x-www-form-urlencoded HTTP 요청 본문 형식:

grant_type=client_credentials

요청은 다음과 같습니다.

POST https://$BASE_URL/v1/oauth2/token
Content-Type: application/x-www-form-urlencoded
Authorization: Basic <base64 encoded id+key>
grant_type=client_credentials

액세스 토큰 수신

응답에는 다음과 같은 정보가 포함됩니다.

• access_token: CitrusAd API 호출 시 사용할 액세스 토큰
• expires_in: 액세스 토큰이 만료될 때까지의 시간(초)
• token_type: 반환된 토큰의 유형입니다. 이 경우에는 항상 전달자입니다

샘플 응답은 다음과 같습니다.

{
  "access_token": "xxxxx.yyyyy.zzzzz",
  "expires_in": 3600,
  "token_type": "Bearer"
}

토큰 사용하기

CitrusAd API 엔드포인트에 대한 호출은 요청에 대한 권한 헤더에 액세스 토큰을 간단히 추가하여 수행할 수 있습니다.
Authorization: “Bearer “ <access_token>

POST $BASE_URL/v1/ads/generate HTTP/1.1
accept: application/json
content-type: application/json
Authorization: Bearer <access_token>
{
    "customerId": "wertg5432a",
    "sessionId": "ec9-4e07-881d-3e9", 
    "placement": "category",
    "catalogId": "628dbe95-2ec9-4e07-881d-3e9f92ab2e0b",
    "productFilters": [
         ["category:Cupboard/Snacks"]
    ],
    "options": {
                             "filterMode": "AndOr"
                             },
    "maxNumberOfAds": 3
}

요청 오류

유효하지 않은 클라이언트

만약 요청에서 전송된 client_id 또는 client_secret 이 올바르지 않은 경우 다음과 같은 응답을 받게 됩니다.

{
  "error": "invalid_client"
}

올바른 자격 증명을 사용하고 있는지 확인하십시오. 다음을 다시 한 번 확인하십시오. client_id 및 client_secret 또한 /token 엔드포인트 호출 시 기본 인증을 올바르게 사용하고 있는지 확인하십시오.
##Invalid Request
요청에 필수 매개변수가 누락되었거나 잘못된 매개 변수 값을 포함하거나 매개 변수가 두 번 이상 포함되었거나 형식이 잘못된 경우 인증 서버에서 잘못된 요청 오류가 반환됩니다.

{
  "error": "invalid_request"
}

다음을 수행하십시오.

• 요청 본문에 grant_type=client_credentials 를 포함합니다
• 요청 헤더에 Content-Type 을 정확히 설정합니다