Classic/VPC環境で利用できます。
API Gatewayは、APIの呼び出しに関連したすべての操作を手軽に管理できる NAVERクラウドプラットフォームのサービスです。API Gatewayサービスでは、APIを安定して運用するためのさまざまな管理機能や、利用状況をリアルタイムで確認できるダッシュボード機能に関する APIを RESTful形式で提供します。
API Gatewayの共通設定
API Gateway APIで共通して使用されるリクエスト形式とレスポンス形式を説明します。
リクエスト
共通リクエスト形式を説明します。
API URL
リクエスト API URLは次の通りです。
https://apigateway.apigw.ntruss.com
リクエストヘッダ
リクエストヘッダの説明は次の通りです。
| フィールド | 必須の有無 | 説明 |
|---|---|---|
x-ncp-apigw-timestamp |
Required | 1970年1月1日00:00:00協定世界時(UTC)からの経過時間(ミリ秒)
|
x-ncp-iam-access-key |
Required | NAVERクラウドプラットフォームから発行された Access Key
|
x-ncp-apigw-signature-v2 |
Required | NAVERクラウドプラットフォームから発行された Access Keyとマッピングする Secret Keyと HMAC暗号化アルゴリズム(HmacSHA256)でリクエスト情報を暗号化した後、Base64でエンコードした署名 |
Content-Type |
Required | リクエストボディの Content-Typeをapplication/jsonに指定
|
レスポンス
共通レスポンス形式を説明します。
レスポンスボディ
レスポンスボディの説明は次の通りです。
error
errorは API呼び出し失敗情報を定義します。errorの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
errorCode |
String | Required | エラーコード |
message |
String | Required | エラーメッセージ |
details |
String | Optional | エラーの詳細情報 |
レスポンスステータスコード
レスポンスステータスコードの説明は次の通りです。
| HTTPステータスコード | コード | メッセージ | 説明 |
|---|---|---|---|
| 200 | - | OK | リクエスト成功 |
| 201 | - | Created | リクエストの結果により新しいリソースが作成される |
| 202 | - | Accepted | リクエストは受付されたが、まだ完了していない |
| 204 | - | No Content | リクエストは成功したが、レスポンスコンテンツがない |
| 400 | 100 | Bad Request Exception | HTTPSプロトコルまたは UTF-8エンコードによるリクエストエラー |
| 401 | 200 | Authentication Failed | リクエストしたリソースを使用するための認証情報が提供されていないか、有効ではない |
| 401 | 210 | Permission Denied | リクエストしたリソースに対する権限がない |
| 403 | 230 | Forbidden | リクエストしたリソースに対する権限がない |
| 404 | 300 | Not Found Exception | リクエストされたリソースが見つからない |
| 429 | 400 | Quota Exceeded | API使用上限(Quota)を超過 |
| 429 | 410 | Throttle Limited | APIリクエスト速度を超過 |
| 429 | 420 | Rate Limited | APIリクエスト速度を超過 |
| 413 | 430 | Request Entity Too Large | リクエストボディサイズが、サーバが処理可能な上限を超過 |
| 415 | 440 | Unsupported Media Type | サポートしないメディアタイプ |
| 503 | 500 | Endpoint Error | エンドポイント接続エラー |
| 504 | 510 | Endpoint Timeout | エンドポイント接続時間の超過 |
| 503 | 520 | Unknown Endpoint Domain | エンドポイントが認識されないか、設定されていない |
| 503 | 530 | Connection Closed By Endpoint | エンドポイントで接続終了 |
| 500 | 900 | Unexpected Error | 予期せぬ状況によりリクエスト処理失敗 |
参考
NAVERクラウドプラットフォームで共通して使用されるレスポンスステータスコードの詳細は、Ncloud APIのレスポンスステータスコードをご参照ください。
レスポンス例
呼び出しが成功した場合のレスポンス例は、API仕様書を確認してください。呼び出しに失敗した場合のレスポンスのサンプルコードは次の通りです。
{
"error": {
"errorCode": "200",
"message": "Authentication Failed",
"details": "Invalid authentication information."
}
}
API Gateway API
API Gatewayサービスで提供する APIの説明は次の通りです。
| 分類 | 説明 |
|---|---|
| API | APIの作成、照会、変更、削除、デプロイ、公開および Swaggerのインポート |
| API Key | API Key API Keyの作成、照会、変更、削除、再作成および Productのサブスクリプション |
| Authorizer | 認証方式として使用する Authorizerの作成、照会、変更、削除、テスト |
| Canary Test | Canaryの有効化、無効化、変更、昇格およびドキュメント/SDKのエクスポート |
| Dashboard API Key | API Key基準のダッシュボードデータ、API、Productの照会およびエクセルへのエクスポート |
| Dashboard Event | APIのイベント履歴の照会 |
| Dashboard Product | Product基準のダッシュボードデータ、API、Productの照会およびエクセルへのエクスポート |
| Document | Stageにデプロイされた APIドキュメントの照会および変更 |
| Export | デプロイされた APIを Swagger、OpenAPI、Java SDK形式でエクスポート |
| Gateway Response | ゲートウェイレスポンスの照会、ステータスコードの追加、リセット |
| Gateway Response Header | ゲートウェイレスポンスへのカスタムヘッダの追加、削除 |
| Gateway Response Template | ゲートウェイレスポンス本文のマッピングテンプレートの追加、変更、削除 |
| Method | Resourceへのメソッドの追加、照会、変更、削除、および Consumer/Produceの設定 |
| Method Request Body | メソッドのリクエストボディの保存、照会、削除 |
| Method Request Parameter | メソッドのリクエストパラメータ(ヘッダ、クエリ文字列)の追加、照会、削除 |
| Method Response | メソッドのレスポンスステータスコードの追加、照会、変更、削除 |
| Method Response Body | メソッドのレスポンスボディの保存、照会、削除 |
| Method Response Header | メソッドのレスポンスヘッダの追加、照会、削除 |
| Model | リクエスト/レスポンスのボディモデルの追加、照会、変更、削除、およびプレビュー |
| Product | Productの作成、照会、変更、削除 |
| Published Product | すべてのアカウントに公開されている Productおよび APIドキュメントの照会 |
| Resource | APIリソースの作成、照会、変更、削除、および Swaggerのインポート |
| Stage | Stageの作成、照会、変更、削除、デプロイ、Usage Planとの連携、およびキャッシュのリセット |
| Stage Deployment | Stageのデプロイ履歴および公開済みドキュメントの照会 |
| Stage Resource | Stageのメソッド設定の照会および上書き |
| Usage Plan | Usage Planの作成、照会、変更、削除、および関連付けられた Stageの照会 |
API Gateway関連リソース
API Gateway APIについてユーザーの理解に役立つよう、さまざまな関連リソースを提供しています。
- API Gateway APIの使用方法
- 署名(シグネチャー)の作成: リクエストヘッダに追加する署名の作成方法
- Sub Accountご利用ガイド: リクエストヘッダに追加する Access Keyの発行方法
- Ncloudの共通レスポンスステータスコード: API Gatewayサービスで使用される NAVERクラウドプラットフォームの共通レスポンスステータスコード情報
- API Gatewayサービスの使用方法
- API Gatewayご利用ガイド: NAVERクラウドプラットフォームコンソールで API Gatewayを使用する方法
- Ncloud使用環境ガイド: VPC、Classic環境とサポート有無に関するガイド
- 料金の紹介、特徴、詳細機能: API Gatewayの料金体系、特徴、詳細機能のサマリー
- サービス関連の最新のお知らせ: API Gatewayサービス関連の最新共有ニュース
- よくある質問: API Gatewayサービスに関するよくある質問
- お問い合わせ: APIガイドだけでは不明な点が解消されない場合、直接問い合わせ