Shoplive Shortform API 사용하기

Shoplive에서는 Shortform 데이터를 검색하고 조회할 수 있는 HTTP API를 제공하고 있습니다. 이 API를 사용하여 고객사가 원하는 미리보기나 피드 UI를 직접 구현할 수 있고, 다양한 customization을 진행할 수 있습니다.

Shoplive의 Shortform API를 사용하기 위해서는 아래의 정보를 미리 확인하시기 바랍니다.

Shortform object (sample)

{
    "shortformId" : "123456789012345678",
    "createdAt" : "2023-12-25T08:00:00Z", 
    "updatedAt" : "2023-12-26T08:00:00Z",
    "status" : "OPEN",
    "details" : {
      "title" : "Shortform Title",
      "description" : "This is a sample description",
      "brand" : {
        "id" : 123,
        "identifier" : "shoplive", 
        "name" : "Shoplive",
        "imageUrl" : "https://image.shoplive.cloud/brand-image.png"
      },
      "tags" : [ "food", "snack" ],
      "productCount" : 3,
      "productBanner" : {
        "title" : "Product Banner Title",
        "imageUrl" : "https://image.shoplive.cloud/product-banner-image.png",
        "scheme": "https://www.shoplive.cloud/product" 
      },
      "products" : [ {
        "productId" : 54321,
        "name" : "Shoelive T-shirts",
        "brand" : "Shoplive Brand",
        "url" : "https://shoplivedemo.com/product/54321",
        "sku" : "sku001",
        "imageUrl" : "https://image.shoplive.cloud/product-image.png",
        "currency" : "KRW",
        "showPrice" : true,
        "originalPrice" : 3400.0,
        "discountPrice" : 2500.0,
        "discountRate" : 26.0,
        "stockStatus" : "IN_STOCK"
      } ]
    },
    "activity" : {
      "viewCount" : 2345,
      "likeCount" : 123,
      "commentCount" : 123,
      "bookmarkCount" : 123,
			"shareCount" : 321
    },
    "video" : [ {
      "duration" : 3600,
      "videoId" : "1234",
      "videoUrl" : "https://resource.shoplive.cloud/video/shortsform/video.m3u8",
      "previewVideoUrl" : "https://resource.shoplive.cloud/video/shortsform/previewVideo.m3u8",
      "screenshotUrl" : "https://image.shoplive.cloud/shortform/screenshot.png"
    } ],
}

현재 Shortform API는 제한된 고객사에게만 서비스되고 있습니다. Shortform API의 사용에 대한 안내가 필요하시면 [email protected]로 문의를 주시기 바랍니다.

2023년 8월 현재 Shortform API에서는 조회와 검색 기능만 제공하고 있습니다. 2023년 하반기 중에 숏폼의 생성과 관리를 위한 추가적인 API를 제공할 계획을 가지고 있습니다. 구체적인 API의 사용 방법은 이 가이드 문서를 통해 계속 업데이트할 예정입니다.