API が公開され、API を呼び出す権限が付与された後、簡易認証または署名認証方式を選択して API を呼び出すことができます。簡易認証を選択した場合は、リクエストヘッダーに AppCode を追加する必要があります。署名認証を選択した場合は、リクエストヘッダーに AppKey と AppSecret を追加する必要があります。このトピックでは、API を呼び出すための認証情報を取得する方法と、API を呼び出す方法について説明します。
前提条件
呼び出す API が API Gateway に公開されています。詳細については、「API の公開」をご参照ください。
API を呼び出す前に、以下の情報を取得する必要があります。
呼び出す API のパラメーター定義。
API の呼び出しに使用するアプリ。アプリには、ユーザーを一意に識別するキーペアがあります。キーペアは、AppKey と AppSecret で構成されます。
API とアプリの関係。アプリは、API を呼び出す権限を持っている必要があります。詳細については、「API 承認」をご参照ください。
背景情報
API Gateway では、SDK を使用して、アプリに API を呼び出す権限を付与できます。自分のアカウント、企業内のユーザー、またはサードパーティに API を呼び出す権限を付与できます。
手順
API を取得します。
次のいずれかの方法で API を取得できます。
Alibaba Cloud Marketplace で API を購入します。購入した API のリストを表示する方法については、[alibaba Cloud Marketplace コンソール] にログインしてください。
API プロバイダーから API 承認を取得します。呼び出しが承認されている API を表示する方法については、[API Gateway コンソール] にログインしてください。
アプリを作成します。
API Gateway では、アプリは API を呼び出すために使用する ID を定義します。各アプリには、アカウントとそのパスワードに相当する AppKey と AppSecret で構成されるキーペアがあります。アプリの作成方法の詳細については、「アプリの作成」をご参照ください。
API を呼び出すために必要な権限を取得します。
承認とは、アプリに API を呼び出すために必要な権限を付与することです。API を呼び出すには、アプリに必要な権限が付与されている必要があります。
承認方法は、API の取得方法によって異なります。詳細については、「API 承認」をご参照ください。
API を呼び出します。
HTTP または HTTPS リクエストを送信して API を呼び出すことができます。API を呼び出す前に、API Gateway コンソールで複数の言語の API 呼び出しの例を使用して、呼び出しをテストできます。詳細については、「API 呼び出しの例」および「API 操作で HTTPS を有効にする」をご参照ください。
API を呼び出すための認証情報を表示する
DataWorks コンソール にログインします。上部のナビゲーションバーで、目的のリージョンを選択します。左側のナビゲーションペインで、 を選択します。表示されるページで、ドロップダウンリストから目的のワークスペースを選択し、[dataservice Studio に移動] をクリックします。
DataService Studio ページの上部ナビゲーションバーで、[サービス管理] タブをクリックします。
左側のナビゲーションペインで、[API の呼び出し] をクリックします。
[API の呼び出し] ページで、ビジネス要件に基づいて API を呼び出すために必要な認証情報を表示またはコピーできます。