JavaScript SDK API 참조 javascript-sdk-api-reference

API 참조 api-reference

이러한 기능은 MVPD와의 상호 작용 요청을 시작합니다. 모든 호출은 비동기입니다. 응답을 처리하려면 콜백을(를) 구현해야 합니다.

setRequestor(inRequestorID, endpoints, options) setrequestor(inRequestorID,endpoints,options)

설명: 요청이 시작된 사이트를 식별합니다. 통신 세션에서 다른 API 호출 전에 이 호출을 수행해야 합니다.

매개 변수:

   setRequestor("IFC", {
      "visitorID": "THE_ECID_VALUE",
      "applicationId": "APP_ID_VALUE"
  })

    {
       "visitorID": <string>,
       "backgroundLogin": <boolean>,
       "backgroundLogout": <boolean>,
       "mvpdConfig":{
          "MVPD_ID_1":{
             "iFrameRequired": <boolean>,
             "iFrameWidth": <integer>,
             "iFrameHeight": <integer>
          },
          ...
          "MVPD_ID_N":{
             "iFrameRequired": <boolean>,
             "iFrameWidth": <integer>,
             "iFrameHeight": <integer>
          }
       }
    }

위의 템플릿의 모든 최상위 키는 선택 사항이며 기본값이 있습니다(backgroundLogin, backgroundLogut ​은(는) 기본적으로 false이며, mvpdConfig가 null입니다. 즉, MVPD 설정이 재정의되지 않습니다.).

다음은 새로 고침 없는 로그인 및 로그아웃을 활성화하고, MVPD1을 전체 페이지 리디렉션 로그인(iFrame 아님)으로 변경하고, MVPD2를 iFrame으로 로그인하여 너비=500 및 높이=300인 시나리오에 대한 예제 구성입니다.

    {
       "backgroundLogin": true,
       "backgroundLogout": true,
       "mvpdConfig":{
          "MVPD1":{
             "iFrameRequired": false
          },
          "MVPD2":{
             "iFrameRequired": true,
             "iFrameWidth": 500,
             "iFrameHeight": 300
          }
       }
    }

트리거된 콜백: setConfig()

맨 위로 돌아가기

getAuthorization(inResourceID, redirect_url) getauthorization(inresourceid,redirect_url)

설명: 지정한 리소스에 대한 권한 부여를 요청합니다. 고객이 승인 가능 리소스에 액세스할 때마다 이 함수를 호출하여 Access Enabler에서 단기 인증 토큰을 얻습니다. 리소스 ID는 인증을 제공하는 MVPD와 동의합니다.

현재 고객에 대해 캐시된 인증 토큰을 사용합니다. 해당 토큰이 없으면 먼저 인증 프로세스를 시작한 다음 권한 부여를 계속합니다.

매개 변수:

콜백이 트리거됨: setToken() 성공 시, tokenRequestFailed 실패 시

맨 위로 돌아가기

getAuthentication(redirect_url) getauthentication(redirect_url

설명: ​이(가) 현재 고객에 대한 인증을 요청합니다. 일반적으로 로그인 단추 클릭에 따라 호출됩니다. 현재 고객에 대해 캐시된 인증 토큰을 확인합니다. 해당 토큰이 없으면 가 인증 프로세스를 시작합니다. 기본 또는 사용자 지정 공급자 선택 대화 상자를 호출한 다음 선택한 공급자를 사용하여 MVPD의 로그인 인터페이스로 리디렉션합니다.

성공 시 는 사용자에 대한 인증 토큰을 만들고 저장합니다. 인증이 실패하면 공급자는 setAuthenticationStatus() 콜백에 적절한 오류 메시지를 반환합니다.

매개 변수:

트리거된 콜백: setAuthenticationStatus(), displayProviderDialog(), sendTrackingData()

맨 위로 돌아가기

checkAuthN checkauthn

설명: 현재 고객의 현재 인증 상태를 확인합니다. UI와 연결되어 있지 않습니다.

트리거된 콜백: setAuthenticationStatus()

맨 위로 돌아가기

checkAuthorization(inResourceID) checkauthorization(inresourceid)

설명: 응용 프로그램에서 이 메서드를 사용하여 현재 고객 및 지정된 리소스에 대한 인증 상태를 확인합니다. 먼저 인증 상태를 확인하는 것으로 시작됩니다. 인증되지 않은 경우 tokenRequestFailed() 콜백이 트리거되고 메서드가 종료됩니다. 사용자가 인증되면 권한 부여 플로우도 트리거됩니다. [getAuthorization()] (#getAuthZ 메서드에 대한 자세한 내용을 참조하십시오.

매개 변수:

트리거된 콜백:
setToken(), tokenRequestFailed(), sendTrackingData(), setAuthenticationStatus()

checkPreauthorizedResources(resources) checkPreauthorizedResources(resources)

설명: 목록에 대해 "preflight" 인증 상태를 요청합니다.
리소스.

매개 변수:

checkPreauthorizedResources(resources-cache=true) checkPreauthorizedResources(resources-cache=true)

이 API 변형은 JS SDK 버전 4.0부터 사용할 수 있습니다

매개 변수:

콜백 트리거됨: preauthorizedResources()

맨 위로 돌아가기

getMetadata(키) getMetadata

설명: Access Enabler 라이브러리에서 메타데이터로 노출된 정보를 검색합니다.

메타데이터에는 두 가지 유형이 있습니다.

추가 정보: 사용자 메타데이터

매개 변수:

For example:

    // Assume that a reference to the AccessEnabler has been previously
    // obtained and stored in the "ae" variable

    ae.setRequestor("SITE");
    ae.checkAuthentication();

    function setAuthenticationStatus(status, reason) {
        if (status ==  1) {
            //user is authenticated, request metadata
            ae.getMetadata("zip");
            ae.getMetadata("maxRating");
        } else {
            ...
      }
    }

트리거된 콜백: setMetadataStatus()

맨 위로 돌아가기

setSelectedProvider(providerid) setSelectedProvider

설명: 사용자가 공급자 선택 UI에서 공급자 선택 사항을 Access Enabler로 보내기 위해 MVPD를 선택한 경우 이 함수를 호출하거나 사용자가 공급자를 선택하지 않고 공급자 선택 UI를 해제한 경우 null 매개 변수를 사용하여 이 함수를 호출합니다.

콜백
트리거됨: setAuthenticationStatus(), sendTrackingData()

맨 위로 돌아가기

getSelectedProvider() getSelectedProvider

설명: 공급자 선택 대화 상자에서 고객의 선택 결과를 검색합니다. 초기 인증 확인 후 언제든지 사용할 수 있습니다.

이 함수는 비동기 함수이며 결과를 selectedProvider() 콜백 함수에 반환합니다.

트리거된 콜백: selectedProvider()

맨 위로 돌아가기

로그아웃 logout

설명: 현재 고객을 로그아웃하여 해당 사용자에 대한 모든 인증 및 권한 부여 정보를 지웁니다. 고객 시스템에서 모든 authN 및 authZ 토큰을 삭제합니다.

트리거된 콜백: setAuthenticationStatus()

맨 위로 돌아가기

콜백 정의 calllback-definitions

비동기 요청 호출에 대한 응답을 처리하려면 다음 콜백을 구현해야 합니다.

entitlementLoaded() entitlementLoaded

설명: Access Enabler가 초기화를 완료하고 요청을 받을 준비가 되면 트리거됩니다. 이 콜백을 구현하여 Access Enabler API와의 통신을 시작할 수 있는 시기를 알 수 있습니다.

위로 돌아가기

setConfig(configXML) setconfig(configXML)

설명: 구성 정보 및 MVPD 목록을 받으려면 이 콜백을 구현합니다.

매개 변수:

트리거: setRequestor()

위로 돌아가기

displayProviderDialog(providers) displayproviderdialog(providers)

설명: 이 콜백을 구현하여 사용자 지정 공급자 선택 UI를 호출합니다. 대화 상자에서 디스플레이 이름(및 로고(선택 사항))을 사용하여 고객이 선택할 수 있는 사항을 제공해야 합니다. 고객이 선택을 하고 대화 상자를 무시하면 setSelectedProvider() 호출에서 선택한 공급자에 대한 관련 ID를 보냅니다.

매개 변수:

    var mvpd = {
        ID: "someprov",
        displayName: "Some Provider",
        logoURL: "http://www.someprov.com/images/logo.jpg"
    }

트리거: getAuthentication(), getAuthorization()

맨 위로 돌아가기

createIFrame(inWidth, inHeight) createIFrame(inWidth,inHeight)

설명: 사용자가 인증 로그인 페이지 UI를 표시할 iFrame이 필요한 MVPD를 선택한 경우 이 콜백을 구현합니다.

트리거 주체: ​ setSelectedProvider()

맨 위로 돌아가기

setAuthenticationStatus(isAuthenticated, errorCode) set-authn-status-isauthn-error

설명: 이 콜백을 구현하여 인증 상태(1=인증됨 또는 0=인증되지 않음)와 인증 상태(검사가 완료되면 빈 문자열)를 확인하는 동안 오류가 발생한 경우 설명 오류 메시지를 받습니다.

매개 변수:

트리거: checkAuthentication(), getAuthentication(), checkAuthorization()

위로 돌아가기

sendTrackingData(trackingEventType, trackingData) sendTrackingData(trackingEventType,trackingData)

설명: 특정 이벤트가 발생할 때 추적 데이터를 받으려면 이 콜백을 구현합니다. 예를 들어 동일한 자격 증명으로 로그인한 사용자가 몇 명인지 추적할 수 있습니다. 추적은 현재 구성할 수 없습니다. sendTrackingData()은(는) Adobe Pass 인증 1.6을 사용하여 장치, Access Enabler 클라이언트 및 운영 체제 유형에 대한 정보도 보고합니다. sendTrackingData() 콜백은 이전 버전과 호환되는 상태로 유지됩니다.

이벤트 유형 및 관련 정보 배열을 전달합니다. 이벤트 유형은 다음과 같습니다.

트리거: checkAuthentication(), getAuthentication(), checkAuthorization(), getAuthorization()

위로 돌아가기

setToken(inRequestedResourceID, inToken) setToken(inRequestedResourceID,inToken)

설명: 이 콜백을 구현하여 권한 부여 요청 또는 검사 권한 부여 요청이 만들어지고 성공적으로 완료된 단기 미디어 토큰(inToken)과 리소스의 ID(inRequestedResourceID)를 받습니다.

트리거: checkAuthorization(), getAuthorization()

위로 돌아가기

tokenRequestFailed(inRequestedResourceID, inRequestErrorCode, inRequestDetailedErrorMessage) token-request-failed-error-msg

설명: 권한 부여 또는 검사 권한 부여 요청이 실패할 때 신호를 받으려면 이 콜백을 구현합니다. 프로그래머가 표시할 사용자 지정 메시지를 제공하기 위해 MVPD가 선택적으로 사용할 수 있습니다.

매개 변수:

트리거: checkAuthorization(), getAuthorization()

위로 돌아가기

preauthorizedResources(authorizedResources) preauthorizedResources(authorizedResources)

설명: checkPreauthorizedResources() 호출 후 반환된 승인된 리소스 목록을 제공하는 Access Enabler에 의해 트리거된 콜백입니다.

매개 변수:

트리거: checkPreauthorizedResources()

위로 돌아가기

setMetadataStatus(key, encrypted, data) setMetadataStatus(key,encrypted,data)

설명: getMetadata() 호출을 통해 요청된 메타데이터를 전달하는 Access Enabler에 의해 트리거된 콜백입니다.

추가 정보: 사용자 메타데이터

매개 변수:

    {
        updated: 1334243471,
        encrypted: ["encryptedProp"],
        data: {
            zip: ["12345", "34567"],
            maxrating: {
                "MPAA": "PG-13",
                "VCHIP": "TV-Y",
                "URL": "http://exam.pl/e/manage/ratings"
            },
            householdid: "3456",
            uid: "BgSdasfsdk23/dsaf3+saASesadgfsShggssd=",
            channelID: ["channel-1", "channel-2"]
    }

For example:

    // Implement the setMetadataStatus() callback
    function setMetadataStatus(key, encrypted, data) {
        if (encrypted) {
            //the metadata value is encrypted
            //needs to be decrypted by the programmer
            data = decrypt(data);
        }
        alert(key + "=" + data);
    }

트리거 대상: getMetadata()


맨 위로 돌아가기

selectedProvider(result) selectedProvider(result)

설명: 현재 선택한 MVPD와 result 매개 변수에 래핑된 현재 사용자의 인증 결과를 받으려면 이 콜백을 구현합니다. result 매개 변수는 다음 속성을 가진 개체입니다.

트리거: getSelectedProvider()

위로 돌아가기

콜백 오류 코드 callback-error-codes

맨 위로 돌아가기