メインコンテンツへスキップ

​
概要

グローバル設定は、API 接続を通じて検出できるすべてのテーブルに適用されます。このページでは、認証、ヘッダー、ページネーションの設定について説明します。これらを設定したら、Tables タブに進んでテーブルを作成できます。

​
接続タイプ

Direct または Connect Gateway 接続を選択できます。Direct を選択した場合は、Authentication に進みます。Connect Gateway のオンプレミス接続を設定する場合は、Connect Gateway を参照してください。

​
認証

デフォルトでは、API コネクタは No Auth に設定されています。API に認証が必要な場合は、適切な方式を選択し、以下の該当するタブの手順に従ってください。認証が不要な場合は、Save Changes をクリックしてコネクタを保存します。その後、テーブルを作成する前に必要なヘッダーとページネーションのタイプを設定してください。
選択した認証方式は、このコネクタに追加されたすべてのテーブルに適用されます。
この認証方式では追加の設定は不要です。
1
Connect AI の Add API Connection ページの上部にある Save Changes をクリックして接続を保存します。
2
接続を保存した後、Tables をクリックしてテーブルの作成に進みます。

​
ヘッダー

すべての API 呼び出しで送信される HTTP ヘッダーを追加するには、次の手順に従います：
1
Name フィールドにヘッダー名を入力します。
2
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 ページ目に対するリクエストを示しています。 
https://myapi?pageOffset=5000&pageSize=1000

​
Number

ページ番号を使用してページングを制御する場合、次の値を設定します：
  • Page Number Param：ページ番号を定義する URL パラメータの名前。
  • Page Size Param（オプション）：ページサイズを定義する URL パラメータの名前。
  • Page Size（オプション）：ページごとに取得するレコード数。

​
例

以下のリクエストでは、ユーザーは Page Number Param を “pageNum”、Page Size Param を “pageSize”、Page Size を 1000 に設定しています。コネクタが自動的にページをインクリメントするため、この例ではデータの 6 ページ目に対するリクエストを示しています。 
https://myapi?pageNum=6&pageSize=1000

​
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” に設定しています。 リクエスト： 
https://myapi?pageToken=123456
レスポンス： 
{
  "results": [
    {
      "rows": [
        {
          "id": "123",
          "name": "Acme",
          "country": "United States",
          "no_employees": 500
        },
        ...
      ],
      "nextpagetoken": 123457
    }
  ]
}

​
ボディを使用する例

以下のリクエストでは、ユーザーは Request Body を “/request/pageToken”、Token Path を “/results/nextpagetoken”、Has More Path を “/results/morePages” に設定しています。 リクエストボディ： 
{
  "request": [
    {
      "country": "United States",
      "pageToken": 123456
    }
  ]
}
レスポンス： 
{
  "results": [
    {
      "rows": [
        {
          "id": "123",
          "name": "Acme",
          "country": "United States",
          "no_employees": 500
        },
        ...
      ],
      "nextpagetoken": 123457,
      "morePages": true
    }
  ]
}

​
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 を含むレスポンスの例です： レスポンス： 
{
  "results": [
    {
      "rows": [
        {
          "id": "123",
          "name": "Acme",
          "country": "United States",
          "no_employees": 500
        },
        ...
      ],
      "nextpageurl": "https://myapi?nextpage=81a3ebdb-1483-45cd-84d1-f711d1308698"
    }
  ]
}

​
詳細設定

トラブルシューティングの目的で必要な場合を除き、Verbosity フィールドは 2 のままにしてください。 API 接続を作成した後、テーブルの作成に進みます。 API コールが特定のステータスコードで失敗した場合にリクエストを再試行するには、Retry Status Codes を追加できます。