サービスアカウントを管理する(API連携用)

サービスアカウントとは

サービスアカウント = 人間のユーザーではなく、外部システム・アプリが DRIVE SFA にアクセスするためのアカウント です。

CRM連携・データ自動入力・独自アプリ開発など、API を使った外部連携に使用します。


サービスアカウントの設定項目

項目必須説明
サービスアカウント名用途がわかる名前(例:「CRM連携用」「データ同期Bot」)
説明任意このアカウントの用途・担当チームなどのメモ
権限セットこのアカウントが持つ権限(通常は「読み取りのみ」を推奨)
所属組織アクセスできるデータ範囲を組織スコープで制限する

サービスアカウントを作成する

  1. 設定 「その他設定」 「サービスアカウント設定」
  2. 「+ 新規作成」
  3. 各項目を入力して 「保存」

PAT(パーソナルアクセストークン)を発行する

サービスアカウントでAPIにアクセスするには、PAT(Personal Access Token) が必要です。

  1. サービスアカウント詳細 「PAT管理」 をクリック
  2. PAT 管理ダイアログが開く
  3. 「+ トークンを発行」
  4. トークンの説明・有効期限を設定
  5. 「発行」 トークンが表示される

⚠️ 重要: PAT は発行直後にしか全文表示されません。必ず安全な場所にコピーして保管してください。一度閉じると再表示できません。


PAT の管理

操作説明
一覧確認発行済み PAT の一覧(トークン値は非表示、メタ情報のみ)
失効不要になった PAT を無効化する
再発行古いトークンを失効させて新しいトークンを発行

定期的なトークンのローテーション(交換)を推奨します。


権限の設定

サービスアカウントに付与する権限セットは、必要最小限の権限 にすることを強く推奨します。

例:

  • データを読み取るだけ 「閲覧のみ」権限
  • 取引先を自動作成する 取引先の作成権限のみ
  • 全データを同期する 読み書き権限(要注意)

権限について

この設定は管理者のみが行えます。


APIで操作できること

サービスアカウントに発行したPATを使って、GraphQL APIから以下の操作が行えます。

データ一覧取得詳細取得作成更新削除
取引先
取引先担当者
案件
営業活動

NOTE

削除はすべて論理削除です。実際にデータが消えるわけではありません。

NOTE

営業活動の更新・削除はAPIでは未提供です。

検索フィルター

一覧取得時は以下の条件でフィルタリングできます。

データ絞り込み条件
取引先取引先名(部分一致)/ 外部連携ID / 更新日時以降
取引先担当者取引先ID / メールアドレス(部分一致)/ 外部連携ID
案件取引先ID / 契約ステータス / 担当者 / 更新日時以降 / 外部連携ID
営業活動取引先ID / 案件ID / 活動タイプ / 日時以降

詳しい仕様・クエリ例は 外部連携API仕様(GraphQL) を参照してください。


関連記事

関連記事

この記事は役に立ちましたか?

解決しない場合はサポートへお問い合わせください