APIゲートウェイ
[更新: 2025年11月17日]
サービス基本情報
概要
「APIゲートウェイ」は、HTTP/HTTPS プロトコルを使用した API を簡単に作成、公開することができるマネージドサービスです。
機能説明
APIゲートウェイ で管理する API を登録/参照/変更/削除することができます。
受け付けた要求(Request)をバックエンドのサービスに適切なフォーマット変換して転送することができます。
認証機能を用いて、APIごとにユーザ認証が行えます。
認証方法 |
|---|
BASIC認証 |
HMAC認証 |
JWT |
OIDC認証 |
注意事項と制限事項
ご利用いただく前に、以下の点にご注意ください。
サポートは限定的となり、利用状況によっては一時的に利用が制限される場合があります。
料金体系
APIゲートウェイサービスの利用料金については、料金表 をご参照ください。
想定される利用シーン
APIゲートウェイは、APIの管理やセキュリティ強化、リクエストの最適なルーティングを実現するために利用できます。
以下は具体的な利用シーンの例です。
例: APIのセキュリティ強化とアクセス制御
APIを外部に公開する際、不正アクセスの防止やユーザーごとのアクセス権管理が求められます。
例えば、企業向けSaaSサービスにおいて、特定のIPアドレスからのみ管理者APIへのアクセスを許可し、一般ユーザーには閲覧専用のAPIのみ利用可能にする必要があります。
サポート
ご不明点やお困りの際は、 会員メニュー内のメールサポート より、サービス情報を「さくらのクラウド」としてお問い合わせください。
利用手順
クラウドコントロールパネルのホーム画面より APIゲートウェイ をクリックし、APIゲートウェイ管理画面に移動します。
注意
管理者が ユーザ・プロジェクト機能 機能を使用して作成した個別のユーザがAPIゲートウェイを利用する場合、ユーザ管理画面で該当ユーザに対するAPIゲートウェイへのアクセス権限を付与する設定が必要となります(権限が付与されていない場合はホーム画面に「APIゲートウェイ」が表示されません)。
設定方法については ユーザ・プロジェクト機能 のページを参照ください。
APIゲートウェイ有効化
1.APIゲートウェイのアプリケーション画面にアクセスし、新規契約ボタンを押下します。
2.契約名を入力後、契約ボタンを押すことで、APIゲートウェイの利用を開始できます。
API経由でのご利用方法
APIゲートウェイ の設定は管理画面からのみでなく、API でも設定をすることが可能です。
認証
さくらのクラウド API は API キーとシークレットトークンを利用した Basic 認証または Digest 認証を使用します。 APIキーとシークレットトークンは、コントロールパネルの APIキー管理 で発行または確認できます。
OpenAPI仕様
詳しくは下記 OpenAPI 仕様ページをご覧ください。
APIゲートウェイ APIドキュメント – RESTful APIを利用した操作が可能
管理画面経由でのご利用方法
管理画面を利用したAPIゲートウェイの利用方法について、説明します。
APIゲートウェイの主な利用シーンにおける設定手順を以下ページで説明します。
モニタリングスイート連携機能
APIゲートウェイのメトリクス一覧やモニタリング機能を説明します。
詳しい内容や設定は モニタリングスイートのマニュアル をご覧ください。