DataService Studio は、API 呼び出しに 2 つの認証方式をサポートしています。[シンプル認証] (AppCode) と [署名認証] (AppKey + AppSecret) です。このトピックでは、認証情報を取得し、最初の認証済みリクエストを行う方法について説明します。
前提条件
開始する前に、以下を確保してください。
API Gateway に公開された API。「API の公開」をご参照ください。
API のパラメーター定義
有効なキーペア (AppKey と AppSecret) を持つアプリケーション。「アプリケーションの作成」をご参照ください。
ご利用のアプリケーションが API を呼び出すための権限付与。「API 権限付与」をご参照ください。
背景情報
API Gateway を使用すると、SDK を利用してアプリケーションに API 呼び出しの権限を付与できます。ご自身のアカウント、企業内のユーザー、またはサードパーティに API 呼び出しの権限を付与できます。
認証方式の選択
| 方式 | リクエストヘッダーで送信する内容 | 使用するタイミング |
|---|---|---|
| シンプル認証 | AppCode | クイックインテグレーション、セキュリティ要件が低い場合 |
| 署名認証 | AppKey と AppSecret | 本番ワークロード、セキュリティ要件が高い場合 |
API アクセスの設定
ステップ 1: API の取得
以下のいずれかのチャネルを通じて API へのアクセスを取得します。
[Alibaba Cloud Marketplace]: API を購入し、Alibaba Cloud Marketplace コンソールで確認できます。
[API プロバイダーによる権限付与]: API オーナーに権限付与をリクエストし、API Gateway コンソールで API を表示します。
ステップ 2: アプリケーションの作成
API Gateway では、アプリケーションが呼び出し元 ID を定義します。各アプリケーションには、ユーザー名とパスワードのように機能するキーペア (AppKey と AppSecret) があります。
まだ作成していない場合は、API Gateway で「アプリケーションの作成」をご参照ください。
ステップ 3: アプリケーションの権限付与
権限付与により、ご利用のアプリケーションは特定の API を呼び出す権限を得ます。権限付与方式は、API を取得した方法によって異なります。
詳細については、「API 権限付与」をご参照ください。
ステップ 4: 認証情報の取得
[DataWorks コンソール] にログインします。上部のナビゲーションバーで、リージョンを選択します。左側のナビゲーションウィンドウで、[データ分析とサービス] > [DataService Studio] を選択します。ドロップダウンリストからワークスペースを選択し、[DataService Studio に移動] をクリックします。
DataService Studio ページの上部のナビゲーションバーで、[サービス管理] をクリックします。
左側のナビゲーションウィンドウで、[API の呼び出し] をクリックします。
「[API の呼び出し]」ページで、ビジネス要件に応じて API を呼び出すために必要な認証情報を表示またはコピーします。
検証： [API の呼び出し] ページに認証情報が表示されます。ページが Empty の場合、アプリケーションが API を呼び出すための承認を受けてあることを確認してください。
ステップ 5: API の呼び出し
リクエストヘッダーに認証情報を含めて HTTP または HTTPS リクエストを送信します。API を呼び出す前に、API Gateway コンソールで多言語の API 呼び出し例を使用して呼び出しをテストできます。
詳細については、「API 呼び出しの例」および「API オペレーションの HTTPS 有効化」をご参照ください。
次のステップ
API 呼び出しの例 — 認証済み呼び出しを行うための多言語 SDK の例
API 権限付与 — どのアプリケーションがどの API を呼び出せるかを管理