Change Feed API機能概要

Change Feed API機能概要

対象：

Change Feed API のバージョン

Change Feed API にはver.1とver.2がございます。
ver.2には新機能が追加され、かつ安定性を向上しているため、ver.2の利用を推奨しております。

 

機能概要

  • Sansan Data Hubで名寄せされたデータをWebAPI経由で取得します。
  • データ更新反映日時指定範囲で変更のあった最新データを出力します。
  • 連携先システムからAPI認証することにより、JSON Lines形式で情報を取得できます。
  • ご利用には事前の設定（Sansan Data Hubから取り出す項目の定義）が必要です。
  • データの入力については CSVインポート機能 または File Import API を使用してください。
  • 取得するデータの上限件数を指定する場合はver.2を利用してください。
    ver.1では容量を指定することができないため、必要に応じて取得期間の開始日と終了日の期間を短くして使用してください。
  • アクセストークンの有効期限は1時間です。
    • Access Token を取得したときのレスポンスの中に、「expires_in」（残りの秒数）として含まれますのでこちらをご確認ください。
  • 認証方式としては、OAuth 2.0 Client Credentials Grant を使用します。
    • アクセストークンの取得に利用する「client_id」・「client_secret」は設定後に弊社から発行されます。
  • 送受信ポート番号は 443 です。Base URLはこちらをご確認ください。
  • 人物の出力を行う場合、出力の単位はSOCとCI人物IDの組み合わせを1単位とします。

 

Change Feed APIご利用までの流れ

こちらをご確認ください。

 

Change Feed API仕様

Change Feed APIの仕様書は下記URLをご確認ください。サンプルコードはこちら。

Change Feed API ver.2

仕様書　https://api.datahub.sansan.com/docs/change-feed/v2.yaml

Change Feed API ver.1

仕様書　https://api.datahub.sansan.com/docs/change-feed/v1.yaml

  • 本ドキュメントはOpenAPI Specification 3.0 形式です。
  • ドキュメントの確認には以下のツールやエディターを使用されると便利です。

 

Change Feed API出力項目一覧

こちらをご覧ください。

 

Change Feed API サンプルコード

ここでは、Change Feed APIを利用するためのサンプルを紹介します。（各パラメータの詳細については仕様書をご確認ください。）

 

アクセストークンを取得する（ver.1,2 共通）

▼ リクエスト

curl -X POST -d "client_id={clientId}&client_secret={clientSecret}&grant_type=client_credentials" https://account.datahub.sansan.com/connect/token

▼ レスポンス

{
"access_token": "..........",
"expires_in": 3600,
"token_type": "Bearer",
"scope": "change-feed:read"
}

 

指定期間中に変更のあったデータを取得する（ver.2）

①データ更新反映日時でデータを絞り込む場合

データ更新反映日時でデータを絞り込む場合、startを引数に指定します。

▼ リクエスト

curl -X GET -H "Accept:application/ldjson" -H "Authorization:Bearer {access_token}" https://api.datahub.sansan.com/change-feed/v1/{feedId}/updated?start=2020-10-01T00%3A00%3A00.0000000Z

 

②同期済みのデータ更新反映日時でデータを絞り込む場合

同期済みのデータ更新反映日時でデータを絞り込む場合、currentOffsetを引数に指定します。

▼ リクエスト

curl -X GET -H "Accept:application/ldjson" -H "Authorization:Bearer {access_token}" https://api.datahub.sansan.com/change-feed/v2/{feedId}/updated?currentOffset=0100560E836CE831DC08FFFF

 

③取得するデータの上限を指定する場合

1回のリクエストで取得する最大データ量は、10万件もしくは100MBのうち先に到達した方（厳密ではない）です。もし1回のリクエストで取得する最大データ量をこれよりも少ない件数にする場合は、limitを引数に指定します。
下の例は上限を100件に指定する場合のサンプルコードです。

▼ リクエスト

curl -X GET -H "Accept:application/ldjson" -H "Authorization:Bearer {access_token}" https://api.datahub.sansan.com/change-feed/v2/{feedId}/updated?start=2020-10-01T00%3A00%3A00.0000000Z&limit=100

 

指定期間中に変更のあったデータを取得する（ver.1）

①データ更新反映日時でデータを絞り込む場合

データ更新反映日時でデータを絞り込む場合、startを引数に指定します。

▼ リクエスト

curl -X GET -H "Accept:application/ldjson" -H "Authorization:Bearer {access_token}" https://api.datahub.sansan.com/change-feed/v1/{feedId}/updated?start=2020-10-01T00%3A00%3A00.0000000Z

 

②同期済みのデータ更新反映日時でデータを絞り込む場合

同期済みのデータ更新反映日時でデータを絞り込む場合、highWaterMarkを引数に指定します。

▼ リクエスト

curl -X GET -H "Accept:application/ldjson" -H "Authorization:Bearer {access_token}" https://api.datahub.sansan.com/change-feed/v1/{feedId}/updated?highWaterMark=2020-10-01T00%3A00%3A00.0000000Z

 

お探しの情報が見つからない場合は以下よりお問い合わせください。

お問い合わせ