概要
グローバル設定は、API 接続を通じて検出できるすべてのテーブルに適用されます。このページでは、認証、ヘッダー、ページネーションの設定について説明します。これらを設定したら、Tables タブに進んでテーブル を作成できます。
接続タイプ
Direct またはPrivate Cloud Connector 接続を選択できます。Direct を選択した場合は、Authentication に進みます。Private Cloud Connector のオンプレミス接続を設定する場合は、Private Cloud Connector を参照してください。
認証
デフォルトでは、API コネクタはNo Auth に設定されています。API に認証が必要な場合は、適切な方式を選択し、以下の該当するタブの手順に従ってください。認証が不要な場合は、Save Changes をクリックしてコネクタを保存します。その後、テーブルを作成する前に必要なヘッダーとページネーションのタイプを設定してください。
選択した認証方式は、このコネクタに追加されたすべてのテーブルに適用されます。
No Auth
Basic Auth
Digest Auth
OAuth 1.0
OAuth 2.0
OAuth Client
OAuth Password
Bearer Token
API Key
この認証方式では追加の設定は不要です。
Connect AI のAdd API Connection ページの上部にあるSave Changes をクリックして接続を保存します。
接続を保存した後、Tables をクリックしてテーブル の作成に進みます。
User フィールドに、認証に使用するAPI のユーザー名を入力します。
Password フィールドにユーザーパスワードを入力します。
Connect AI のAdd API Connection ページの上部にあるSave Changes をクリックして接続を保存します。
接続を保存した後、Tables をクリックしてテーブル の作成に進みます。
User フィールドに、認証に使用するAPI のユーザー名を入力します。
Password フィールドにユーザーパスワードを入力します。
Connect AI のAdd API Connection ページの上部にあるSave Changes をクリックして接続を保存します。
接続を保存した後、Tables をクリックしてテーブル の作成に進みます。
Callback URL (リダイレクトURL)は、OAuth アプリのセットアップ時に必要なURL(https://oauth.cdata.com/oauth/)です。このURL をコピーしてOAuth アプリに貼り付けます。
API サービスでOAuth 用に登録した際に割り当てられたOAuth Client Id を入力します。
API サービスでOAuth 用に登録した際に割り当てられたOAuth Client Secret を入力します。
リクエストトークンを取得するOAuth Request Token URL を入力します。
サインイン時にリクエストトークンを承認できるOAuth Authorization URL を入力します。
OAuth Authorization URL はブラウザからの直接リダイレクトです。Private Cloud Connector 経由のルーティングは行われません。このURL はエンドユーザーのブラウザから到達可能である必要があります。プライベートIP アドレスまたはリンクローカルIP アドレス(10.x.x.x、192.168.x.x、169.254.x.x など)に解決されるURL は、コネクションの保存時に拒否されます。
承認済みリクエストトークンをアクセストークンと交換できるOAuth Access Token URL を入力します。
OAuth でセキュアに接続するには、Sign in をクリックします。これにより、API プロバイダーのサインインページが新しいタブで開かれます。
API プロバイダーにログインし、リクエストされた権限を設定します(該当する場合)。
Connect AI のAdd API Connection ページの上部にあるSave Changes をクリックして接続を保存します。
接続を保存した後、Tables をクリックしてテーブル の作成に進みます。
Callback URL (リダイレクトURL)は、OAuth アプリのセットアップ時に必要なURL(https://oauth.cdata.com/oauth/)です。このURL をコピーしてOAuth アプリに貼り付けます。
API サービスでOAuth 用に登録した際に割り当てられたOAuth Client Id を入力します。
API サービスでOAuth 用に登録した際に割り当てられたOAuth Client Secret を入力します。
サインイン時にユーザーを承認できるOAuth Authorization URL を入力します。
OAuth Authorization URL はブラウザからの直接リダイレクトです。Private Cloud Connector 経由のルーティングは行われません。このURL はエンドユーザーのブラウザから到達可能である必要があります。プライベートIP アドレスまたはリンクローカルIP アドレス(10.x.x.x、192.168.x.x、169.254.x.x など)に解決されるURL は、コネクションの保存時に拒否されます。
認可トークンをアクセストークンと交換できるOAuth Access Token URL を入力します。
古いアクセストークンの有効期限が切れたときにリフレッシュトークンをアクセストークンと交換できるOAuth Refresh Token URL を入力します。
OAuth Client Authentication Mode を選択します:Send as Basic Auth header またはSend in Post body 。API プロバイダーのドキュメントが推奨する認証モードを選択します。デフォルト値はSend as Basic Auth header です。
Header Prefix を入力します。ヘッダープレフィックスは、トークンの前のAuthorization ヘッダーに組み込まれます。デフォルト値は Bearer です。トークンをプレフィックスなしで送信するには(例えば、ゲートウェイが独自のプレフィックスを追加する場合)、NONE を入力します。
OAuth でセキュアに接続するには、Sign in をクリックします。これにより、API プロバイダーのサインインページが新しいタブで開かれます。
API プロバイダーにログインし、リクエストされた権限を設定します(該当する場合)。
Connect AI のAdd API Connection ページの上部にあるSave Changes をクリックして接続を保存します。
接続を保存した後、Tables をクリックしてテーブル の作成に進みます。 OAuth 2.0 カスタムパラメータ OAuth 2.0 の関連リクエストにカスタムパラメータを追加するには、次の手順に従います:
Value フィールドにパラメータの値を入力します。
さらにパラメータを追加するには、Add Parameter をクリックして上記の手順を必要に応じて繰り返します。
API サービスでOAuth 用に登録した際に割り当てられたOAuth Client Id を入力します。
API サービスでOAuth 用に登録した際に割り当てられたOAuth Client Secret を入力します。
認可トークンをアクセストークンと交換できるOAuth Access Token URL を入力します。
(オプション)OAuth Scopes を入力します。これらのスコープは、アクセストークンに許可される操作を指定します。サポートされるスコープについてはAPI プロバイダーのドキュメントを確認してください。
OAuth Client Authentication Mode を選択します:Send as Basic Auth header またはSend in Post body 。API プロバイダーのドキュメントが推奨する認証モードを選択します。デフォルト値はSend as Basic Auth header です。
Header Prefix を入力します。ヘッダープレフィックスは、トークンの前のAuthorization ヘッダーに組み込まれます。デフォルト値は Bearer です。トークンをプレフィックスなしで送信するには(例えば、ゲートウェイが独自のプレフィックスを追加する場合)、NONE を入力します。
Connect AI のAdd API Connection ページの上部にあるSave Changes をクリックして接続を保存します。
接続を保存した後、Tables をクリックしてテーブル の作成に進みます。 OAuth Client カスタムパラメータ OAuth Client のトークンリクエストにカスタムパラメータを追加するには、次の手順に従います:
Value フィールドにパラメータの値を入力します。
User フィールドに、認証に使用するAPI のユーザー名を入力します。
Password フィールドにユーザーパスワードを入力します。
API サービスでOAuth 用に登録した際に割り当てられたOAuth Client Id を入力します。
API サービスでOAuth 用に登録した際に割り当てられたOAuth Client Secret を入力します。
認可トークンをアクセストークンと交換できるOAuth Access Token URL を入力します。
(オプション)OAuth Scopes を入力します。これらのスコープは、アクセストークンに許可される操作を指定します。サポートされるスコープについてはAPI プロバイダーのドキュメントを確認してください。
OAuth Client Authentication Mode を選択します:Send as Basic Auth header またはSend in Post body 。API プロバイダーのドキュメントが推奨する認証モードを選択します。デフォルト値はSend as Basic Auth header です。
Header Prefix を入力します。ヘッダープレフィックスは、トークンの前のAuthorization ヘッダーに組み込まれます。デフォルト値は Bearer です。トークンをプレフィックスなしで送信するには(例えば、ゲートウェイが独自のプレフィックスを追加する場合)、NONE を入力します。
Connect AI のAdd API Connection ページの上部にあるSave Changes をクリックして接続を保存します。
接続を保存した後、Tables をクリックしてテーブル の作成に進みます。 OAuth Password カスタムパラメータ OAuth Password の関連リクエストにカスタムパラメータを追加するには、次の手順に従います:
Value フィールドにパラメータの値を入力します。
API プロバイダーから取得したBearer Token を入力します。Bearer トークンは、プロバイダーの開発者ポータル、コマンドラインツール、またはその他の手段で取得できます。プロバイダーのドキュメントを参照してください。
Connect AI のAdd API Connection ページの上部にあるSave Changes をクリックして接続を保存します。
接続を保存した後、Tables をクリックしてテーブル の作成に進みます。
API Key Type を選択します:Header またはQuery Parameter 。キーのタイプはAPI プロバイダーによって異なります。詳細についてはプロバイダーのAPI リファレンスを参照してください。
API Key Name を入力します。これはAPI プロバイダーで作成したキーの名前です(通常はプロバイダーの開発者ポータルで作成)。
API Key Value を入力します。この値はキー自体です。機密として扱ってください。
Connect AI のAdd API Connection ページの上部にあるSave Changes をクリックして接続を保存します。
接続を保存した後、Tables をクリックしてテーブル の作成に進みます。
ヘッダー
すべてのAPI 呼び出しで送信されるHTTP ヘッダーを追加するには、次の手順に従います:
Value フィールドにヘッダーの値を指定します。
さらにヘッダーを追加するには、Add Header をクリックして上記の手順を必要に応じて繰り返します。
ページネーション
API コネクタで使用するページネーションType を指定できます。まず、ページネーションのタイプを選択します。利用可能なオプションは次のとおりです:
None
API リクエストはデータセット全体を 1 つのレスポンスで返します。
Offset
オフセットページングを使用する場合、Connect AI はページサイズと、後続のページを取得する際にスキップするレコード数を定義します。オフセットページングでは、次の値を設定します:
Offset Param :API リクエストでのAPI オフセットを定義するURL パラメータの名前。
Page Size Param (オプション):ページごとに取得するレコード数を定義するURL パラメータの名前。
Page Size :ページごとに取得するレコード数。コネクタはこの値を使用してオフセットを計算します。接続先API のデフォルトページサイズに設定してください。
例
以下のリクエストでは、ユーザーはOffset Param を “pageOffset”、Page Size Param を “pageSize”、Page Size を 1000 に設定しています。コネクタが自動的にオフセットをインクリメントするため、この例ではデータの 6 ページ目に対するリクエストを示しています。
Number
ページ番号を使用してページングを制御する場合、次の値を設定します:
Page Number Param :ページ番号を定義するURL パラメータの名前。
Page Size Param (オプション):ページサイズを定義するURL パラメータの名前。
Page Size (オプション):ページごとに取得するレコード数。
例
以下のリクエストでは、ユーザーはPage Number Param を “pageNum”、Page Size Param を “pageSize”、Page Size を 1000 に設定しています。コネクタが自動的にページをインクリメントするため、この例ではデータの 6 ページ目に対するリクエストを示しています。
Token
次のページトークンを使用してページングを制御する場合、次の値を設定します。コネクタは前のレスポンスからのトークンを各リクエストに自動的に含めます。
Token Path :次のページトークンを定義するAPI レスポンス内のパス。
Has More Path (オプション):さらに利用可能なレコードがあるかどうかを定義するAPI レスポンス内のパス。
Token Source :トークンをリクエストで URL Parameter として送信するか、Request Body で送信するかを選択します。
URL Parameter :ページングトークンを渡すURL パラメータの名前。
Request Body :ページングトークンを渡すリクエストボディ内のパス。
パラメータを使用する例
以下のリクエストでは、ユーザーはURL Parameter を “pageToken”、Token Path を “/results/nextpagetoken” に設定しています。
リクエスト:
レスポンス:
ボディを使用する例
以下のリクエストでは、ユーザーはRequest Body を “/request/pageToken”、Token Path を “/results/nextpagetoken”、Has More Path を “/results/morePages” に設定しています。
リクエストボディ:
レスポンス:
URL
次のページURL を使用してページングを制御する場合、まずレスポンス内のどこに次のページのURL があるかを選択する必要があります:
Response Type :URL がレスポンスのボディにある場合は Response Body を、URL がレスポンスのヘッダーにある場合は Response Header を選択します。
Response Body :次のページURL を定義するAPI レスポンス内のパス。この値はXPath 表記で指定する必要があります。以下の例を参照してください。
Response Header :次のページURL が “Link” ヘッダーでレスポンスヘッダーに渡される場合、これを設定してヘッダー名を指定します。
パスを使用する例
以下の例では、ユーザーはResponse Body を “/results/nextpageurl” に設定しています。以下は、次のページURL を含むレスポンスの例です:
レスポンス:
詳細設定
トラブルシューティングの目的で必要な場合を除き、Verbosity フィールドは 2 のままにしてください。
API 接続を作成した後、テーブル の作成に進みます。
API コールが特定のステータスコードで失敗した場合にリクエストを再試行するには、Retry Status Codes を追加できます。
このソースをAI でご利用ください。 クイックスタート の手順に従い、Claude、ChatGPT、Copilot、またはその他のAI クライアントをMCP 経由でこのソースに接続してください。アプリケーションのモデルリクエストを、ガバナンスされた単一のエンドポイント経由でルーティングするには、LLM Gateway を参照してください。Connect AI を初めてご利用になる場合は、Connect AI の無料アカウントを作成 し、わずか数分で最初のコネクション設定を完了できます。