데이터 고지

k-ID API를 사용하여 사용자 정의 VPC 흐름을 구축할 때 데이터 고지 위젯을 사용하여 제품 데이터 고지를 표시하고 사용자 동의를 수집할 수 있습니다. 위젯은 관할권에 적절한 공개를 표시하고 동의 수락 워크플로를 처리합니다.

데이터 고지에 대한 일반 정보(필요한 경우 및 저장되는 데이터 포함)는 핵심 개념 섹션의 데이터 고지를 참조하세요.

데이터 고지 위젯 URL 생성

/widget/generate-direct-notices-url API를 호출하여 데이터 고지 위젯 URL을 만듭니다. 이것은 사용자가 데이터 고지를 보고 수락할 수 있는 고유 URL을 반환합니다.

요청 예시

POST /api/v1/widget/generate-direct-notices-url
Content-Type: application/json
Authorization: Bearer your-api-key

{
  "jurisdiction": "US-CA",
  "sessionId": "608616da-4fd2-4742-82bf-ec1d4ffd8187"
}

요청 매개변수

속성	설명	필수?
`jurisdiction`	데이터 고지가 표시되어야 하는 관할권	예
`sessionId`	플레이어의 세션 ID(사용 가능한 경우)	아니오

응답 예시

{
  "id": "7854909b-9124-4bed-9282-24b44c4a3c97",
  "url": "https://family.k-id.com/widget?token=eyJhbGciOiJFUzM4NCIs..."
}

위젯 포함

반환된 URL을 사용하여 웹사이트나 앱에 iframe을 만듭니다. 사용자는 이 인터페이스를 통해 데이터 고지를 보고 동의를 제공합니다:

<iframe 
  src="WIDGET_URL" 
  width="100%" 
  height="600"
  frameborder="0">
</iframe>

동의 결과 받기

데이터 고지 동의는 세션의 일부로 추적됩니다. 데이터 고지가 수락되면 동의가 세션에 기록됩니다. /session/get API를 호출하여 세션에서 데이터 고지 동의 상태를 확인할 수 있습니다.

실시간 업데이트를 위해 세션 관련 이벤트도 수신할 수 있습니다:

JavaScript 이벤트(클라이언트 측)

이벤트 구조에 대한 자세한 내용은 Widget.DataNotices.ConsentApproved를 참조하세요.

데이터 고지 위젯이 iframe에 포함된 경우 위젯의 창 메시지를 수신할 수 있습니다:

window.addEventListener('message', (event) => {
  if (!event.origin.endsWith('.k-id.com')) {
    return;
  }
  
  const message = event.data;
  
  // 위젯 완료 이벤트 처리
  if (message.eventType === 'Widget.DataNotices.ConsentApproved') {
    // 데이터 고지가 수락됨
    console.log('Data notices accepted:', message.data.jurisdiction);
    handleConsentAccepted();
  }
});

이벤트 예시:

{
  "eventType": "Widget.DataNotices.ConsentApproved",
  "data": {
    "jurisdiction": "US"
  }
}

웹훅(서버 측)

웹훅 이벤트 구조에 대한 자세한 내용은 Session.ChangePermissions를 참조하세요.

세션 관련 이벤트를 받을 웹훅 엔드포인트를 구성합니다. 데이터 고지 동의가 업데이트되면 세션 변경 사항이 Session.ChangePermissions 이벤트에 반영됩니다. 자세한 내용은 웹훅을 참조하세요.