한국어 한국어   Englilsh English

.

Skip to end of metadata
Go to start of metadata


Order(구매) 로그를 수집하는 API 입니다. 정상적으로 수집되는 경우는 200 OK라는 코드가 반환됩니다. 요청에 실패할 경우 상황에 따라 4XX 혹은 5XX형태의 에러코드가 반환됩니다.

Resource URL

https://lc.recopick.com/v1/logs/order/:service_id/:uid

(GET/POST v1/logs/order/:service_id/:uid) 

*Native(Hybrid) App에서 행동로그를 업로드 할 경우에는 uid 자리에 반드시 GAID 혹은 IDFA값을 넣어서 업로드 해야 합니다.


Parameters

service_id

(required)

업데이트할 서비스의 id를 의미합니다. 각 서비스 별 service_id는 https://admin.recopick.com/-/setting 환경설정에서 확인하실 수 있습니다.

Example Value : 543

uid

(required)

사용자를 식별할 수 있는 ID를 문자열 형태로 입력합니다.

uid 값을 생성하는 방법은 Client Library APIs 를 참고해주세요.

Example Values : 123456

ref

(required)

사용자가 현재 페이지 이전에 보고 있던 Referrer page URL을 입력합니다. 

Example Values : http://example.com/

url

(required)

현재 보고 있는 페이지의 URL을 입력합니다. 

Example Values : http://example.com/product/detail.html

items

(required)

JSON 형태의 Array 객체로 요청하시면 됩니다. 각각의 객체는 다음과 같은 Key 값을 포함해야 합니다.
  • id (required) : Item의 unique한 ID 정보를 말합니다.
  • count (optional, default is 1) : Item 갯수를 나타냅니다.
  • category (optional, default is null) : Item의 카테고리 정보를 나타냅니다. 
  • total_sales (optional, default is null) : 해당 상품 판매를 통한 총 매출을 나타냅니다. 이 정보를 추가하시면, 추천을 통한 추가 매출 정보를 보여드립니다. 만약 6,000원 상품을 2 개 구매하였다면, total_sales는 12000이 됩니다. 
  • order_no (required, default is null) : 상품 주문번호(구매번호)를 문자열 형태로 입력합니다. 이 정보를 추가하시면 추천을 통한 기여매출 추출시 중복을 제거할 수 있습니다.

item_id는 URL 패턴을 통해 상품 상세 페이지에 접근할 수 있는 값으로 지정해주셔야 합니다.

Example Values : items: [ { id: "ITEM01234", count: 5, order_no: "201511143187710" }, { id: "ITEM12345", order_no: "201511143187711" }, { id: "ITEM23456", count: 1, category: "video", order_no: "201511143187712" }, { id: "ITEM589", count: 2, total_sales: 12000, order_no: "201511143187713" } ]

user

(optional)

사용자의 성별, 연령 등의 데이터를 전송해주시면 각 사용자에게 더욱 특화된 추천을 제공해 드립니다.

JSON Object 객체로 요청하시면 됩니다. 객체에는 다음과 같은 Key를 지정하실 수 있습니다.

    • mid (optional) : 자체적으로 사용하시는 회원ID (개인정보보호를 위해 회원의 아이디를 암호화하여 전송하셔야 합니다.)
    • gender (optional) : 성별 (M: 남자, F: 여자, O: 기타)
    • birthyear (optional) : 출생연도 (예: 1994)

Example Values : user: { mid: "3HR6EFHJ723532FEY3", gender: "F", birthyear: 1989 }

(warning) 주의하세요! 레코픽 추천을 API 방식으로 사용하는 경우, GET방식으로 API를 호출하게 됩니다.
  이 경우 일부 API의 파라미터에 MID가 사용되는데, MID 값에 일부 특수문자(예> &, =) 가 들어가게 되면 정상동작 하지 않을 수 있습니다.
  암호화된 결과에 특수문자가 들어가지 않는 암호화 알고리즘으로 단방향 암호화 해주세요. (예> SHA-256, MD5 등)

* MID 단방향 암호화 예 : 88020d58ceb8a4ad7f6756021fbc06b8a91f17daad2f04a5d369608d9c308bde (SHA-256으로 암호화), 4509bf9373ff3dca193ba02726c87988 (MD5로 암호화)

gaid


Google Advertising ID 입니다.

*Hybrid App에서 행동로그를 업로드 할 경우에는 반드시  GAID(IDFA)값을 넣어야 합니다. 

 

idfa


Apple Advertising Identifier 입니다. 

*Hybrid App에서 행동로그를 업로드 할 경우에는 반드시  GAID(IDFA)값을 넣어야 합니다. 

recoclick

(optional)

사용자가 recopick 추천리스트를 클릭한 경우입니다. 이 파라미터의 값은 recopick에서 제공하는 알고리즘의 종류를 말하며 숫자 형태로 입력하시면 됩니다. 

Example Values : { recoclick : 2 } 

callback

(optional)

callback을 입력하시면 JSONP 형태의 응답을 제공합니다.

Example Values : callback=parseResponse

Example Request


  • XMLHttpRequest를 활용합니다.(jQuery를 활용하는 것을 추천)
  • http://jsfiddle.net 을 통해 테스트를 하시면 됩니다.
  • 주의사항 >
    • POST 방식인 경우, Content-type: application/json으로 해주셔야 합니다.
    • 아래와 같이 jQuery를 사용하여 data 속성을 통해 파라미터값을 전송하는 경우, url과 ref 변수를 별도로 escape 하시면 안됩니다.
    • jQuery 1.5 이상 버전을 사용하시는 분들은 xhrFields 옵션을 필수적으로 사용해야한다. <참고문서 : http://api.jquery.com/jQuery.ajax>


  • 사용자가 서로 다른 카테고리 상품을 구매하는 경우 http://jsfiddle.net/uvzqj0f5/8/

    (function ($) {
        $.ajax({
            url: 'https://lc.recopick.com/v1/logs/order/543/uid123',
            method: 'POST',
            xhrFields: {
                withCredentials: true
            },
            data: {
                url: "https://buy.11st.co.kr/pay/OrderInfoAction.tmall",
                ref: "http://www.11st.co.kr/product/SellerProductDetail.tmall?method=getSellerProductDetail&prdNo=1149328659",
                items: [{
                    id: "1149328659",
                    c1: "브랜드여성의류/언더웨어",
                    c2: "니트/스웨터",
                    c3: "롱니트",
                    count: 2,
                    total_sales: 12000
                }, {
                    id: "1206426563",
                    c1: "브랜드신발/가방/잡화",
                    c2: "여성핸드백/가방",
                    c3: "클러치백/파우치",
                    count: 1,
                    total_sales: 210000,
    				order_no: "201511143187710"
                }],
                user: {
                    gender: "F",
                    birthyear: "1980",
                    mid: "8371920381"
                }
            }
        });
    })(jQuery);

Output

성공시에 200 OK가, 실패 시에는 그에 맞는 4xx나 5xx 에러 코드가 반환됩니다.

  • No labels