API 개요
k-ID API는 k-ID와 상호 작용하기 위한 HTTP RPC 스타일 웹 API입니다. Verifiable Parental Consent (VPC) 시작, 연령 확인 시작 및 플레이어에 대한 활성화된 권한 가져오기를 위한 메서드를 제공합니다.
API 구조
k-ID API는 HTTP RPC 스타일 메서드의 컬렉션입니다. 모든 URL은 https://{host}/api/v1/{method} 형식입니다. REST API는 아니지만 REST에 익숙한 사람들은 HTTP 기반에 익숙할 것입니다. 모든 API 메서드는 API에 부작용이 있는지 여부에 따라 GET 또는 POST HTTP 메서드를 사용합니다.
인수는 GET 메서드의 경우 쿼리 매개변수로, POST 메서드의 경우 요청 본문의 JSON으로 전달됩니다. 모든 응답은 JSON 형식입니다.
기본 URL
라이브 모드:
https://game-api.k-id.com/api/v1/
테스트 모드:
https://game-api.test.k-id.com/api/v1/
엔드포인트
연령 게이트
| 엔드포인트 | 설명 |
|---|---|
/age-gate/get-requirements | 관할권에 대한 연령 게이트 요구 사항 가져오기 |
/age-gate/check-age-category | 플레이어의 연령 카테고리 확인 |
/age-gate/check | 연령 확인 및 세션 생성 또는 업데이트 |
/age-gate/get-default-permissions | 관할권에 대한 기본 권한 가져오기 |
세션
| 엔드포인트 | 설명 |
|---|---|
/session/get | 세션 ID 또는 kuid로 세션 가져오기 |
/session/upgrade | 세션 권한 업그레이드 |
/session/update-jurisdiction | 세션 관할권 업데이트 |
/session/set-guardian-managed-session-permissions | 보호자 관리 세션 권한 설정 |
/session/unlink-parent | 세션에서 부모 링크 해제 |
Challenge
| 엔드포인트 | 설명 |
|---|---|
/challenge/get | Challenge 세부 정보 가져오기 |
/challenge/get-status | Challenge 상태 가져오기 |
/challenge/send-email | Challenge 이메일 알림 보내기 |
/challenge/generate-otp | Challenge용 일회용 비밀번호 생성 |
/challenge/invite-parent | 부모 초대 Challenge 생성 |
/challenge/cancel-invite | 부모 초대 취소 |
연령 확인
| 엔드포인트 | 설명 |
|---|---|
/age-verification/perform-facial-age-estimation | 얼굴 연령 추정 확인 수행 |
/age-verification/perform-id-verification | ID 문서 확인 수행 |
/age-verification/perform-age-key-verification | AgeKey 확인 수행 |
/age-verification/perform-connect-id-verification | ConnectID 확인 수행 |
/age-verification/perform-credit-card-verification | 신용카드 확인 수행 |
/age-verification/perform-trusted-adult-verification | 신뢰할 수 있는 성인 확인 수행 |
/age-verification/perform-access-age-verification | 모든 방법으로 액세스 연령 확인 수행 |
/age-verification/perform-age-appeal | 연령 항소 확인 수행 |
/age-verification/perform-custom-age-verification | 사용자 정의 연령 확인 수행 |
/age-verification/get-status | 연령 확인 상태 가져오기 |
위젯
| 엔드포인트 | 설명 |
|---|---|
/widget/generate-age-gate-url | 연령 게이트 위젯 URL 생성 |
/widget/generate-direct-notices-url | 데이터 고지 위젯 URL 생성 |
/widget/generate-manage-session-permissions-url | 세션 권한 관리 위젯 URL 생성 |
/widget/generate-e2e-url | End-to-End 위젯 URL 생성 |
스크린 타임
| 엔드포인트 | 설명 |
|---|---|
/screentime/start | 스크린 타임 시작 |
/screentime/end | 스크린 타임 종료 |
/screentime/push | 세션의 완료된 스크린 타임 사용 세그먼트 제출 |
/screentime/request-override | 스크린 타임 예외 요청 |
/screentime/get-state | 스크린 타임 상태 가져오기 |
활동
| 엔드포인트 | 설명 |
|---|---|
/activity/push | 세션의 활동 레코드 푸시 |
/test/send-activity-digest | 테스트 주간 활동 다이제스트 이메일 보내기 |
테스트
| 엔드포인트 | 설명 |
|---|---|
/test/set-challenge-status | Challenge 상태 설정(테스트 전용) |
/test/set-age-verification-status | 연령 확인 상태 설정(테스트 전용) |