API Gateway:SDKを使用したAPIの呼び出し

概要

API Gatewayで自動的に生成されるSDKは、署名メカニズムと統合されます。 署名メカニズムを使用することで、署名を計算する必要はありません。 クライアントで署名を計算する場合は、「ダイジェスト認証を使用してAPIを呼び出す」をご参照ください。

APIを呼び出す前に行う必要のある準備については、「HTTPタイプのバックエンドサービスでAPIを作成する」をご参照ください。 SDKを使用して呼び出すAPIは、次の条件を満たす必要があります。

• APIは、Alibaba Cloud Appセキュリティ認証方式を使用します。

• アプリは、APIを呼び出す前に承認されます。

• APIは本番環境に公開されます。

1. SDKのダウンロード

次のいずれかの方法を使用して、API GatewayコンソールでSDKをダウンロードできます。

方法1コンソールの左側のナビゲーションペインで、[APIの呼び出し] > [許可されたAPI SDK] を選択します。 SDKページで、アプリ用に生成されたSDKをダウンロードします。 API Gatewayは、Objective-C、Android、およびJavaのSDKを自動的に生成します。 他のプログラミング言語のSDKの詳細については、SDKページの他のプログラミング言語の呼び出し例 (参照のみ) セクションを参照してください。

方法2コンソールの左側のナビゲーションペインで、[OpenAPI] > [SDK] を選択します。 SDKページで、APIグループ用に生成されたSDKをダウンロードします。 API Gatewayは、Objective-C、Android、Java、Golang、およびTypeScriptのSDKを自動的に生成します。

2. SDKを使用してAPIを呼び出す

次の図は、API Gatewayコンソールからダウンロードした解凍済みSDKパッケージのディレクトリ構造を示しています。

• sdkフォルダ

* sdk/{{regionId}} 'SDK for Javaフォルダ。 フォルダには、各グループのすべてのAPIを呼び出すコードが含まれています。

* HttpApiClient{{group}}.java 'HTTP経由で特定のグループのAPIを呼び出す方法について説明します。

* HttpsApiClient{{group}}.java 'HTTPS経由で特定のグループのAPIを呼び出す方法について説明します。

* WebSocketApiClient{{group}}.java 'WebSocketを介して特定のグループのAPIを呼び出す方法について説明します。

* Demo{{group}}.java '特定のグループ内のすべてのAPI呼び出しのサンプルコードが含まれています。'

• doc/{{regionId}} フォルダ

* ApiDocument _{{ group}}.md '特定のグループのAPIドキュメントを示します。'

• libフォルダ

* sdk-core-java-1.1.5.jar 'SDKのコアパッケージ。 コアパッケージは、SDKの依存関係です。

* 「依存関係のソースコード」をsdk-core-java-1.1.5-sources.jarします。

* 「コアパッケージのJARファイル」をsdk-core-java-1.1.5-javadoc.jarします。

Readme.md「SDKのユーザーガイド」

ライセンス「ライセンス」

SDKの使用方法については、「Readme.md」をご参照ください。

注: AppKeyとAppSecretは、API Gatewayでユーザーリクエストを認証するために使用されます。 AppKeyとAppSecretがクライアントに保存されている場合は、それらを暗号化します。

3. トラブルシューティング

SDKを使用してAPIを呼び出すときにエラーが発生した場合は、X-Ca-request-IDヘッダーからリクエストIdを取得して、問題のトラブルシューティングを行うことができます。 詳細については、「APIデバッグ中に発生する問題のトラブルシューティング」をご参照ください。