CLOVA eKYC와 API Gateway 연동

CLOVA eKYC는 도메인마다 고유한 InvokeURL을 가지고 있습니다. InvokeURL은 안전한 서비스를 위해 외부 서비스에 바로 공개되지 않으며, 네이버 클라우드 플랫폼의 API Gateway에 연동하여 사용하도록 설계되어 있습니다. 도메인별 사용량에 따라 API Gateway 요금이 과금됩니다. API Gateway에 대해 잘 알지 못하더라도 몇 번의 클릭만으로 쉽게 연동할 수 있으므로 이 가이드를 참고하여 연동 URL과 Secret Key를 잘 보관해 주십시오.

API Gateway 이용 신청

도메인의 InvokeURL을 API Gateway와 연동하려면 먼저 API Gateway 서비스의 이용 신청을 완료해야 합니다. API Gateway 이용에 대한 자세한 설명은 API Gateway 사용 가이드를 참고해 주십시오.
API Gateway 이용 신청하는 방법은 다음과 같습니다.

1. 네이버 클라우드 플랫폼의 콘솔에서 Services > API Gateway 메뉴를 차례대로 클릭해 주십시오.
2. [상품 이용 신청] 버튼을 클릭해 주십시오.

자동 연동 설정

API Gateway 이용 신청이 완료되면 자동으로 API Gateway Invoke URL이 생성됩니다.
자동 연동 설정을 확인하고 Invoke URL을 복사하는 방법은 다음과 같습니다.

1. API Gateway 이용 신청을 참고하여 API Gateway 이용 신청을 완료해 주십시오.
2. 네이버 클라우드 플랫폼의 콘솔에서 Services > AI Services > CLOVA eKYC > Domain 메뉴를 차례대로 클릭해 주십시오.
3. API 연동 설정 필드의 [설정] 버튼을 클릭해 주십시오.
4. API 연동 설정 창에서 APIGW 자동 연동 항목의 [자동연동] 버튼을 클릭해 주십시오.
5. Product 생성 알림 창이 나타나면 [확인] 버튼을 클릭해 주십시오.
6. APIGW Invoke URL의 주소를 확인해 주십시오.
   • 자동 생성된 API Gateway의 InvokeURL로 호출하게 되며, 각 도메인마다 고유한 호출 URL이 생성됨
   • API Gateway의 InvokeURL로 호출 시 Secret Key를 생성함
7. APIGW Invoke URL과 Secret Key를 복사하여 별도로 보관해 주십시오.

수동 연동 설정

수동 연동을 설정하는 경우, API Gateway의 이용 신청을 완료한 후 다음 단계에 따라서 API를 생성합니다.

1. API 생성
2. Stages API 생성
3. API 배포

Step 1. API 생성

API Gateway에서 API를 생성하는 방법은 다음과 같습니다.

1. 네이버 클라우드 플랫폼의 콘솔에서 Services > API Gateway > My Products 메뉴를 차례대로 클릭해 주십시오.
2. [Product 생성] 버튼을 클릭해 주십시오.
3. Product 생성 화면에서 정보를 입력하고 [Product 생성] 버튼을 클릭해 주십시오.
4. 생성된 Project의 APIs 아이콘을 클릭해 주십시오.
   
5. API 생성 페이지에서 [API 생성] 버튼을 클릭해 주십시오.
6. API 생성 화면에서 Swagger에서 가져오기를 선택하고 API 이름을 입력해 주십시오.
7. Swagger에서 가져오기의 [Swagger JSON] 탭에 ‘CLOVA_EKYC_API_EXTERNAL_V1.json’ 파일을 업로드해 주십시오.
   • 해당 파일은 아래 섹션의 'API 생성 시 사용할 JSON 파일 다운로드 방법'을 참고하면 다운로드 가능
8. [API 생성] 버튼을 클릭해 주십시오.
   
9. Stages API 생성을 참고하여 Stages API를 생성해 주십시오.

API 생성 시 사용할 JSON 파일 다운로드 방법
‘CLOVA_EKYC_API_EXTERNAL_V1.json' 파일을 다운로드 받는 방법은 다음과 같습니다.

1. 네이버 클라우드 플랫폼의 콘솔에서 Services > AI Services > CLOVA eKYC > Domain 메뉴를 차례대로 클릭해 주십시오.
2. API Gateway를 연동할 도메인의 API 연동 설정 항목의 [설정] 버튼을 클릭해 주십시오.
3. API 연동 설정 창이 나타나면 APIGW 수동 연동 영역의 APIGW Configuration의 [다운로드] 버튼을 클릭해 주십시오.
   • 다운로드 받은 파일은 API 생성 시 활용 가능

Step 2. Stages API 생성

Stages API를 생성하는 방법은 다음과 같습니다.

1. 생성한 API의 [Stages] 탭 > [Stage 생성] 버튼을 클릭해 주십시오.
2. Stage 이름을 입력한 후, Endpoint 도메인 필드를 커스텀으로 선택해 주십시오.
3. CLOVA eKYC API 연동 설정 창에서 Invoke URL을 복사하여 Endpoint 도메인 필드에 붙여 넣으십시오.
   • Invoke URL을 복사하는 방법은 자동 연동 설정 참조
4. [생성] 버튼을 클릭해 주십시오.
5. API 배포를 참고하여 API를 배포해 주십시오.

Step 3. API 배포

API를 배포하는 방법은 다음과 같습니다.

1. [Resources] 탭을 클릭한 후, 화면 우측 상단의 [API 배포] 버튼을 클릭해 주십시오.
2. API 배포 창이 나타나면 배포할 스테이지를 선택하고 스테이지 이름과 설명을 입력해 주십시오.
3. 생성된 API를 배포하기 위해 [추가] 버튼을 클릭해 주십시오.
4. [Stage] 탭에서 Invoke URL의 [주소 복사] 버튼을 클릭해 주십시오.

CLOVA eKYC의 API 사용

CLOVA eKYC의 API에 대한 사용 방법은 CLOVA eKYC API 가이드를 참고해 주십시오.