API Gateway 개요

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

API Gateway는 API(Application Programming Interface) 호출과 관련된 모든 작업을 편리하게 실행할 수 있게 하는 서비스입니다. API를 안정적으로 실행하기 위한 다양한 관리 기능들과 API 사용 현황을 실시간으로 확인할 수 있는 대시보드를 이용할 수 있습니다.

API Gateway가 제공하는 다양한 기능

API Gateway가 제공하는 다양한 기능에 대한 설명은 다음과 같습니다.

• Product 관리

  • 여러 개의 API를 그룹핑하여 Product로 관리
  • Product별로 호출 도메인 제공, 공개 설정을 통해 네이버 클라우드 플랫폼의 다른 사용자가 사용 가능
  • Product를 사용하고 있는 API Key를 통해 사용자의 애플리케이션을 식별하거나 사용량 제한 가능

• API 관리

  • REST API 및 관련 리소스와 메서드를 정의하고 인증 방식 설정
  • API 사용자가 참조할 수 있는 정의된 API 명세와 Overview 관리
  • 스테이지 및 버전 관리 기능을 이용하여 동일한 API를 여러 버전으로 운영 가능
  • 백엔드 서비스의 안정화를 위하여 스테이지별로 캐시 사용, Throttling 정책, IP ACL 등 설정 가능

• Usage Plan 관리

  • 요청 처리량(Rate) 및 요청 처리 한도(Quota)를 설정하여 API 사용자의 사용량 제한 가능

• API Key 관리

  • 다른 사용자 또는 네이버 클라우드 플랫폼에서 제공하는 API를 사용하기 위한 API Key 발급
  • API Key별로 서비스를 구독하고 스테이지별 사용량 확인 가능

• API 사용량 모니터링

  • 대시보드를 통해 실시간으로 수집한 API 사용량 모니터링
  • 시간별, 일별, 월별로 API 호출 수, 성공률, 평균 응답 시간 등의 성능 지표를 확인 가능

API Gateway 사용 가이드 안내

API Gateway는 한국 리전, 미국 리전, 홍콩 리전, 싱가포르 리전, 일본 리전, 독일 리전에서 서비스를 제공하고 있습니다. 해당 리전에서 제공하는 서비스 내용은 동일하며, API Gateway의 원활한 이용을 위해 다음 목차와 목차별 내용을 확인해 주십시오.

• API Gateway 개요: API Gateway 소개 및 이용에 도움이 되는 연관 리소스 안내
• API Gateway 사용 준비: API Gateway를 이용하기 위한 지원 사양, 제한 사항, 이용 요금 안내
• API Gateway 시나리오: API Gateway를 이용하는 전체 프로세스 안내
• API Gateway 시작: 네이버 클라우드 플랫폼 콘솔에서 API Gateway 이용 신청 및 Product 생성 방법 안내
• API Gateway 사용: 서비스 사용 방법 안내
  • My Products: Product, API, Catalog 및 문서, API Key 관리 방법 안내
  • Published APIs: 다른 사용자가 공유한 API 문서 확인 및 구독 방법 안내
  • Usage Plans: API 사용량을 제한하는 Usage Plan 생성, 관리, 삭제 방법 안내
  • API Keys: API 사용자 인증을 위한 API Key 생성, 관리, 삭제 방법 안내
  • Authorizers: API 보호를 위한 Authorizer 생성, 수정, 테스트, 삭제 방법 및 이용 예제 안내
  • Client Certificates: Client Certificate 생성, 수정, 테스트, 삭제 및 이용 방법 안내
  • Dashboard: API 사용량 모니터링 대시보드 사용 방법 안내
• API Gateway 권한 관리: Sub Account를 활용한 API Gateway 권한 관리 방법 안내
• API Gateway 용어: API Gateway 사용 시 반드시 알아두어야 할 주요 용어와 해설 안내
• API Gateway 릴리스 노트: API Gateway 사용 가이드 업데이트 이력

API Gateway 연관 리소스

네이버 클라우드 플랫폼에서는 API Gateway에 대한 고객의 이해를 돕기 위해 사용 가이드 외에도 다양한 연관 리소스를 제공하고 있습니다. API Gateway를 도입하기 위해 고민 중이거나 데이터 관련 정책을 수립하면서 자세한 정보가 필요한 개발자, 마케터 등은 다음 리소스를 적극 활용해 보십시오.

• API Gateway에 대한 이해와 사용 방법 고도화

  • Ncloud 사용 환경 가이드: VPC 환경 및 지원 여부에 대한 사용 가이드
  • API Gateway 블로그 소개: 네이버 클라우드 플랫폼 공식 블로그의 API Gateway 소개
  • 요금 소개, 특징, 상세 기능: API Gateway의 요금 체계, API Gateway의 특징 및 상세 기능 요약
  • 서비스 최신 소식: API Gateway 관련 최신 소식
  • 자주 하는 질문: API Gateway 사용자들이 자주 하는 질문
  • 문의하기: 사용 가이드를 통해서도 궁금증이 해결되지 않는 경우 직접 문의

• API Gateway 부가 연동 서비스 사용 가이드

  • File Safer 사용 가이드: 고객의 서비스에서 제공하는 파일과 아웃링크의 악성 여부를 검사할 수 있는 File Safer 사용 방법
  • Key Management Service 사용 가이드: 고객의 중요 정보 암호화에 사용된 키를 관리하고 보호하는 Key Management Service 사용 방법
  • Cloud Functions 사용 가이드: API Gateway와 연결 가능한 Action을 제공하는 Cloud Functions 사용 방법
  • Sub Account 사용 가이드: API Gateway 관리 및 운영 권한 관리를 도와주는 Sub Account 사용 방법