APIの概要
  • PDF

APIの概要

  • PDF

Classic/​VPC環境で利用できます。​

NAVERクラウドプラットフォームが提供するサービスとソリューションを効果的に利用できるように、API(Application Program Interface、アプリケーションインターフェース)とSDK(Software Development Kit)を提供しています。 アクションに応じてパラメータ値を入力して登録、修正、削除、照会でき、サービスと運営ツールの自動化にも活用できます。 通常、XML、JSON形式でリスポンスするAPI URLの形式で、基本API、互換API、連携APIに大別できます。

NAVERクラウドプラットフォームが提供する3種類のAPIに関する説明は、次のとおりです。

  • 基本API:NAVERクラウドプラットフォームの一部サービスを管理できるNAVERクラウドプラットフォームAPI(Ncloud API)。 互換APIと連携APIを除く、全てのAPIを意味する
  • 互換API:他社のAPIと互換するNAVERクラウドプラットフォームのAPI。 AWS S3と互換するObject Storage APIやOpenStack Swiftと互換するArchive Storage APIがある
  • 連動API:NAVERの人工知能サービス、アプリケーションサービスを簡素化した形式の呼び出しで、手軽に活用できるAPI。 CLOVA、Papago、Maps APIなどがある

APIガイドのご案内

APIガイドは、効果的にNAVERクラウドプラットフォームの様々なAPIを利用できるように、以下のようなテーマで構成されています。 各テーマでユーザーが確認できる内容は次のとおりです。

  • APIの概要:APIガイドや共通の情報、APIの分類別呼び出し、認証方法、リクエストやリスポンスデータのタイプ情報のご案内
    • APIの概要:APIガイドおよびNAVERクラウドプラットフォームの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:NAVERクラウドプラットフォームのサービス課金(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のサービス別APIリファレンスの紹介と使用方法のご案内
  • Big Data & Analytics:Big Data & Analyticsのサービス別APIリファレンスの紹介と使用方法のご案内
  • Blockchain:Blockchainのサービス別APIリファレンスの紹介と使用方法のご案内
  • Business Applications:Business Applicationsのサービス別APIリファレンスの紹介と使用方法のご案内
  • Content Delivery:Content Deliverysのサービス別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ガイドの関連リソース

NAVERクラウドプラットフォームでは、APIの利用者の理解に役立つよう、ガイド以外にも様々な関連リソースを提供しています。 API関連リソースは以下のとおりです。

よくある質問を先にご確認ください。

APIガイドを読む前に、よくある質問への回答をチェックすると不明な点をスピーディーに解消できます。 以下のよくある質問で答えが得られなかった場合、APIガイドで必要な内容をご確認ください。

Q. APIは、どのように使用すればよいですか?
A. 作成した認証キーのAccess keyとSecret keyを確認して、APIを呼び出す際に使用するヘッダ値に追加して使用します。 詳細内容は、 APIガイドをご参照ください。

Q. 作成したAPI認証キーは、どこで確認できますか?
A. API認証キーは、NAVERクラウドプラットフォームポータルにログインすると表示されるマイページメニューのアカウントの管理 > 認証キーの管理で確認できます。 認証キーの管理の使用方法は、ポータルとコンソールのご利用ガイドを参照してください。

Q. 特定のAPIデータタイプを使用する関連オペレーションを確認するには、どうすればよいですか?
A. APIガイドで提供されている検索ボックスに関連オペレーションを入力して、検索結果を確認してください。

Q. 他のユーザーのAPIを呼び出す場合も、課金が発生しますか?
A. APIを呼び出したユーザーではないAPIを登録したユーザーに、課金が行われます。

Q. NAVERクラウドプラットフォームポータルで、AI·NAVER APIというサービスカテゴリは確認できません。
A. NAVERクラウドプラットフォームポータルは、ユーザーの理解に役立つよう、NAVERの人工知能サービス、アプリケーションサービスをサービス特性に応じて、AI servicesとApplication Servicesのみにカテゴリを区分しています。 一方、コンソールではユーザーが使いやすいように、AI services、Application Services、AI·NAVER APIの3つのカテゴリに分かれています。

Q. Open APIリクエストの際、エラーが発生する原因は何ですか?
A. API Gatewayの認証エラーや、サービスのエラーが原因になる可能性があります。 API Gatewayの認証エラーの場合、API GatewayのAPIガイドを参考にして、Signatureの作成、リクエストヘッダ、サーバ時間の同期に問題がないか確認してください。 API Gatewayの認証エラーではない場合、サービスのAPIガイドをご参照ください。 すべての原因を確認してもOpen APIエラーが発生する場合は、NAVERクラウドプラットフォームポータルのカスタマーサポート > サポートセンター > 問い合わせメニューを順にクリックしてお問い合わせください。


この記事は役に立ちましたか?

What's Next