API Keys

Classic/VPC 환경에서 이용 가능합니다.

API Key는 앱 개발자 등의 사용자가 API Gateway에 등록된 API에 접근하여 사용할 수 있도록 권한을 부여하기 위한 값입니다.
API Keys에서는 API Key를 생성 및 관리하고 Stage와 연결할 수 있습니다.

API Keys 화면 및 목록

API Gateway 이용을 위한 API Keys 메뉴의 기본적인 설명은 다음과 같습니다.

영역	설명
① 메뉴명	현재 확인 중인 메뉴 이름, 운영 중인 API Key 개수
② 기본 기능	API Key 생성, API Gateway 상세 정보 확인, 페이지 새로 고침
③ 수정	운영 중인 API Key 수정
④ 삭제	운영 중인 API Key 삭제
⑤ 연결된 Stage 보기	API Key와 연결된 Stage 확인 및 사용량 보기, 구독 취소 API Key와 Stage를 연결하는 방법은 Stage에 API Key 연결 및 관리 참고
⑥ 검색창	API Key 이름 입력한 후 을 클릭해 항목 검색
⑦ 정렬	목록 페이지당 표시할 API Key 개수 설정
⑧ API Keys 목록	운영 중인 API Key의 목록 확인 API Key ID: 생성한 API Key의 ID(자동 부여) API Key 이름: API Key 생성 시 설정한 API Key의 이름 설명: API Key 생성 시 입력한 API Key의 설명 상태: API Key의 현재 활성/비활성 상태. API Key 생성 시 자동으로 활성화되며, 활성화 여부 설정 가능(API Key 수정 참고) API keys: [보기] 버튼을 클릭하여 생성된 API Key 확인, 재생성, 복사

API Key 생성

API Gateway에 등록된 API를 사용하기 위해서 먼저 API Key를 생성해야 합니다.

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

1. 네이버 클라우드 플랫폼 콘솔에서 Services > Application Services > API Gateway 메뉴를 차례대로 클릭해 주십시오.
2. API Keys 메뉴를 클릭해 주십시오.
3. [API Key 생성] 버튼을 클릭해 주십시오.
4. API Key 생성 정보를 입력한 후 [저장] 버튼을 클릭해 주십시오.
   • 이름: API Key의 이름을 입력
   • 설명: API Key의 설명을 입력
5. API Keys 목록에 생성한 API Key가 표시되는지 확인해 주십시오.

API Key 확인, 재생성, 복사

생성한 API Key를 확인, 재생성, 복사하는 방법은 다음과 같습니다.

1. 네이버 클라우드 플랫폼 콘솔에서 Services > Application Services > API Gateway 메뉴를 차례대로 클릭해 주십시오.
2. API Keys 메뉴를 클릭해 주십시오.
3. API Keys 목록에서 대상 API Key의 [보기] 버튼을 클릭해 주십시오.
4. API Keys 보기 팝업 창에서 필요에 따라 API Key 확인, 재생성, 복사해 주십시오.
   • Primary Key/Secondary Key: API를 호출할 때 헤더에 넣어야 하는 값
   • API Key를 재생성하려면 을 클릭한 후, 재생성 확인 팝업 창에서 내용을 확인하고 [예] 버튼을 클릭해 주십시오.
   • API Key를 클립보드에 복사하려면 을 클릭해 주십시오.
5. [확인] 버튼을 클릭해 주십시오.

API Key 수정

API Key의 이름, 설명, 활성화 여부를 수정할 수 있습니다.
API Key를 수정하는 방법은 다음과 같습니다.

1. 네이버 클라우드 플랫폼 콘솔에서 Services > Application Services > API Gateway 메뉴를 차례대로 클릭해 주십시오.
2. API Keys 메뉴를 클릭해 주십시오.
3. API Keys 목록에서 수정할 API Key를 클릭해 선택한 후 [수정] 버튼을 클릭해 주십시오.
4. API Key 수정 화면에서 설정 정보를 수정한 후 [저장] 버튼을 클릭해 주십시오.
   • ID: 자동 생성된 API Key ID 표시
   • 이름: 생성 시 작성한 API Key의 이름 수정
   • 설명: 생성 시 작성한 API Key의 설명 추가 또는 수정
   • 활성화: API Key 활성화 여부 선택. API Key를 사용하지 않으려면 비활성화로 설정.
5. API Keys 목록에 해당 API Key가 수정되었는지 확인해 주십시오.

API Key 삭제

API Key를 삭제하는 방법은 다음과 같습니다.

1. 네이버 클라우드 플랫폼 콘솔에서 Services > Application Services > API Gateway 메뉴를 차례대로 클릭해 주십시오.
2. API Keys 메뉴를 클릭해 주십시오.
3. API Keys 목록에서 삭제할 API Key를 클릭해 선택한 후 [삭제] 버튼을 클릭해 주십시오.
4. 삭제 팝업 창에서 내용을 확인한 후 [삭제] 버튼을 클릭해 주십시오.

연결된 Stage 확인 및 관리

API Key와 연결된 Stage를 목록에서 확인하고, API 사용량을 확인하거나 연결을 해제(구독 취소)할 수 있습니다.

연결된 Stage 확인

API Key와 연결된 Stage를 확인하는 방법은 다음과 같습니다.

1. 네이버 클라우드 플랫폼 콘솔에서 Services > Application Services > API Gateway 메뉴를 차례대로 클릭해 주십시오.
2. API Keys 메뉴를 클릭해 주십시오.
3. API Keys 목록에서 연결된 Stage를 확인할 API Key를 클릭해 선택한 후 [연결된 Stage 보기] 버튼을 클릭해 주십시오.
4. Stage 연결 팝업 창에서 API Key의 상태를 확인해 주십시오.
   • Product 이름: 연결된 Stage가 있는 Product 이름 표시
   • 설명: Product 생성 시 입력한 설명 표시
   • 상태: 현재 API Key의 상태 표시
   • 요청 일시: API Key와 Stage 연결을 요청한 일시
   • 수정 일시: API Key의 상태를 수정한 일시
   • API 사용량을 확인하려면 대상 Product 이름을 클릭해 선택한 후 [사용량 보기] 버튼을 클릭해 주십시오.
   • Stage 연결을 해제(구독 취소)하려면 대상 Product 이름을 클릭해 선택한 후 [구독 취소] 버튼을 클릭해 주십시오.

API 사용량 확인

API Key와 연결된 Stage의 API 사용량을 확인하는 방법은 다음과 같습니다.

1. 네이버 클라우드 플랫폼 콘솔에서 Services > Application Services > API Gateway 메뉴를 차례대로 클릭해 주십시오.
2. API Keys 메뉴를 클릭해 주십시오.
3. API Keys 목록에서 대상 API Key를 클릭해 선택한 후 [연결된 Stage 보기] 버튼을 클릭해 주십시오.
4. API 사용량을 확인할 Product 이름을 클릭해 선택한 후 [사용량 보기] 버튼을 클릭해 주십시오.
5. 사용량 보기 화면에서 정보를 확인해 주십시오.
   • Product 이름: API Key와 연결된 Stage의 Product 이름 표시
   • API 이름: API Key와 연결된 Stage의 API 이름
   • Stage 이름: API Key와 연결된 Stage 이름
   • 일별 호출수/요청 처리 한도: 일별 호출 수와 Usage Plan에 설정된 일별 요청 처리 한도 값 표시
   • 월별 호출수/요청 처리 한도: 월별 호출 수와 Usage Plan에 설정된 월별 요청 처리 한도 값 표시

Stage 연결 해제(구독 취소)

API Keys와 연결된 Stage의 연결을 해제(구독 취소)하는 방법은 다음과 같습니다.

1. 네이버 클라우드 플랫폼 콘솔에서 Services > Application Services > API Gateway 메뉴를 차례대로 클릭해 주십시오.
2. API Keys 메뉴를 클릭해 주십시오.
3. API Keys 목록에서 대상 API Key를 클릭해 선택한 후 [연결된 Stage 보기] 버튼을 클릭해 주십시오.
4. 연결된 Stage 목록 화면에서 연결을 해제할 Stage를 클릭해 선택한 후 [구독 취소] 버튼을 클릭해 주십시오.
5. 구독 취소 팝업 창에서 내용을 확인한 후 [예] 버튼을 클릭해 주십시오.
6. 연결된 Stage 목록에서 Stage가 삭제되었는지 확인해 주십시오.
   • 해당 Product의 API Key가 승인으로 설정된 상태에서 Stage 연결을 해제하면, Product에 연결된 API Keys 목록에서 관련 API Key 항목도 삭제됩니다.
   • 해당 Product의 API Key가 거부로 설정된 상태에서 Stage 연결을 해제하면, Product에 연결된 API Keys 목록에서 관련 항목이 삭제되지 않고 요청 거부로 표시됩니다.