HTTP Connector は、専用のコネクタで現在サポートされていないクラウドアプリケーションを接続します。HTTP Connector を使用して、コンポーザーで現在サポートされていないシステムに接続し、コンポーネントでサポートされていないシステムの機能を拡張します。HTTP Connector for Composer は、 HTTP 1.1 を使用して JSON データを処理します。
Connections (接続)
システムに接続するには、システムがデータの取得元であるか、データの取得先であるかに関係なく、そのシステムの必要なログイン情報を使用して接続を作成する必要があります。通常、フロー内の異なるシステムに接続し、接続が必要になるたびに各接続を再利用できます。
次の接続情報を入力します。
| HTTP 応答タイムアウトは 60 秒で、変更できません。 |
include:composer::_partials/connection-name.adoc[]
- ベース URL
-
接続で使用するクラウドアプリケーションのデフォルトの場所の URL。
- Authorization (認証)
-
次の認証オプションを使用できます。
-
OAuth 2.0 Client Credentials (OAuth 2.0 クライアントログイン情報)
OAuth 2.0 クライアントログイン情報では、ユーザー定義パスからアクセストークンが取得されます。次の項目の値を指定します。-
Base URL (ベース URI)
-
Client ID (クライアント ID)
-
Client Secret (クライアントシークレット)
-
Token URL (トークン URL)
-
-
API キー
API キーは、ユーザーを明示的に定義せずにアプリケーションに接続します。このキーをすべての要求に追加する必要があります。クラウドアプリケーションは、要求元を識別して認証を完了します。次の項目の値を指定します。-
Base URL (ベース URI)
-
Name (名前)
-
値
-
Sent As (送信形式): 次のいずれかの値を選択します。
-
Header (ヘッダー): 選択した場合、コンポーザーは
Name: Value というヘッダーを要求に追加します。 -
Query Parameter (クエリパラメーター): 選択した場合、コンポーザーは
Name=Value というクエリパラメーターを要求に追加します。
-
-
-
基本認証
基本認証メソッドを使用すると、HTTP ユーザーエージェントは HTTP 要求を行うときにユーザー名とパスワードを指定できます。次の項目の値を指定します。-
Base URL (ベース URI)
-
Username (ユーザー名)
-
Password (パスワード)
-
-
ベアラートークン認証 ベアラートークン認証は、
Bearer という値とトークンが含まれる Authorization というヘッダーを要求ごとに送信する認証プロセスです。次の項目の値を指定します。-
Base URL (ベース URI)
-
Token (トークン)
-
-
OAuth 2.0 を使用したコンポーザーでの対象システムの接続
HTTP Connector を使用すると、 OAuth 2.0 認証コード許可との接続を確立して、認証を有効にすることができます。この認証により、Salesforce、Gmail、Outlook 365 などの他のアプリケーションによってホストされるリソースにアクセスできるようになります。
接続を確立する前に、対象システムで OAuth クライアントを作成する必要があります。OAuth クライアントを作成するプロセスは、各対象システムによって異なります。
次の表に、OAuth クライアントを使用して対象システムに接続する場合の設定例と必須項目の詳細を示します。
Fortnox
| 異なるフローで同じクライアント ID とクライアントシークレットを使用するには、同じコンポーザー接続を使用し、1 分あたりに許可される要求数を考慮します。別のコンポーザー接続を使用するには、別の Fortnox 環境を使用します。 |
| Step (ステップ) | 項目 | 値の例。 | 注記 |
|---|---|---|---|
HTTP アカウントに接続する |
Connection Display Name (接続表示名) |
|
これはユーザーである必要があります。 |
Authorization Type (認証種別) |
|
この項目の値は固定です。 |
|
Base URL (ベース URI) |
|
||
Client ID (クライアント ID) |
|
||
Client Secret (クライアントシークレット) |
|
||
Scopes (スコープ) |
|
すべての使用可能なスコープについては、 「OAuth 2.0 Scopes for Fortnox APIs (Fortnox API の OAuth 2.0 スコープ)」を参照してください。 |
|
Authorization URL (認証 URL) |
|
Fortnox アカウントで作成されたアプリケーションでコールバック URL を登録する必要があります。Fortnox では、アプリケーションごとに 1 つのコールバック URL しか指定できないため、異なる環境のコールバック URL を指定するには、異なるアプリケーションを作成する必要があります。 |
|
Authorization URL Query Parameters (認証 URL クエリパラメーター) |
パラメーター 1:
|
||
Token Exchange URL (トークンエクスチェンジ URL) |
|
||
Token Exchange Headers (トークンエクスチェンジヘッダー) |
パラメーター 1:
|
Fortnox では、
詳細は、 「認証」を参照してください。 |
|
Token Refresh URL (トークン更新 URL) |
|
||
Token Refresh Headers (トークン更新ヘッダー) |
パラメーター 1:
|
Fortnox では、
詳細は、 「認証」を参照してください。 |
|
Access Token Expired Code (アクセストークン期限切れコード) |
|
||
HTTP 接続をテスト |
Request Method (要求方法) |
|
|
Request Path (要求パス) |
|
Gmail
| Step (ステップ) | 項目 | 値の例。 | 注記 |
|---|---|---|---|
HTTP アカウントに接続する |
Connection Display Name (接続表示名) |
|
Gmail のメールアドレスを含めると、リストから接続を特定するのに役立ちます。 |
Authorization Type (認証種別) |
|
この項目の値は固定です。 |
|
Base URL (ベース URI) |
|
||
Client ID (クライアント ID) |
|
||
Client Secret (クライアントシークレット) |
|
||
Scopes (スコープ) |
|
すべての使用可能なスコープについては、 「OAuth 2.0 Scopes for Google APIs (Google API の OAuth 2.0 スコープ)」を参照してください。 |
|
Authorization URL (認証 URL) |
|
||
Authorization URL Query Parameters (認証 URL クエリパラメーター) |
パラメーター 1:
パラメーター 2:
|
||
Token Exchange URL (トークンエクスチェンジ URL) |
|
||
Token Refresh URL (トークン更新 URL) |
|
||
Token Revoke URL (トークン取り消し URL) |
|
||
Access Token Expired Code (アクセストークン期限切れコード) |
|
||
HTTP 接続をテスト |
Request Method (要求方法) |
|
|
Request Path (要求パス) |
|
詳細は Gmail API ドキュメントを参照してください。 |
Google カレンダー
| Step (ステップ) | 項目 | 値の例。 | 注記 |
|---|---|---|---|
HTTP アカウントに接続する |
Connection Display Name (接続表示名) |
|
Gmail のメールアドレスを含めると、リストから接続を特定するのに役立ちます。 |
Authorization Type (認証種別) |
|
この項目の値は固定です。 |
|
Base URL (ベース URI) |
|
||
Client ID (クライアント ID) |
|
||
Client Secret (クライアントシークレット) |
|
||
Scopes (スコープ) |
|
すべての使用可能なスコープについては、 「OAuth 2.0 Scopes for Google APIs (Google API の OAuth 2.0 スコープ)」を参照してください。 |
|
Authorization URL (認証 URL) |
|
||
Authorization URL Query Parameters (認証 URL クエリパラメーター) |
パラメーター 1:
パラメーター 2:
|
||
Token Exchange URL (トークンエクスチェンジ URL) |
|
||
Token Refresh URL (トークン更新 URL) |
|
||
Token Revoke URL (トークン取り消し URL) |
|
||
Access Token Expired Code (アクセストークン期限切れコード) |
|
||
HTTP 接続をテスト |
Request Method (要求方法) |
|
|
Request Path (要求パス) |
|
詳細は、 Google カレンダー API ドキュメントを参照してください。 |
Google スプレッドシート
| Step (ステップ) | 項目 | 値の例。 | 注記 |
|---|---|---|---|
HTTP アカウントに接続する |
Connection Display Name (接続表示名) |
|
Gmail のメールアドレスを含めると、リストから接続を特定するのに役立ちます。 |
Authorization Type (認証種別) |
|
この項目の値は固定です。 |
|
Base URL (ベース URI) |
|
||
Client ID (クライアント ID) |
|
||
Client Secret (クライアントシークレット) |
|
||
Scopes (スコープ) |
|
詳細は、 Google Drive の「API 固有の承認および認証情報」ドキュメントを参照してください。 |
|
Authorization URL (認証 URL) |
|
||
Authorization URL Query Parameters (認証 URL クエリパラメーター) |
パラメーター 1:
パラメーター 2:
|
||
Token Exchange URL (トークンエクスチェンジ URL) |
|
||
Token Refresh URL (トークン更新 URL) |
|
||
Token Revoke URL (トークン取り消し URL) |
|
||
Access Token Expired Code (アクセストークン期限切れコード) |
|
||
HTTP 接続をテスト |
Request Method (要求方法) |
|
|
Request Path (要求パス) |
|
詳細は、 Google Drive の「API 固有の承認および認証情報」ドキュメントを参照してください。 |
HubSpot
| Step (ステップ) | 項目 | 値の例。 | 注記 |
|---|---|---|---|
HTTP アカウントに接続する |
Connection Display Name (接続表示名) |
|
Hubspot 組織名を含めると、リストから接続を特定するのに役立ちます。 |
Authorization Type (認証種別) |
|
この項目の値は固定です。 |
|
Base URL (ベース URI) |
|
||
Client ID (クライアント ID) |
|
詳細は HubSpot ドキュメントを参照してください。 |
|
Client Secret (クライアントシークレット) |
|
||
Scopes (スコープ) |
|
||
Authorization URL (認証 URL) |
|
||
Token Exchange URL (トークンエクスチェンジ URL) |
|
||
Token Refresh URL (トークン更新 URL) |
|
||
Access Token Expired Code (アクセストークン期限切れコード) |
|
||
HTTP 接続をテスト |
Request Method (要求方法) |
|
|
Request Path (要求パス) |
|
詳細は、 Hubspot OAuth 2.0 ドキュメントを参照してください。 |
Jira
| Step (ステップ) | 項目 | 値の例。 | 注記 |
|---|---|---|---|
HTTP アカウントに接続する |
Connection Display Name (接続表示名) |
|
Gmail のメールアドレスを含めると、リストから接続を特定するのに役立ちます。 |
Authorization Type (認証種別) |
|
この項目の値は固定です。 |
|
Base URL (ベース URI) |
|
この項目の値は、[Base URL (ベース URL)] 項目の [Tenant ID (テナント ID)] パラメーターである Jira アカウントのクラウド ID です。 |
|
Client ID (クライアント ID) |
|
||
Client Secret (クライアントシークレット) |
|
||
Scopes (スコープ) |
|
||
Authorization URL (認証 URL) |
|
Jira アカウントを作成するときに、コールバック URL を登録する必要があります。 そのため、これらのログイン情報はステージング環境でのみ機能します。 |
|
Authorization URL Query Parameters (認証 URL クエリパラメーター) |
パラメーター 1:
パラメーター 2:
|
||
Token Exchange URL (トークンエクスチェンジ URL) |
|
||
Token Refresh URL (トークン更新 URL) |
|
||
Access Token Expired Code (アクセストークン期限切れコード) |
|
||
HTTP 接続をテスト |
Request Method (要求方法) |
|
|
Request Path (要求パス) |
|
Microsoft Teams
| Step (ステップ) | 項目 | 値の例。 | 注記 |
|---|---|---|---|
HTTP アカウントに接続する |
Connection Display Name (接続表示名) |
|
Microsoft Teams インスタンス名を含めると、リストから接続を特定するのに役立ちます。 |
Authorization Type (認証種別) |
|
この項目の値は固定です。 |
|
Base URL (ベース URI) |
|
||
Client ID (クライアント ID) |
|
||
Client Secret (クライアントシークレット) |
|
||
Scopes (スコープ) |
|
||
Authorization URL (認証 URL) |
|
テナント ID 値:
|
|
Token Exchange URL (トークンエクスチェンジ URL) |
|
||
Token Refresh URL (トークン更新 URL) |
|
||
Access Token Expired Code (アクセストークン期限切れコード) |
|
||
HTTP 接続をテスト |
Request Method (要求方法) |
|
|
Request Path (要求パス) |
|
Outlook 365
| Step (ステップ) | 項目 | 値の例。 | 注記 |
|---|---|---|---|
HTTP アカウントに接続する |
Connection Display Name (接続表示名) |
|
Outlook インスタンス名を含めると、リストから接続を特定するのに役立ちます。 |
Authorization Type (認証種別) |
|
この項目の値は固定です。 |
|
Base URL (ベース URI) |
|
||
Client ID (クライアント ID) |
|
||
Client Secret (クライアントシークレット) |
|
||
Scopes (スコープ) |
|
||
Authorization URL (認証 URL) |
|
||
Token Exchange URL (トークンエクスチェンジ URL) |
|
||
Token Refresh URL (トークン更新 URL) |
|
||
Access Token Expired Code (アクセストークン期限切れコード) |
|
||
HTTP 接続をテスト |
Request Method (要求方法) |
|
|
Request Path (要求パス) |
または
|
Procore (本番環境)
| Step (ステップ) | 項目 | 値の例。 | 注記 |
|---|---|---|---|
HTTP アカウントに接続する |
Connection Display Name (接続表示名) |
|
|
Authorization Type (認証種別) |
|
この項目の値は固定です。 |
|
Base URL (ベース URI) |
|
||
Client ID (クライアント ID) |
|
||
Client Secret (クライアントシークレット) |
|
||
Authorization URL (認証 URL) |
|
||
Token Exchange URL (トークンエクスチェンジ URL) |
|
||
Token Refresh URL (トークン更新 URL) |
|
||
Token Revoke URL (トークン取り消し URL) |
|
||
Access Token Expired Code (アクセストークン期限切れコード) |
|
||
HTTP 接続をテスト |
Request Method (要求方法) |
|
|
Request Path (要求パス) |
|
Procore (Sandbox 環境)
| Step (ステップ) | 項目 | 値の例。 | 注記 |
|---|---|---|---|
HTTP アカウントに接続する |
Connection Display Name (接続表示名) |
|
|
Authorization Type (認証種別) |
|
この項目の値は固定です。 |
|
Base URL (ベース URI) |
|
||
Client ID (クライアント ID) |
|
||
Client Secret (クライアントシークレット) |
|
||
Authorization URL (認証 URL) |
|
||
Token Exchange URL (トークンエクスチェンジ URL) |
|
||
Token Refresh URL (トークン更新 URL) |
|
||
Token Revoke URL (トークン取り消し URL) |
|
||
Access Token Expired Code (アクセストークン期限切れコード) |
|
||
HTTP 接続をテスト |
Request Method (要求方法) |
|
|
Request Path (要求パス) |
|
QuickBooks
QuickBooks はデフォルトで HTML を返すため、要求に Accept: application/json HTTP ヘッダーを追加します。
|
| Step (ステップ) | 項目 | 値の例。 | 注記 |
|---|---|---|---|
HTTP アカウントに接続する |
Connection Display Name (接続表示名) |
|
|
Authorization Type (認証種別) |
|
この項目の値は固定です。 |
|
Base URL (ベース URI) |
|
QuickBooks アカウントで、レルム ID または会社 ID を確認します。例: |
|
Client ID (クライアント ID) |
|
||
Client Secret (クライアントシークレット) |
|
||
Scopes (スコープ) |
|
スコープについての詳細は、QuickBooks アカウントを確認してください。QuickBooks アカウントを作成すると、使用する必要がある URL に応じて 2 つのスコープが生成されます。 |
|
Authorization URL (認証 URL) |
|
アプリケーション設定で QuickBooks アカウントにコールバック URL を登録する必要があります。QuickBooks では複数のコールバック URL を登録できるため、すべての環境に対して 1 つのアプリケーションを作成できます。 |
|
Token Exchange URL (トークンエクスチェンジ URL) |
|
||
Token Exchange Headers (トークンエクスチェンジヘッダー) |
パラメーター 1:
|
||
Token Refresh URL (トークン更新 URL) |
|
||
Token Refresh Headers (トークン更新ヘッダー) |
パラメーター 1:
|
||
Token Revoke URL (トークン取り消し URL) |
|
||
Token Revoke Headers (トークン取り消しヘッダー) |
パラメーター 1:
|
||
Access Token Expired Code (アクセストークン期限切れコード) |
|
||
HTTP 接続をテスト |
Request Method (要求方法) |
|
|
Request Path (要求パス) |
|
Salesforce
| Step (ステップ) | 項目 | 値の例。 | 注記 |
|---|---|---|---|
HTTP アカウントに接続する |
Connection Display Name (接続表示名) |
|
Salesforce インスタンス名を含めると、リストから接続を特定するのに役立ちます。 |
Authorization Type (認証種別) |
|
この項目の値は固定です。 |
|
Base URL (ベース URI) |
|
||
Client ID (クライアント ID) |
|
この項目の値は、[Salesforce Connected App Client ID (Salesforce 接続アプリケーションクライアント ID)] です。 |
|
Client Secret (クライアントシークレット) |
|
この項目の値は、[Salesforce Connected App Secret (Salesforce 接続アプリケーションシークレット)] です。 |
|
Scopes (スコープ) |
|
||
Authorization URL (認証 URL) |
|
||
Authorization URL Query Parameters (認証 URL クエリパラメーター) |
|
||
Token Exchange URL (トークンエクスチェンジ URL) |
|
||
Token Refresh URL (トークン更新 URL) |
|
||
Token Revoke URL (トークン取り消し URL) |
|
||
Access Token Expired Code (アクセストークン期限切れコード) |
|
||
HTTP 接続をテスト |
Request Method (要求方法) |
|
|
Request Path (要求パス) |
|
詳細は、 『Salesforce REST API 開発者ガイド』ドキュメントを参照してください。 |
Shopify
| Step (ステップ) | 項目 | 値の例。 | 注記 |
|---|---|---|---|
HTTP アカウントに接続する |
Connection Display Name (接続表示名) |
|
詳細は Shopify パートナープログラムを参照してください。 |
Authorization Type (認証種別) |
|
この項目の値は固定です。 |
|
Base URL (ベース URI) |
|
||
Client ID (クライアント ID) |
|
||
Client Secret (クライアントシークレット) |
|
||
Scopes (スコープ) |
|
||
Authorize Header (認証ヘッダー) |
|
||
Token Exchange URL (トークンエクスチェンジ URL) |
|
||
Access Token Expired Code (アクセストークン期限切れコード) |
|
||
HTTP 接続をテスト |
Request Method (要求方法) |
|
|
Request Path (要求パス) |
|
Slack
| Step (ステップ) | 項目 | 値の例。 | 注記 |
|---|---|---|---|
HTTP アカウントに接続する |
Connection Display Name (接続表示名) |
|
Slack ワークスペース名を含めると、リストから接続を特定するのに役立ちます。 |
Authorization Type (認証種別) |
|
この項目の値は固定です。 |
|
Base URL (ベース URI) |
|
||
Client ID (クライアント ID) |
|
|
|
Client Secret (クライアントシークレット) |
|
|
|
Scopes (スコープ) |
|
||
Authorization URL (認証 URL) |
|
||
Token Exchange URL (トークンエクスチェンジ URL) |
|
||
Token Refresh URL (トークン更新 URL) |
この項目の値は空白のままにします。 |
||
Token Revoke URL (トークン取り消し URL) |
|
||
Access Token Expired Code (アクセストークン期限切れコード) |
|
||
HTTP 接続をテスト |
Request Method (要求方法) |
|
|
Request Path (要求パス) |
|
Xero
| Step (ステップ) | 項目 | 値の例。 | 注記 |
|---|---|---|---|
HTTP アカウントに接続する |
Connection Display Name (接続表示名) |
|
|
Authorization Type (認証種別) |
|
この項目の値は固定です。 |
|
Base URL (ベース URI) |
|
||
Client ID (クライアント ID) |
|
||
Client Secret (クライアントシークレット) |
|
||
Scopes (スコープ) |
|
詳細は、 Xero Developer ドキュメントを参照してください。 |
|
Authorization URL (認証 URL) |
|
||
Token Exchange URL (トークンエクスチェンジ URL) |
|
||
Token Refresh URL (トークン更新 URL) |
|
||
Token Revoke URL (トークン取り消し URL) |
|
||
Access Token Expired Code (アクセストークン期限切れコード) |
|
||
HTTP 接続をテスト |
Request Method (要求方法) |
|
|
Request Path (要求パス) |
|
詳細は、Xero ドキュメントを参照してください。 |
|
Request Path Headers (要求パスヘッダー) |
|
詳細は、以下を参照してください。 |
OAuth 2.0 認証コード接続の設定
HTTP Connector を使用して OAuth 2.0 認証コード接続を作成する場合、接続を確立するための追加情報を提供する必要があります。
OAuth 2.0 接続を確立する手順は、次のとおりです。
-
フローを開くか、新しいフローを作成します。
-
トリガーを選択するか、スケジューラーを使用します。
-
アクションの HTTP 接続をクリックまたは作成します。
-
[Connect to your HTTP Account (HTTP アカウントに接続)] ウィンドウの [Authorization Type (認証種別)] 項目で、[OAuth 2.0 Authorization Code (OAuth 2.0 認証コード)] を選択し、次の項目に値を入力します。
-
Authorization URL (認証 URL): OAuth 2.0 フローを開始する URL。
-
Authorization URL Query Parameters (認証 URL クエリパラメーター): URL の疑問符の後に表示されるキー-値ペア。
OAuth 認証コード許可種別では、認証要求はクエリパラメーターとしてデータを送信します。 コンポーザーはこれらのクエリパラメーターを自動的に処理しますが、追加のパラメーターが役立つ場合があります。たとえば、Google API では、更新トークンを発行するために
access_token=offline が必要です。このパラメーターがないと、接続は 1 時間後に期限切れになります。 -
Token Exchange URL (トークンエクスチェンジ URL): 認証コードをアクセストークンと交換できる URL。
-
必要に応じて [Add Headers (ヘッダーを追加)] をクリックした場合、次の項目の値を入力する必要があります。
-
Key (キー)
-
値
-
-
-
Token Refresh URL (トークン更新 URL) (省略可能): トークンを更新できる URL。この項目は、アプリケーションが一定期間後にトークンを期限切れとしてマークした場合にのみ適用されます。
-
必要に応じて [Add Headers (ヘッダーを追加)] をクリックした場合、次の項目の値を入力する必要があります。
-
Key (キー)
-
値
-
-
-
Token Revoke URL (トークン取り消し URL) (省略可能): トークンを取り消したり削除したりできる URL。
-
必要に応じて [Add Headers (ヘッダーを追加)] をクリックした場合、次の項目の値を入力する必要があります。
-
Key (キー)
-
値
-
-
-
-
[Next (次へ)] をクリックします。
OAuth 2.0 認証コード接続が設定されます。これで、接続をテストできます。
接続をテストする
接続方法を確立したら、接続をテストできます。他のコネクタはコンポーザーによってバックグラウンドで自動的にテストされますが、HTTP Connector はテストする必要があります。テストで使用するページを決定できます。接続は後で編集できないため、接続のテストは重要です。
接続をテストするには、次の項目の値を入力します。
-
Request Method (要求方法)
-
Request Path (要求パス): この項目の値はベース URL に対して相対的です。
-
Request Headers (リクエストヘッダー)
-
Key (キー)
-
値
-
-
Request Body (リクエストボディ): このオプションは、HTTP メソッドが POST で、要求メッセージの本文である場合に表示されます。
[Connect (接続)] をクリックして接続をテストします。接続が正常に作成されたことを示すメッセージ (応答コード 200) またはエラーが発生したことを示すメッセージが表示されます。
データを処理するためにトークンをエクスチェンジすることがアプリケーションで求められる場合、ユースケースごとにトークンを作成する必要があります。たとえば、Salesforce Marketing Cloud では、フロー 1 の最初のステップでトークンが生成され、このトークンがフロー 2 の同様のステップで無効になる可能性があるため、これが必要になります。
HTTP Connector の項目
HTTP Connector に適用される項目は、次のとおりです。
| 名前 | 型 | 説明 |
|---|---|---|
Relative URL (相対 URL) |
String (文字列) |
ベースパスを考慮しない、要求の対象の URL。 |
Action (アクション) |
String (文字列) |
要求の種別。[Request (要求)] と [Paginated Request (ページ分割された要求)] のいずれかを選択する必要があります。 |
HTTP メソッド |
String (文字列) |
要求の HTTP メソッド。次の HTTP メソッドを使用できます。
|
Path (パス) |
String (文字列) |
アクセスするサーバーの特定のリソースを識別します。 |
Header (ヘッダー) |
Object (オブジェクト) |
ユーザーやサーバーが HTTP 要求または応答で追加情報を渡すことができるようにします。大文字と小文字を区別しない名前 (キー)、コロン、値の順で構成されます。ヘッダーを追加する場合、[Key (キー)] および [Value (値)] 項目の値を入力する必要があります。 POST、PUT、PATCH、または DELETE メソッドを指定してリクエストボディを追加する場合は、Content-Type: application/json ヘッダーを追加する必要があります。一部の API では Content-Type: application/json ヘッダーで必要な項目名が異なるため、接続された API でこの項目名を確認してください。 ヘッダーが Content-Type: application/json の場合、リクエストボディの一部として有効な JSON ({}、"") が最低限必要です。[] は、リクエストボディのルートではサポートされていません。 |
Query Parameters (クエリパラメーター) |
Object (オブジェクト) |
要求に含めるクエリパラメーター。クエリパラメーターを追加する場合、[Key (キー)] および [Value (値)] 項目の値を入力する必要があります。 |
Example Request (サンプル要求) |
String (文字列) |
JSON 形式のサンプル要求。この項目の値を入力すると、コンポーザーはサンプルを解析して、その項目を推定します。その後、その項目を使用してデータを入力し、要求の操作を設定できます。コンポーザーによってサンプルから推定された項目を表示するには、[Select Additional Fields (追加項目を選択)] をクリックします。この項目で指定されたサンプル JSON 値は、[Example Response (サンプル応答)] 項目で指定された値とは異なっている必要があります。 |
Example Response (サンプル応答) |
String (文字列) |
JSON 形式のサンプル応答。この項目の値を入力すると、コンポーザーはサンプル JSON ペイロードを解析して、JSON 項目に一致するデータピルを提供します。コンポーザーによってサンプルから推定された項目を表示するには、[Select Additional Fields (追加項目を選択)] をクリックします。この項目で指定されたサンプル JSON 値は、[Example Request (サンプル要求)] 項目で指定された値とは異なっている必要があります。 |
Array Path (配列パス) |
String (文字列) |
JSON 配列へのパス。[Array Path (配列パス)] 項目の値はデフォルトで選択されていますが、ドロップダウンから別の値を選択できます。この値が表示されるのは、[Action (アクション)] 項目の値が [Paginated Request (ページ分割された要求)] に設定されている場合のみです。 |
Pagination Type (ページネーション種別) |
String (文字列) |
要求のページネーションの種別。次のページネーション種別が使用できます。
|
Maximum Number of Pages (ページの最大数) |
Number (数値) |
要求で API から返されるページの最大数。 |
アクション
include:composer::_partials/action-definition.adoc[]
- HTTP の要求
-
[Action (アクション)] 項目で [Request (要求)] が選択されている場合、HTTP の要求によって応答ペイロードの項目が返されます。次の項目では、値は必須です。
-
Action (アクション)
-
HTTP メソッド
-
Path (パス)
-
Example Response (サンプル応答)
-
必要に応じて [Add Query Parameters (クエリパラメーターを追加)] をクリックした場合、次の項目の値を入力する必要があります。
-
Key (キー)
-
値
-
-
必要に応じて [Add Headers (ヘッダーを追加)] をクリックした場合、次の項目の値を入力する必要があります。
-
Key (キー)
-
値
-
-
- HTTP のページ分割された要求
-
[Action (アクション)] 項目で [Paginated Request (ページ分割された要求)] が選択されている場合、ページ分割された HTTP 要求が開始されます。ページ分割された要求により、以降のフローステップが For Each ループで使用できる項目のリストが返されます。コンポーザーでは、自動的にページネーション設定を使用して API からデータがフェッチされます。次の項目では、値は必須です。
-
Action (アクション)
-
HTTP メソッド
-
Path (パス)
-
Example Response (サンプル応答)
-
Array Path (配列パス)
-
Pagination Type (ページネーション種別)
-
必要に応じて [Add Query Parameters (クエリパラメーターを追加)] をクリックした場合、次の項目の値を入力する必要があります。
-
Key (キー)
-
値
-
-
必要に応じて [Add Headers (ヘッダーを追加)] をクリックした場合、次の項目の値を入力する必要があります。
-
Key (キー)
-
値
-
-
include:composer::_partials/see-also.adoc[]