API 개요
  • PDF

API 개요

  • PDF

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

네이버 클라우드 플랫폼에서 제공하는 서비스와 솔루션을 효과적으로 이용할 수 있도록 API(Application Program Interface, 응용 프로그램 인터페이스)와 SDK(Software Development Kit)를 제공하고 있습니다. 액션에 따라 파라미터 값을 입력하고 등록, 수정, 삭제, 조회 기능을 이용할 수 있으며 서비스와 운영 도구 자동화에도 활용할 수 있습니다. 일반적으로 XML, JSON 형식으로 응답하는 API URL 형태로 크게 기본 API, 호환 API, 연동 API로 구분할 수 있습니다.

네이버 클라우드 플랫폼이 제공하는 다양한 API

네이버 클라우드 플랫폼에서는 제공하는 세 가지 종류의 API에 대한 설명은 다음과 같습니다.

  • 기본 API: 네이버 클라우드 플랫폼의 일부 서비스를 활용할 수 있는 NAVER Cloud Platform API(Ncloud API)로 호환 API와 연동 API를 제외한 모든 API를 의미
  • 호환 API: 타사 API와 호환되는 네이버 클라우드 플랫폼의 API. AWS S3와 호환되는 Object Storage API, OpenStack Swift와 호환되는 Archive Storage API가 있음
  • 연동 API: 네이버의 인공 지능 서비스, 애플리케이션 서비스를 간소화된 형태의 호출로 손쉽게 활용할 수 있는 API. CLOVA, Papago, Maps API 등이 있음

API 가이드 안내

API 가이드는 효과적으로 네이버 클라우드 플랫폼의 다양한 API를 이용할 수 있도록 다음과 같은 주제로 구성되어 있습니다. 각 주제에서 사용자가 확인할 수 있는 내용은 다음과 같습니다.

  • API 개요: API 가이드 및 공통 정보, API 분류별 호출 및 인증 방법, 요청 및 응답 데이터 타입 정보 안내
    • API 개요: API 가이드 및 NAVER Cloud Platform API, Object Storage API, Archive Storage API, NAVER 연동 API 소개 및 이용에 도움이 되는 연관 리소스, FAQ 안내
    • API 호출 및 인증: API 분류별 호출 및 인증 방법, 지원 정보 확인
      • 기본 API: 호출 및 인증 방법 안내, 지원 API 및 SDK 정보 확인, SDK 다운로드
      • 호환 API: 호출 및 인증 방법 안내, 지원 API 정보 확인
      • 연동 API: 호출 및 인증 방법 안내, 지원 API 정보 확인
    • API 데이터 타입: 플랫폼별 사용 가능한 API 요청 및 응답 데이터 타입 정보
      • VPC: VPC 환경에서 공통적으로 사용하는 API 데이터 타입 정보
      • Classic: Classic 환경에서 공통적으로 사용하는 API 데이터 타입 정보
  • Platform: 네이버 클라우드 플랫폼의 서비스 과금(Billing) 관련 API 레퍼런스, 리전 정보 관련 API 레퍼런스 소개 및 사용 방법 안내
  • Compute: Compute의 서비스별 API 레퍼런스 소개 및 사용 방법 안내
  • Containers: Containers의 서비스별 API 레퍼런스 소개 및 사용 방법 안내
  • Storage: Storage의 서비스별 API 레퍼런스 소개 및 사용 방법 안내
  • Networking: Networking의 서비스별 API 레퍼런스 소개 및 사용 방법 안내
  • Database: Database의 서비스별 API 레퍼런스 소개 및 사용 방법 안내
  • Security: Security의 서비스별 API 레퍼런스 소개 및 사용 방법 안내
  • AI Service: AI Service의 서비스별 API 레퍼런스 소개 및 사용 방법 안내
  • Application Service: Application Service의 서비스별 API 레퍼런스 소개 및 사용 방법 안내
  • AI·NAVER API: AI·NAVER의 서비스별 API 레퍼런스 소개 및 사용 방법 안내
  • Big Data & Analytics: Big Data & Analytics의 서비스별 API 레퍼런스 소개 및 사용 방법 안내
  • Blockchain: Blockchain의 서비스별 API 레퍼런스 소개 및 사용 방법 안내
  • Business Applications: Business Applications의 서비스별 API 레퍼런스 소개 및 사용 방법 안내
  • Content Delivery: Content Delivery의 서비스별 API 레퍼런스 소개 및 사용 방법 안내
  • Developer Tools: Developer Tools의 서비스별 API 레퍼런스 소개 및 사용 방법 안내
  • Gaming: Gaming의 서비스별 API 레퍼런스 소개 및 사용 방법 안내
  • Internet of Things: Internet of Things의 서비스별 API 레퍼런스 소개 및 사용 방법 안내
  • Management & Governance: Management & Governance의 서비스별 API 레퍼런스 소개 및 사용 방법 안내
  • Media: Media의 서비스별 API 레퍼런스 소개 및 사용 방법 안내
  • Migration: Migration의 서비스별 API 레퍼런스 소개 및 사용 방법 안내

API 가이드 연관 리소스

네이버 클라우드 플랫폼에서는 API에 대한 사용자의 이해를 돕기 위해 가이드 외에도 다양한 연관 리소소를 제공하고 있습니다. API 연관 리소스는 다음과 같습니다.

자주 하는 질문을 먼저 확인해 보십시오.

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

Q. API는 어떻게 사용해야 합니까?
A. 생성한 인증키의 Access key와 Secret key를 확인하여 API 호출 시 사용되는 Header 값에 추가하여 사용해 주십시오. 자세한 내용은 API 가이드를 참고해 주십시오.

Q. 생성한 API 인증키는 어디에서 확인할 수 있습니까?
A. API 인증키는 네이버 클라우드 플랫폼 포털에 로그인한 후 나타나는 마이페이지 메뉴의 계정 관리 > 인증키 관리에서 확인할 수 있습니다. 인증키 관리 사용 방법은 포털 및 콘솔 사용 가이드를 참고해 주십시오.

Q. 특정 API 데이터 타입을 사용하는 연관 오퍼레이션을 확인하기 위해서는 어떻게 해야 합니까?
A. 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 가이드를 참고하여 Signature 생성, 요청 헤더, 서버 시간 동기화에 문제가 없는지 확인해 주십시오. API Gateway 인증 오류가 아닌 경우 해당 서비스의 API 가이드를 참고해 주십시오. 만약 모든 원인을 검토했음에도 Open API 오류가 여전히 발생한다면 네이버 클라우드 플랫폼 포털의 고객 지원 > 지원 센터 > 문의하기 메뉴를 차례대로 클릭하여 문의해 주십시오.


이 문서가 도움이 되었습니까?

What's Next