대화형 참조

k-ID API 참조에는 문서에서 직접 API 엔드포인트를 테스트할 수 있는 대화형 코드 샘플이 포함되어 있습니다. 각 엔드포인트 페이지에는 코드 샘플과 라이브 API 호출을 수행하는 데 사용할 수 있는 요청 인터페이스가 포함되어 있습니다.

대화형 요청 인터페이스

모든 엔드포인트 페이지에는 "Request" 섹션에 대화형 요청 인터페이스가 포함되어 있습니다. 이 인터페이스를 통해 다음을 수행할 수 있습니다:

1. 기본 URL 선택: 기본 URL 필드 위에 마우스를 올려 편집 버튼을 표시합니다. 편집 버튼을 클릭하여 사용 가능한 기본 URL이 있는 드롭다운 메뉴를 엽니다:

   • 라이브: https://game-api.k-id.com/api/v1/
   • 테스트: https://game-api.test.k-id.com/api/v1/

2. 요청 인증: "Bearer Token" 필드에 API 키를 붙여넣습니다

   • Compliance Studio에서 API 키를 가져올 수 있습니다
   • 선택한 환경(테스트 또는 라이브)에 대해 올바른 API 키를 사용하는지 확인하세요

3. 요청 본문 구성: 본문 필드에는 예제 값이 있는 샘플 요청이 포함되어 있습니다

   • 요청 본문의 값을 필요에 맞게 수정할 수 있습니다
   • 필수 필드는 엔드포인트 문서에 표시됩니다

4. 요청 전송: "Send API Request"를 클릭하여 API 호출을 완료합니다

5. 응답 보기: 응답이 요청 인터페이스 아래에 표시되어 API의 요청에 대한 응답을 보여줍니다

코드 샘플

각 엔드포인트 페이지에는 또한 다양한 프로그래밍 언어와 도구로 요청을 수행하는 방법을 보여주는 코드 샘플이 오른쪽 상단에 포함되어 있습니다. 이러한 샘플은 참조용이며 복사하여 자체 코드에서 사용할 수 있습니다.

모범 사례

• API를 실험할 때 테스트 환경 사용
• API 키를 버전 관리에 커밋하지 마세요 - 대신 환경 변수를 사용하세요
• 응답을 주의 깊게 검토하여 API의 동작을 이해하세요
• 오류 응답 확인하여 요청이 실패한 경우 무엇이 잘못되었는지 이해하세요

인증 및 API 키에 대한 자세한 내용은 인증을 참조하세요.