翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

# REST API 接続の統合
<a name="rest-api-integration"></a>

Amazon Quick の REST API Connection 統合を使用すると、カスタム REST APIs とウェブサービスを使用してアクションを実行できます。この統合は、アクションの実行のみをサポートします。

## できること
<a name="rest-api-integration-capabilities"></a>

REST API Connection 統合を使用すると、 アクションコネクタを介してカスタム REST APIs とウェブサービスでアクションを実行できます。

**アクションコネクタ**  
柔軟な認証オプションを使用して、HTTP リクエストの実行、データの取得、APIsの操作を行います。

**注記**  
REST API Connection 統合は、データアクセスやナレッジベースの作成をサポートしていません。これは、カスタムウェブサービスとのタスク実行と API インタラクション専用に設計されています。

## [開始する前に]
<a name="rest-api-integration-prerequisites"></a>

REST API 統合を設定する前に、以下があることを確認してください。
+ 適切なアクセス許可を持つ REST API エンドポイント。
+ API 認証情報 (OAuth、API キー、その他）。
+ ターゲットウェブサービスの API ドキュメント。

## API エンドポイントと認証を準備する
<a name="rest-api-integration-authentication"></a>

Amazon Quick で統合を設定する前に、REST API エンドポイントと認証情報を準備します。REST API Connection 統合は、複数の認証方法をサポートしています。API 要件に一致する方法を選択します。

**ユーザー認証 (OAuth)**  
API プロバイダーから次の情報を収集します。  
+ **ベース URL** - REST API ベース URL。
+ **クライアント ID** - OAuth アプリケーションクライアント ID。
+ **クライアントシークレット** - OAuth アプリケーションクライアントシークレット。
+ **トークン URL** - OAuth トークンエンドポイント。
+ **認証 URL** - OAuth 認可エンドポイント。
+ **リダイレクト URL** - OAuth リダイレクト URI。

**サービス認証 (Service-to-service OAuth)**  
API プロバイダーから次の情報を収集します。  
+ **認証タイプ** - OAuth 2.0 クライアント認証情報付与フローはservice-to-service認証用です。
+ **ベース URL** - REST API ベース URL。
+ **クライアント ID** - サービス認証用の OAuth アプリケーションクライアント識別子。
+ **クライアントシークレット** - サービス認証用の OAuth アプリケーションクライアントシークレット。
+ **トークン URL** - アクセストークンを取得するための OAuth トークンエンドポイント。

### カスタムヘッダーとパラメータ
<a name="rest-api-custom-headers"></a>

カスタムヘッダーとパラメータを使用して、柔軟な認証と API 操作を行うことができます。
+ カスタム認証ヘッダー。
+ API バージョンヘッダー。
+ Content-Type の仕様。
+ カスタムクエリパラメータ。

## REST API 統合をセットアップする
<a name="rest-api-integration-setup"></a>

API エンドポイントと認証情報を準備したら、以下の手順に従って REST API 統合を作成します。

1. Amazon Quick コンソールで、**統合**を選択します。

1. 統合オプションから **REST API 接続**を選択し、追加 (プラス「＋」) ボタンをクリックします。

1. 統合の詳細を入力します。
   + **名前** - REST API 統合の説明名。
   + **説明** (オプション) - 統合の目的。

1. 接続タイプを選択します。
   + **ユーザー認証** - 個々のユーザーアクセスのための OAuth ベースの認証。
   + **サービス認証** - サービスアクセス用の API キーベースの認証。

1. 選択した認証方法 (ユーザーまたはサービス) に基づいて接続設定を入力します。

1. **[次へ]** を選択してください。

1. 使用可能なアクションを確認します。

1. **作成して続行**を選択します。

## 使用可能なタスクアクション
<a name="rest-api-integration-actions"></a>

REST API 統合を作成したら、REST API を操作するために使用可能なアクションを確認できます。一般的な REST API アクションは次のとおりです。
+ データ取得のための HTTP GET リクエスト。
+ データ作成のための HTTP POST リクエスト。
+ データ更新の HTTP PUT/PATCH リクエスト。
+ データ削除の HTTP DELETE リクエスト。
+ カスタムエンドポイントインタラクション。
+ JSON および XML データ処理。
+ クエリパラメータとヘッダー管理。

**注記**  
使用できる特定のアクションは、REST API エンドポイントと、統合用に設定された認証アクセス許可によって異なります。

## API 設定オプション
<a name="rest-api-integration-configuration"></a>

REST API 統合のさまざまな側面を、特定の要件に合わせて設定できます。

### エンドポイント設定
<a name="rest-api-endpoint-configuration"></a>

これらのエンドポイント設定を構成します。
+ ベース URL とエンドポイントパス。
+ HTTP メソッドの仕様。
+ リクエストとレスポンスの形式処理。
+ エラー処理と再試行ロジック。

### データの処理
<a name="rest-api-data-handling"></a>

統合がさまざまなデータ形式を処理する方法を設定します。
+ JSON リクエストとレスポンスの処理。
+ XML データ変換。
+ フォームデータとマルチパートアップロード。
+ バイナリデータ処理。

## REST API 統合の管理
<a name="rest-api-integration-management"></a>

REST API 統合を作成したら、以下のオプションを使用して管理できます。
+ **統合の編集** - 認証設定、ベース URL、または API 設定を更新します。
+ **統合の共有** - 組織内の他のユーザーが統合を利用できるようにします。
+ **使用状況のモニタリング** - 統合アクティビティと API コールメトリクスを表示します。
+ **アクションの確認** - 使用可能な REST API アクションの完全なリストを参照してください。
+ **エンドポイントのテスト** - API の接続と認証を検証します。
+ **統合の削除** - 統合を削除し、関連する認証を取り消します。

**重要**  
REST API 統合は、ターゲットウェブサービスの可用性と設定によって異なります。API または認証要件を変更すると、統合機能に影響する可能性があります。