Classic/VPC環境で利用できます。
NAVERクラウドプラットフォームが提供するサービスとソリューションを効果的に利用できるように、API(Application Program Interface、アプリケーションインターフェース)と SDK(Software Development Kit)を提供しています。アクションに応じてパラメータを入力して登録、変更、削除、照会機能を利用することができ、サービスと運用ツールの自動化にも活用できます。通常、XML、JSON形式でリスポンスする API URLの形式で、基本 API、互換 API、連携 APIに大別できます。
NAVERクラウドプラットフォームが提供するさまざまな API
NAVERクラウドプラットフォームが提供する3種類の APIの詳細は次の通りです。
- 基本 API: NAVERクラウドプラットフォームの一部サービスを利用できる NAVERクラウドプラットフォーム API(Ncloud API)で、互換 APIと連携 APIを除くすべての APIを意味
- 互換 API: 他社の APIと互換する NAVERクラウドプラットフォームの API。AWS S3と互換性のある Ncloud Storage API、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リファレンスの紹介と使用方法のご案内
- 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関連リソースは次の通りです。
- NAVERクラウドプラットフォーム APIの活用法: NAVERクラウドプラットフォーム Ncloud APIの紹介と、構造および活用方法のご案内、デモ実演教育ビデオ
- API Gatewayを介した API開発とビジネスロジックの実行: 安定した API呼び出しとトラフィック管理、モニタリングを提供する API Gatewayの活用方法のご案内
- API Gatewayご利用ガイド: RESTful APIを作成して、メンテナンス、使用量の制御、モニタリングができる NAVERクラウドプラットフォーム API Gatewayの使用方法のご案内
- API Workflowご利用ガイド: NAVERクラウドプラットフォームの APIまたは HTTPベースの APIを組み合わせて、新しい Microserviceサービスをスピーディーに実装できる NAVERクラウドプラットフォームの API Workflowの使用方法のご案内
- Applicationご利用ガイド: NAVERクラウドプラットフォームの APIの使用に必要な認証キーを発行するために、コンソールで Applicationを登録する方法、提供する機能のご案内
- CLIガイド: NAVERクラウドプラットフォームのサービス別 CLIガイド
- よくある質問: CLIに関するよくあるご質問
- お問い合わせ: CLIガイドだけでは不明な点が解消されない場合、直接問い合わせ
よくある質問を先にご確認ください。
APIガイドを読む前に、よくある質問への回答をチェックすると不明な点をスピーディーに解消できます。以下のよくある質問で答えが得られなかった場合、APIガイドで必要な内容をご確認ください。
Q. APIは、どのように使用すればよいですか?
A. 作成した認証キーの Access keyと Secret keyを確認して、APIを呼び出す際に使用するヘッダ値に追加して使用します。詳細内容は、APIガイドをご参照ください。
Q. 作成した API認証キーは、どこで確認できますか?
A. API認証キーは、NAVERクラウドプラットフォームポータルにログインすると表示されるマイページメニューのアカウント管理 > 認証キー管理で確認できます。認証キー管理の使用方法の詳細は、Ncloud APIをご参照ください。
Q. 特定の APIデータタイプを使用する関連オペレーションを確認するには、どうすればよいですか?
A. APIガイドで提供されている検索ボックスに関連オペレーションを入力して、検索結果を確認してください。
Q. 他のユーザーの APIを呼び出す場合も、課金が発生しますか?
A. APIを呼び出したユーザーではない APIを登録したユーザーに、課金が行われます。
Q. NAVERクラウドプラットフォームポータルで、AI·NAVER APIというサービスカテゴリは確認できません。
A. NAVERクラウドプラットフォームポータルは、ユーザーの理解に役立つよう、NAVERの人工知能サービス、アプリケーションサービスをサービス特性に応じて、AIサービスとアプリケーションサービスのみにカテゴリを区分しています。一方、コンソールではユーザーが使いやすいように、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クラウドプラットフォームポータルの カスタマーサポート > サポートセンター > 問い合わせ メニューを順にクリックしてお問い合わせください。