개발자 설정

제품 상세 페이지의 개발자 설정 탭에는 k-ID를 제품에 통합하는 데 필요한 기술 구성이 포함되어 있습니다. API 키, 웹훅 엔드포인트, 타겟 오리진, API URL이 여기에 해당합니다.

API 키

각 제품에는 테스트 및 라이브 환경을 위한 별도의 API 키가 있어 개발 및 프로덕션 트래픽을 분리합니다.

키 유형	용도	구성 소스
테스트 API 키	개발 및 테스트	테스트 환경 구성
라이브 API 키	프로덕션	퍼블리싱된 라이브 구성

키 생성

1. 제품의 개발자 설정 탭으로 이동합니다.
2. API 키 섹션에서 환경(테스트 또는 라이브)을 선택합니다.
3. 생성 버튼을 클릭하고 키에 이름을 부여합니다. 예: "Production Server" 또는 "Staging Environment."
4. 키가 생성되어 표시됩니다. 전체 키는 다시 표시되지 않으므로 즉시 복사하십시오.

환경당 여러 키를 생성할 수 있습니다. 이 기능은 서로 다른 서비스나 배포 단계에 별도의 키가 필요한 경우에 유용합니다. 예를 들어, 게임 서버와 분석 파이프라인을 위한 별도의 키를 사용할 수 있습니다.

키 보안

API 키는 서버 측에 보관하고 클라이언트 측 코드에 노출하지 않아야 합니다. 비밀번호와 동일하게 취급하십시오.

• 키를 환경 변수 또는 시크릿 매니저에 저장합니다
• 키를 소스 컨트롤에 커밋하지 않습니다
• 클라이언트 측 JavaScript, 모바일 앱 번들, 최종 사용자에게 전달되는 코드에 키를 포함하지 않습니다

키가 유출된 경우 개발자 설정 페이지에서 즉시 해지하고 새 키를 생성하십시오.

웹훅

웹훅을 사용하면 챌린지 상태 변경, 인증 결과, 세션 권한 업데이트 등 중요한 이벤트가 발생할 때 k-ID가 서버에 알림을 보낼 수 있습니다.

웹훅 구성

테스트 및 라이브 환경에 대해 별도의 웹훅 엔드포인트를 구성합니다.

1. 웹훅 섹션에서 환경을 선택합니다.
2. 웹훅 URL을 입력합니다. 이것은 k-ID로부터 POST 요청을 수신하는 서버의 엔드포인트입니다.
3. 구성을 저장합니다.

사용 가능한 이벤트 유형

웹훅 이벤트는 컴플라이언스 라이프사이클의 주요 순간을 다룹니다.

• 챌린지 상태 변경
• 인증 결과
• 인증 취소
• 부모 동의 부여
• 세션 권한 변경
• 세션 삭제
• 테스트 이벤트 (웹훅 설정 검증용)

각 웹훅 전달에는 요청이 k-ID에서 발송되었음을 확인하기 위해 검증해야 하는 서명 헤더가 포함됩니다. 페이로드 구조 및 서명 검증을 포함한 전체 웹훅 이벤트 레퍼런스는 웹훅을 참조하십시오.

타겟 오리진

클라이언트 측 통합을 위한 허용된 오리진(도메인)을 구성합니다. k-ID 위젯 또는 클라이언트 측 API를 사용할 때 요청이 이 오리진에 대해 검증되어 무단 사용을 방지합니다.

개발, 스테이징, 프로덕션 도메인을 추가합니다. 각 오리진은 전체 오리진 URL이어야 합니다. 예:

• https://yourgame.com
• https://staging.yourgame.com
• http://localhost:3000 (로컬 개발용)

팁

로컬 개발 URL을 포함하여 통합이 실행되는 모든 환경을 추가하십시오. 이 목록에 없는 오리진의 요청은 거부됩니다.

API URL

제품 상세 페이지에는 두 환경의 API 기본 URL이 표시됩니다. 이는 서버가 k-ID API에 요청할 때 사용하는 URL입니다.

환경	용도
테스트 API URL	개발 중 테스트 API 키와 함께 사용
라이브 API URL	프로덕션에서 라이브 API 키와 함께 사용

제품의 개발자 설정 페이지에 표시된 URL을 사용하십시오. 수동으로 구성하지 마십시오.