本機能はご契約によっては有償でのご提供となります。メニューが表示されずご利用を希望される場合は担当営業もしくはサポートセンターへお問い合わせください。
機能概要
APIを利用してSansan Data Hubに取り込まれた情報を出力することができます。
- Sansan Data Hubで名寄せされたデータをWebAPI経由で取得します。
- データ更新日時指定範囲で変更のあった最新データを出力します。
- 連携先システムからAPI認証することにより、JSON Lines形式で情報を取得できます。
- ご利用には事前の設定（Sansan Data Hubから取り出す項目の定義）が必要です。
- 入力機能はありません。データの入力については CSVインポート機能 を使用してください。
- 取得するデータの容量を指定することはできません。
必要に応じて取得期間の開始日と終了日の期間を短くして使用してください。 -
APIコール数の上限は現状ございません。
- ただし、過剰なアクセスが検知された場合は一時的にアクセスを制限する場合はございます。
-
アクセストークンの有効期限は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をご確認ください。サンプルコードはこちら。
仕様書 https://api.datahub.sansan.com/docs/change-feed/v1.yaml
- 本ドキュメントはOpenAPI Specification 3.0 形式です。
- ドキュメントの確認には以下のツールやエディターを使用されると便利です。
- Visual Studio Code の Swagger Viewer Extension などの開発ツール
- Swagger Editor などのオンラインエディター
Change Feed API出力項目一覧
こちらをご覧ください。
Change Feed API サンプルコード
ここでは、Change Feed APIを利用するためのサンプルを紹介します。（各パラメータの詳細については仕様書をご確認ください。）
アクセストークンを取得する
▼ リクエスト
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"
}
指定期間中に変更のあったデータを取得する
①更新日時でデータを絞り込む場合
更新日時でデータを絞り込む場合、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