APIゲートウェイ

[更新日:2025年2月18日]

サービス基本情報

概要

「APIゲートウェイ」は、HTTP/HTTPS プロトコルを使用した API を簡単に作成、公開することができるマネージドサービスです。

機能説明

APIゲートウェイ で管理する API を登録/参照/変更/削除することができます。
受け付けた要求(Request)をバックエンドのサービスに適切なフォーマット変換して転送することができます。
認証機能を用いて、APIごとにユーザ認証が行えます。

認証方法

BASIC認証

HMAC認証

JWT

契約プランに応じて、レート制限(リクエスト数制限)が適用されます。各プランごとに設定されたリクエスト数の上限を超えると、追加のリクエストは拒否されます。

β版における注意事項と制限事項

ご利用いただく前に、以下の点にご注意ください。

  • 品質保証(SLA)の適用対象外です。

  • サポートは限定的となり、利用状況によっては一時的に利用が制限される場合があります。

プラン

料金

サービス作成数

最大リクエスト数/秒

Trial

無料

1

10

想定される利用シーン

APIゲートウェイは、APIの管理やセキュリティ強化、リクエストの最適なルーティングを実現するために利用できます。
以下は具体的な利用シーンの例です。

例: APIのセキュリティ強化とアクセス制御

APIを外部に公開する際、不正アクセスの防止やユーザーごとのアクセス権管理が求められます。
例えば、企業向けSaaSサービスにおいて、特定のIPアドレスからのみ管理者APIへのアクセスを許可し、一般ユーザーには閲覧専用のAPIのみ利用可能にする必要があります。

料金体系

β版での提供期間中は無償でご利用いただけます。
正式版リリースに伴う課金開始の際には、事前にアナウンスさせていただきます。

サポート

ご不明点やお困りの際は、 会員メニュー内のメールサポート より、サービス情報を「さくらのクラウド」としてお問い合わせください。

利用手順

クラウドコントロールパネルのホーム画面より APIゲートウェイ をクリックし、APIゲートウェイ管理画面に移動します。

注意

管理者が ユーザ・アカウント機能 機能を使用して作成した個別のユーザがAPIゲートウェイを利用する場合、ユーザ管理画面で該当ユーザに対するAPIゲートウェイへのアクセス権限を付与する設定が必要となります(権限が付与されていない場合はホーム画面に「APIゲートウェイ」が表示されません)。
設定方法については ユーザ・アカウント機能 のページを参照ください。

APIゲートウェイ有効化

1.APIゲートウェイのアプリケーション画面にアクセスし、ご契約いただくプランを選択してください。

プランの選択

2.その後、プラン開始ボタンを押すことで、APIゲートウェイの利用を開始できます。

API Gatewayの利用を開始

API経由でのご利用方法

API Gateway の設定は管理画面からのみでなく、API でも設定をすることが可能です。

認証

さくらのクラウド API は API キーとシークレットトークンを利用した Basic 認証または Digest 認証を使用します。 APIキーとシークレットトークンは、コントロールパネルの APIキー管理 で発行または確認できます。

OpenAPI仕様

詳しくは下記 OpenAPI 仕様ページをご覧ください。

管理画面経由でのご利用方法

管理画面を利用したAPI Gatewayの利用方法について、説明します。

API Gatewayの主な利用シーンにおける設定手順を以下ページで説明します。