【Sansan Data Hub】File Import API機能概要

契約プランによってはご利用いただけません。
ご利用を希望される場合は、担当営業もしくはサポートセンターへお問い合わせください。

機能概要

  • APIを利用してSansan Data Hubにデータを取り込むことができます。
  • Sansan Data Hubにファイル情報を送信する事で、戻り値として取り込み処理を行うジョブ(ファイル取り込みジョブ)の情報を返却します。
  • 対応しているファイル書式はCSVもしくは改行区切りJSON(JSON Lines) です。
  • 取り込むファイルは1APIリクエスト辺り50MB(MiB)までの制限があります。
  • ファイル取り込みジョブの作成は同期で行いますが、取込処理は非同期で行われます。
  • ファイル取り込みジョブ情報の返却時点での処理の完了は保証していません。
  • ファイル取り込みジョブの進捗を検知するには、「ファイル取り込みジョブの状態取得」でジョブの状態を取得してください。
  • 複数のエラーが同一行で発生した場合は何れか一つのみがエラーメッセージとして返却されます。
  • 1ファイル(i.e. 1APIリクエスト)あたり、返却されるエラーの上限は100件までです。100件を超えるエラーが発生した場合でも100件までしか返却されません。
  • API の認可はOAuth 2.0 Client Credentials Grantを使用します。
  • アクセストークンの取得に利用するclient_id, client_secretは弊社が発行したものを使用してください。
  • アクセストークンには有効期限(一時間) があるため、期限が切れた場合は再度発行してください。

 

File Import APIご利用までの流れ

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

 

File Import API仕様

File Import APIの仕様については下記URLをご確認ください。

仕様書https://api.datahub.sansan.com/docs/file/import/v1.yaml

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

 

アクセストークンの発行

▼ リクエスト

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":"file/import:read file/import:write"}

 

取り込み Job の作成

▼ リクエスト

curl -X POST -H "Accept:application/json" -H "Authorization:Bearer {access_token}" https://api.datahub.sansan.com/file/import/v1/{dataSourceId}/jobs

 

取り込み Job の取得

▼ リクエスト

curl -X GET -H "Accept:application/json" -H "Authorization:Bearer {access_token}" https://api.datahub.sansan.com/file/import/v1/{dataSourceId}/jobs/{jobId}
この記事は役に立ちましたか?
0人中0人がこの記事が役に立ったと言っています