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

Reckoner API

Reckoner外部API連携ガイド

Reckoner APIを利用すると、外部プログラムや他のシステムからReckonerワークフローの実行、および実行ステータスの取得を自動化できます。

1. 現在利用可能な機能

現在は第一弾として、以下の2つの機能を提供しています。

  • ワークフローの実行（リモート操作）： 外部システムからReckonerのワークフローを直接実行します。

  • 実行結果（ステータス）の取得： 実行したワークフローが正常に終了したかなどの状態（例：COMPLETED など）を確認できます。

2. APIトークンの発行

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

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

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

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

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

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

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

3. トークンの管理

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

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

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

4. 実行リクエストの例

認証には「Bearer認証」を使用します。ヘッダーに Authorization: Bearer <トークン> を含めてリクエストを送信してください。

ワークフローを実行する

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

Mac / Linux (ターミナル)

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

Windows (PowerShell)

# ワークフローを実行する
curl.exe -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"} のようなレスポンスが返ります。

Mac / Linux (ターミナル)

# 実行ステータスを取得する
curl -X GET "https://cdp-server.reckoner-api.com/api/external/v1/workflows/<ワークフローID>/jobs/<ジョブID>" \
     -H "Authorization: Bearer <発行したトークン>"

Windows (PowerShell)

# 実行ステータスを取得する
curl.exe -X GET "https://cdp-server.reckoner-api.com/api/external/v1/workflows/<ワークフローID>/jobs/<ジョブID>" -H "Authorization: Bearer <発行したトークン>"