メインコンテンツへスキップ

Reckoner API

Reckoner外部API連携ガイド

1. 現在利用可能な機能

以下の機能を提供しています。

ワークフロー操作・管理

  • ワークフロー実行：ワークフローを実行し、 job_id を取得します。
  • ワークフロージョブ実行結果取得：実行したジョブのステータスを取得します。
  • ワークフロージョブ実行結果一覧取得：指定したワークフローの実行履歴を一覧で取得します。
  • ワークフロー取得：指定したワークフローの構成情報を取得します。
  • ワークフロー一覧取得：指定したプロジェクトに登録されているワークフローを一覧で取得します。
  • ワークフローエクスポート：指定したワークフローの設定情報をJSON形式で取得します。

接続情報の管理

  • 接続情報取得：指定したプロジェクトに登録されている接続情報を一覧で取得します。
  • 接続情報削除：指定した接続情報を削除します。

2. APIトークンの発行

APIの利用には、認証用の「APIトークン（専用の鍵）」が必要です。以下の手順で発行してください。

  1. Reckonerにログインし、[設定] を選択します。

  2. [外部API設定] を選択します。

  3. [外部APIトークンの新規作成] をクリックします。

  4. 設定ダイアログに任意の「トークン名」を入力し、[作成]をクリックします。

  5. 表示されたトークンをコピーし、安全な場所に保管してください。

※トークンの権限とセキュリティ
　トークンは一度画面を閉じると再表示できません。
　トークンの操作権限（参照可能なプロジェクト等）は、発行したユーザーアカウントの権限に準じます。

3. トークンの管理

発行済みのトークンは、外部API設定画面で確認および無効化が可能です。

  • 閲覧権限: チーム内で発行されたトークン一覧は、チーム管理者権限を持つユーザーのみが確認できます。

  • 無効化: トークンの漏洩が疑われる場合や、利用を終了する場合は、速やかに当該トークンを無効化してください。

【重要】トークンの失効について
APIトークンは発行したユーザーアカウントに紐付いています。 そのため、そのユーザーがプロジェクトから削除されたり、Reckonerのアカウント自体が削除（退職等）されたりすると、該当ユーザーが発行したすべてのトークンも自動的に無効化（削除）されます。システム連携等で継続的にトークンを利用している場合は、ユーザー削除の前に、別の有効なユーザーアカウントでトークンを再発行し、差し替えを行うようご注意ください。

4. 各種ID・名称の確認方法

APIリクエストに必要な各値は、以下の方法で確認できます。

  • プロジェクトID：
    [プロジェクト設定] 画面のURL末尾の数字。（例：.../projects/66 → 66）
  • ワークフローID：
    [ワークフロー一覧] 画面で対象を選択した際のURL末尾の数字。または「ワークフロー一覧取得」APIで確認できます。
  • サービス名（コネクタ名）：
    [接続情報] 画面で対象のコネクタを選択した際のURL末尾の文字列。（例：.../integrations/excel → excel）
  • インテグレーションID（integration_id）：
    「接続情報取得」APIのレスポンス内にある integration_id の値。

5. 実行リクエストの例

APIの認証には、HTTPヘッダーに Authorization: Bearer <発行したトークン> を含めてリクエストを送信してください。なお、Windows環境（PowerShell等）で実行する場合は、コマンドの curl を curl.exe に書き換えて実行してください。

ワークフロー実行

実行に成功すると、ジョブID（例：{"job_id":196378}）が返されます。

curl -X POST "https://cdp-server.reckoner-api.com/api/external/v1/workflows/<ワークフローID>/run" -H "Authorization: Bearer <発行したトークン>" -H "Content-Type: application/json" -d "{}"

ワークフロージョブ実行結果取得

完了時は {"status":"COMPLETED"} のようなレスポンスが返ります。

curl -X GET "https://cdp-server.reckoner-api.com/api/external/v1/workflows/<ワークフローID>/jobs/<ジョブID>" -H "Authorization: Bearer <発行したトークン>"

ワークフロージョブ実行結果一覧取得

特定のワークフローの過去の実行履歴（ステータス、開始・終了時刻など）を一覧で取得します。

curl -X GET "https://cdp-server.reckoner-api.com/api/external/v1/workflows/<ワークフローID>/jobs" -H "Authorization: Bearer <発行したトークン>"

ワークフロー取得

ワークフロー名、含まれるタスク、スケジュール、通知設定などの詳細情報を取得します。

curl -X GET "https://cdp-server.reckoner-api.com/api/external/v1/workflows/<ワークフローID>" -H "Authorization: Bearer <発行したトークン>" -H "accept: application/json"

ワークフロー一覧取得

プロジェクトに登録されているすべてのワークフロー（ID、名称、最終更新日など）を一覧で取得します。

curl -X GET "https://cdp-server.reckoner-api.com/api/external/v1/workflows/projects/<プロジェクトID>" -H "Authorization: Bearer <発行したトークン>"

ワークフローエクスポート

ワークフローの構成定義をJSON形式で取得します。
※ファイルとして保存する場合は、コマンドの末尾に -o <ファイル名>.json を追記してください。

curl -X GET "https://cdp-server.reckoner-api.com/api/external/v1/workflows/<ワークフローID>/export" -H "Authorization: Bearer <発行したトークン>"

接続情報取得

指定したプロジェクトに登録されているすべての接続情報を取得します。
※特定のサービスで絞り込む場合は、URL末尾に ?service=<サービス名> を付加してください。

curl -X GET "https://cdp-server.reckoner-api.com/api/external/v1/integrations/projects/<プロジェクトID>" -H "accept: application/json" -H "Authorization: Bearer <発行したトークン>"
  • 絞り込み時の挙動：指定したサービス以外もレスポンスのキーには含まれますが、中身は空（[]）で返却されます。

接続情報削除

指定した接続情報を削除します。
※実行の成否（ステータスコード 200 OK等）を確認したい場合は、コマンドに -i を追加してください。

curl -X DELETE "https://cdp-server.reckoner-api.com/api/external/v1/integrations/<サービス名>/<integration_id>" -H "accept: application/json" -H "Authorization:Bearer <発行したトークン>"
  • 強制削除（force）：ワークフローで使用中の接続情報を削除する場合は、URL末尾に ?force=true を付加してください。

6. APIリファレンス

パラメータやレスポンスの詳細は、以下をご参照ください。

ワークフローの実行 - APIリファレンス