転送元としてカスタムコネクタを作成する

本ページでは、転送元としてカスタムコネクタを作成する手順について説明します。
接続情報や転送に関する設定については、以下のドキュメントを参照ください。

• 接続情報 - カスタムコネクタ
• 転送元 - カスタムコネクタ

入力項目

基本情報

コネクタ情報

認証情報

認証種別でOAuth2を選択した場合の追加項目

各認証種別で共通の項目

エンドポイント

カスタムコネクタで取得対象とするAPIのエンドポイントごとに設定を追加します。

ステータスコード設定

接続確認

設定したエンドポイントの接続を確認できます。

ページング設定

ページング設定でページベース・オフセットベース・カーソルベースを選択すると、転送データ取得時にページングリクエストを含めることができます。
選択肢ごとに、設定項目は異なります。

ページベースを選択した場合

ページベースの入力例は以下の通りです。

この場合、以下のようにパラメータが付与されたリクエストが実行されます。

1. ?per_page=100page=1
2. ?per_page=100page=2
3. ?per_page=100page=3
4. ?per_page=100page=4

オフセットベースを選択した場合

オフセットベースの入力例は以下の通りです。

この場合、以下のリクエストパラメータが追加されます。

1. ?limit=100&offset=0
2. ?limit=100&offset=100
3. ?limit=100&offset=200
4. ?limit=100&offset=300

カーソルベースを選択した場合

カーソルベースのレスポンスデータの構造が、以下だった場合の入力例です。

{
  "items": [
    { ... },
    { ... },
    ...
  ],
  "responseMetaData": {
    "nextCursor": "SAMPLE_CURSOR",
    ...
  },
  ...
}

この場合、?cursor=SAMPLE_CURSOR&limit=100のようなリクエストパラメータが追加されます。

例えば、レコードが550件存在するデータに対するリクエストであれば、上記のようなリクエストが6回実行されます。
5回目までのレスポンスには100レコード分のデータが含まれ、6回目のレスポンスには50レコード分のデータが含まれます。
後続のデータが存在しない6回目のレスポンスデータにはカーソルが含まれないため、7回目のリクエストは実行せず、データ取得は完了します。

入力内容の自動生成について

カスタムコネクタで取得対象とするREST APIのAPIドキュメントURLを入力し、各種設定の入力内容を自動生成できます。
各項目で「提案を受け入れる」をクリックすると、生成した設定を入力できます。

自動生成に対応している項目は以下のとおりです。

• コネクタ情報・認証情報
  • ベースURL
  • 認証種別
  • 認証ヘッダー名
  • 認証スキーム
• エンドポイント
  • パス
  • HTTPメソッド
  • パラメータ
  • HTTPヘッダ
  • JSONPathルート
  • ページング設定