API 개요

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

네이버 클라우드 플랫폼의 서비스와 솔루션을 효과적으로 이용할 수 있도록 서비스별 REST 방식의 API(Application Program Interface)를 제공합니다. API는 네이버 클라우드 플랫폼의 표준 규격 적용 여부에 따라 Legacy API와 Standardized API로 구분할 수 있습니다.

Legacy API: 기존에 제공 중인 API로, 서비스별 특성에 따라 호출 방식이 상이할 수 있습니다.
Standardized API: 네이버 클라우드 플랫폼의 표준 규격을 준수하여 제공하는 API로, 호출 방식이 일관되어 학습이 용이하고 사용성이 향상됐습니다.

Standardized API와 Legacy API

네이버 클라우드 플랫폼은 서비스별로 서로 다르게 적용되어 있던 API의 설계 및 사용 방식을 일관된 기준으로 제공하기 위해 네이버 클라우드 플랫폼의 표준 규격에 따른 API 표준화를 진행하고 있습니다. Legacy API는 서비스별 설계 기준에 따라 제공되어 API 경로, 파라미터와 필드의 명칭, 요청 및 응답 형식 등이 서비스마다 다를 수 있습니다. Standardized API는 Legacy API를 단순히 동일한 형태로 변경한 것이 아니라, 네이버 클라우드 플랫폼의 표준 규격을 적용하여 여러 서비스에서 일관된 방식으로 API를 사용할 수 있도록 설계 및 사용 규칙을 표준화한 API입니다. 단, 표준화 적용 범위와 제공 버전은 서비스별로 상이할 수 있으므로 각 서비스의 API 가이드를 참조해야 합니다.

구분	Legacy API	Standardized API
설계 기준	REST API 기반 서비스별 설계 기준 적용	REST API 기반 네이버 클라우드 플랫폼 API 표준 규격 따른 공통 설계 기준 적용
인증 방식	서비스별 특성에 따른 인증 방식 채택 API Gateway와 연동 후 인증 (기본값) 콘솔에서 Application을 등록한 후 발급받은 Client ID와 Client Secret으로 인증 서비스에서 직접 발급한 토큰으로 인증 Amazon S3 API 또는 OpenStack Swift API와 호환되는 방식으로 인증 Storage 카테고리의 일부 서비스(Ncloud Storage, Object Storage, Archive Storage)에서 사용	서비스별 특성에 따른 인증 방식 채택 API Gateway와 연동 후 인증 (기본값) 콘솔에서 Application을 등록한 후 발급받은 Client ID와 Client Secret으로 인증 서비스에서 직접 발급한 토큰으로 인증
리소스 경로 및 HTTP 메서드	서비스별로 상이할 수 있음	리소스 간 관계를 기준으로 일관된 경로 구성, 작업 성격에 따른 공통 메서드 사용
요청 및 응답 구조	서비스별로 상이할 수 있음	필드 명명 규칙, 데이터 타입, 목록 조회(페이지네이션, 정렬, 필터링)에 공통 규칙 적용
오류 처리 방식	서비스별로 상이할 수 있음	HTTP 상태 코드와 오류 응답 구조에 공통 기준 적용, 오류 코드는 서비스별 오류 코드를 함께 사용

참고

응답 반환 형식은 JSON (기본값)과 XML이며, 파일 다운로드 등 일부 API는 응답 결과를 파일로 반환합니다.
API Key를 통한 인증 방식이 반드시 필요한 경우, 해당 서비스의 API 가이드 개요에서 자세한 내용을 확인할 수 있습니다. API Key는 API Gateway 사용 가이드를 참조하여 생성할 수 있으며, API key 발급에 대한 별도의 과금은 발생하지 않습니다.

구분 방법

API 가이드에서 목차와 레이블을 통해 Standardized API와 Legacy API를 구분할 수 있습니다.

첫째, 가이드 목차에서 Ncloud API 표준이 적용되기 전의 API 가이드는 Legacy 카테고리 하위에 제공되며, Ncloud API 표준이 적용된 API 가이드는 Standardized 카테고리 하위에 제공됩니다.
둘째, Ncloud API 표준이 적용된 API는 가이드 상단에 표시된 standardized 레이블을 통해 확인할 수 있습니다.

자주 하는 질문

API 가이드를 읽기 전 자주 하는 질문에 대한 답변으로 궁금증을 빠르게 해소할 수 있습니다. 만약 다음의 자주 하는 질문에서 원하는 답을 얻지 못한 경우 API 가이드에서 원하는 내용을 찾아서 확인해 보십시오.

Q. API는 어떻게 사용해야 합니까?

A. 생성한 인증키의 Access key와 Secret key를 확인하여 API 호출 시 사용되는 Header 값에 추가하여 사용해 주십시오. 자세한 내용은 API 가이드를 참조해 주십시오.

Q. 생성한 API 인증키는 어디에서 확인할 수 있습니까?

A. API 인증키는 네이버 클라우드 플랫폼 콘솔의 My Account > 계정 및 보안 관리 > 보안 관리 > 접근 관리 > API 인증키에서 확인할 수 있습니다.

Q. Standardized API와 Legacy API의 차이는 무엇인가요?

A. Legacy API는 Ncloud API 표준이 적용되기 전에 서비스별 설계 기준에 따라 제공된 API입니다. Standardized API는 API 경로, HTTP 메서드, 명명 규칙, 요청 및 응답 형식, 오류 처리, 목록 조회 등에 네이버 클라우드 플랫폼의 표준 규격을 적용한 API입니다.
서비스별로 제공 기능과 세부 스펙은 다를 수 있으므로 실제 지원 범위는 각 서비스의 API 가이드를 확인해 주십시오.

Q. 기존 API가 모두 Standardized API로 변경되나요?

A. API 표준화는 서비스별로 순차적으로 적용됩니다. 따라서 모든 서비스의 Legacy API가 동일한 시점에 Standardized API로 변경되는 것은 아닙니다.
서비스별 표준화 적용 여부와 제공 범위는 각 서비스의 API 가이드에서 확인할 수 있습니다.

Q. Standardized API가 제공되면 Legacy API는 바로 사용할 수 없게 되나요?

A. Standardized API가 제공되더라도 Legacy API가 즉시 제공 종료되는 것은 아닙니다.
Standardized API와 Legacy API의 제공 기간과 지원 범위, Legacy API의 제공 종료 일정은 서비스별로 다를 수 있습니다. Legacy API의 제공 종료와 관련된 사항은 각 서비스의 공지와 API 가이드를 확인해 주십시오.

Q. Standardized API 적용 여부는 어디에서 확인할 수 있나요?

A. API 가이드의 목차와 각 가이드 상단에 표시된 레이블을 통해 확인할 수 있습니다.
표준이 적용된 API 가이드는 Standardized 카테고리 하위에 제공되며, 각 API 가이드 상단에 standardized 레이블이 표시됩니다. 표준이 적용되기 전의 API 가이드는 Legacy 카테고리 하위에 제공됩니다.

Q. Standardized API로 전환할 때 기존 애플리케이션을 수정해야 하나요?

A. Standardized API는 Legacy API와 호출 방식이 다르기 때문에 Legacy API를 사용하여 구현한 애플리케이션에서 Standardized API를 사용하려면 코드 변경이 필요할 수 있습니다.
전환하기 전에 해당 서비스의 Standardized API 가이드에서 요청 및 응답 형식과 Legacy API와의 차이를 확인해 주십시오.

Q. Legacy API의 제공 종료 일정은 어디에서 확인할 수 있나요?

A. Legacy API의 제공 종료 여부와 일정은 서비스별 정책에 따라 다를 수 있습니다.
제공 종료 일정이 확정된 경우, 해당 서비스의 공지 또는 API 가이드를 통해 안내되므로 서비스별 안내 사항을 확인해 주십시오.

Q. 다른 계정(사용자)의 API를 호출하는 경우에도 과금이 발생합니까?

A. API를 호출한 사용자에게는 과금이 발생하지 않지만, 해당 API의 인증 정보를 등록한 사용자에게는 과금이 발생합니다.

Q. 네이버 클라우드 플랫폼 포털에서 AI·NAVER API라는 서비스 카테고리를 확인할 수 없습니다.

A. 네이버 클라우드 플랫폼 포털은 사용자의 이해를 돕기 위해 네이버의 인공 지능 서비스, 애플리케이션 서비스를 서비스 특성에 따라 AI services와 Application Services로만 카테고리를 구분하고 있습니다. 반면 콘솔에서는 사용자의 이용 편의를 위해 AI services, Application Services, AI·NAVER API의 세 가지 카테고리로 구분하고 있습니다.

Q. Open API 요청 시 오류가 발생하는 경우 원인이 무엇입니까?

A. API Gateway 인증의 오류이거나 해당 서비스의 오류가 원인일 수 있습니다. API Gateway 인증 오류인 경우, API Gateway API 가이드를 참조하여 시그니처 생성, 요청 헤더, 서버 시간 동기화에 문제가 없는지 확인해 주십시오. API Gateway 인증 오류가 아닌 경우에는 해당 서비스의 API 가이드를 확인해 주십시오. 만약 모든 원인을 검토했음에도 Open API 오류가 여전히 발생한다면 네이버 클라우드 플랫폼 포털의 고객 지원 > 지원 센터 > 문의하기 메뉴를 차례대로 클릭하여 문의해 주십시오.