APIリクエスト実行・機能一覧
Reckoner APIで提供している機能と、各リクエストの実行例(curl)は以下の通りです。
APIリクエストの注意点
●認証方法:APIの認証には、HTTPヘッダーに Authorization: Bearer <発行したトークン> を含めてリクエストを送信してください。
●Windows環境での実行:Windows環境(PowerShell等)で実行する場合は、コマンドの curl を curl.exe に書き換えて実行してください。
ワークフロー操作・管理
機能名 |
概要/注意事項 |
実行リクエスト(curl) |
|---|---|---|
| ワークフロー実行 | ワークフローを実行し、 job_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 PUT "https://cdp-server.reckoner-api.com/api/external/v1/workflows/<ワークフローID>/jobs/<ジョブID>/cancel" -H "Authorization: Bearer <発行したトークン>" -d "" |
ワークフロー取得 |
指定したワークフローの構成情報を取得 ※ファイルとして保存する場合は、コマンドの末尾に -o <ファイル名>.json を追記してください。 |
curl -X GET "https://cdp-server.reckoner-api.com/api/external/v1/workflows/<ワークフローID>" -H "Authorization: Bearer <発行したトークン>" -H "accept: application/json" |
ワークフロー一覧取得 |
指定したプロジェクトに登録されているワークフローを一覧で取得 ※ until_date(終了日)には、実行日の前日以前の日付を指定する必要があります。 |
curl -X GET "https://cdp-server.reckoner-api.com/api/external/v1/workflows/projects/<プロジェクトID>" -H "Authorization: Bearer <発行したトークン>" |
ワークフローエクス ポート |
指定したワークフローの設定情報をJSON形式で取得 |
curl -X GET "https://cdp-server.reckoner-api.com/api/external/v1/workflows/<ワークフローID>/export" -H "Authorization: Bearer <発行したトークン>" |
ワークフロー利用状況 取得 |
指定した期間内のワークフローの利用状況を一覧で取得 |
curl -X GET "https://cdp-server.reckoner-api.com/api/external/v1/workflows/usages?since_date=2026-04-01&until_date=2026-04-22&classification=by_project" -H "Authorization: Bearer <発行したトークン>" -H "accept: application/json" |
接続情報の管理
機能名 |
概要/注意事項 |
実行リクエスト(curl) |
|---|---|---|
接続情報取得 |
指定したプロジェクトに登録されている接続情報を一覧で取得 ※特定のサービスで絞り込む場合は、URL末尾に ?service=<サービス名> を付加してください。 |
curl -X GET "https://cdp-server.reckoner-api.com/api/external/v1/integrations/projects/<プロジェクトID>" -H "Authorization: Bearer <発行したトークン>" -H "accept: application/json" |
接続情報削除 |
指定した接続情報を削除 ※実行の成否(ステータスコード 200 OK等)を確認したい場合は、コマンドに -i を追加してください。 |
curl -X DELETE "https://cdp-server.reckoner-api.com/api/external/v1/integrations/<サービス名>/<integration_id>" -H "Authorization: Bearer <発行したトークン>" -H "accept: application/json" |
プロジェクトの管理
機能名 |
概要/注意事項 |
実行リクエスト(curl) |
|---|---|---|
プロジェクト一覧取得 |
プロジェクトの一覧を取得 チーム管理者は全プロジェクト、非チーム管理者は権限のあるプロジェクトのみ取得可能 |
curl -X GET "https://cdp-server.reckoner-api.com/api/external/v1/projects" -H "Authorization: Bearer <発行したトークン>" |
プロジェクト詳細取得 |
指定したプロジェクトの詳細を取得 |
curl -X GET "https://cdp-server.reckoner-api.com/api/external/v1/projects/{projectId}" -H "Authorization: Bearer <発行したトークン>" |
アカウント一覧取得 |
指定したプロジェクト内のアカウント一覧を取得 |
curl -X GET "https://cdp-server.reckoner-api.com/api/external/v1/projects/{projectId}/accounts" -H "Authorization: Bearer <発行したトークン>" |
アカウント管理
機能名 |
概要/注意事項 |
実行リクエスト(curl) |
|---|---|---|
アカウント一覧取得 |
チーム内のアカウントの一覧を取得 チーム管理者のみ実施可能 |
curl -X GET "https://cdp-server.reckoner-api.com/api/external/v1/accounts" -H "Authorization: Bearer <発行したトークン>" |
アカウント削除 |
アカウントを削除 チーム管理者のみ実施可能 |
curl -X DELETE "https://cdp-server.reckoner-api.com/api/external/v1/accounts/{accountId}" -H "Authorization: Bearer <発行したトークン>" |
認証・トークン管理
機能名 |
概要/注意事項 |
実行リクエスト(curl) |
|---|---|---|
トークンリフレッシュ |
リフレッシュトークンからアクセストークンを発行 ※Authorizationヘッダーには、リフレッシュトークン(prt_...)を指定してください。 |
curl -X POST "https://cdp-server.reckoner-api.com/api/external/v1/auth/token/refresh" -H "Authorization: Bearer <リフレッシュトークン>" -H "accept: application/json" -d "" |
APIトークンの発行
APIの利用には、認証用の「APIトークン(専用の鍵)」が必要です。以下の手順で発行してください。
Reckonerにログインし、[設定] を選択します。
[ReckonerAPI設定] を選択します。
[ReckonerAPIトークンの新規作成] をクリックします。
設定ダイアログに任意の「トークン名」を入力し、「トークン種別」を選択して[作成]をクリックします。
表示されたトークンをコピーし、安全な場所に保管してください。
アクセストークンのみの場合に表示される画面
アクセストークン+リフレッシュトークンの場合に表示される画面
※トークンの権限とセキュリティ
トークンは一度画面を閉じると再表示できません。
トークンの操作権限(参照可能なプロジェクト等)は、発行したユーザーアカウントの権限に準じます。
トークンの管理
発行済みのトークンは、ReckonerAPI設定画面での確認や、ReckonerAPI経由での自動更新が可能です。トークンを無効化(削除)する場合は、対象トークンの右側にある横三点リーダーをクリックし、「トークンを無効にする」を選択してください。
閲覧権限: チーム内で発行されたトークン一覧は、チーム管理者権限を持つユーザーのみが確認できます。
無効化: トークンの漏洩が疑われる場合や、利用を終了する場合は、速やかに当該トークンを無効化してください。
【重要】トークンの失効について
APIトークンは発行したユーザーアカウントに紐付いています。 そのため、そのユーザーがプロジェクトから削除されたり、Reckonerのアカウント自体が削除(退職等)されたりすると、該当ユーザーが発行したすべてのトークンも自動的に無効化(削除)されます。システム連携等で継続的にトークンを利用している場合は、ユーザー削除の前に、別の有効なユーザーアカウントでトークンを再発行し、差し替えを行うようご注意ください。
アクセストークンおよびリフレッシュトークンの有効期限については、こちらをご参照ください。
Reckoner APIのレートリミット(実行制限)については、こちらをご確認ください。
各種ID・名称の確認方法
APIリクエストに必要な各値は、以下の方法で確認できます。
-
プロジェクトID:
[プロジェクト設定] 画面のURL末尾の数字。(例:.../projects/66 → 66)または、「プロジェクト一覧」APIで確認できます。 -
ワークフローID:
[ワークフロー一覧] 画面で対象を選択した際のURL末尾の数字。または「ワークフロー一覧取得」APIで確認できます。 -
ジョブID:
[ワークフロー一覧] 画面で対象を選択し、[実行履歴]タブから特定の実行履歴を表示した際のURL末尾の数字。または「ワークフロー実行」APIのレスポンスから確認できます。 -
サービス名(コネクタ名):
[接続情報] 画面で対象のコネクタを選択した際のURL末尾の文字列。(例:.../integrations/excel → excel) -
インテグレーションID(integration_id):
「接続情報取得」APIのレスポンス内にある integration_id の値。
APIリファレンス
パラメータやレスポンスの詳細は、APIリファレンス をご参照ください。