プロジェクトと権限を指定したAPIキー
コンソールのプロジェクト → Open API → APIキーで名前・権限・有効期限を指定します。キーは一度だけ表示し、ハッシュのみ保存します。呼び出しごとに現在の権限とプロジェクト範囲を検証し、キーを失効できます。
Developers / Open API v1
コストデータをつなぐひとつのOpen API。
外部コレクターのコスト・使用量を入力し、原帳・集計・接続・アラート・異常・予測を社内システムへ取得できます。
2026年10月25日 · Open API v1
API基本URL
https://dash.onecloud.im/api/v1必要なAPI権限だけを選択
コスト・使用量の参照、ソースの登録、コスト入力、接続・取込履歴・アラート・異常・予測の参照を個別に許可します。発行には設定の書き込みと選択範囲の現在の権限が必要です。
呼び出し・入力制限
キーごとに毎分120回（IPごとに300回）、入力ごとに1–200件・100 KB。日付はUTC、取得期間は最大366日です。429ではRetry-Afterに従って再試行します。
外部自動化との連携手順
- 01
プロジェクトで必要な権限のAPIキーを発行します。
- 02
外部収集ソースを登録し、sourceIdを保存します。
- 03
元のID・利用日・サービス・通貨・金額・使用量をJSONに変換します。
- 04
dryRunで検証し、Idempotency-Keyを付けて入力。complete確認後にチェックポイントを更新します。
参照API
| HTTP / Endpoint | OneCloud Open API | 必要なAPI権限 |
|---|---|---|
| GET/me | キー情報 | — |
| GET/projects | プロジェクト | — |
| GET/providers | サービス一覧 | — |
| GET/projects/{projectId}/connections | 接続状態 | connections:read |
| GET/projects/{projectId}/sources | 収集ソース | connections:read |
| GET/projects/{projectId}/costs | コスト原帳 | costs:read |
| GET/projects/{projectId}/costs/summary | コスト集計 | costs:read |
| GET/projects/{projectId}/usage | 使用量 | usage:read |
| GET/projects/{projectId}/imports | 取込履歴 | imports:read |
| GET/projects/{projectId}/imports/{importId} | 取込履歴 | imports:read |
| GET/projects/{projectId}/alerts | アラートルール | alerts:read |
| GET/projects/{projectId}/anomalies | 異常検知 | anomalies:read |
| GET/projects/{projectId}/forecasts | 予測 | forecasts:read |
入力API
| HTTP / Endpoint | OneCloud Open API | 必要なAPI権限 |
|---|---|---|
| POST/projects/{projectId}/sources | ソースの登録・名前変更 | sources:write |
| POST/projects/{projectId}/costs/import | コスト・使用量の一括入力 | costs:write |
| POST/projects/{projectId}/sources/{sourceId}/records/delete | 元のID別に論理削除 | costs:write |
必要なデータを社内ツールへ
ERP・ETL・n8n・定期ジョブからコストと使用量を取得し、カーソルで次ページへ移動できます。差分取得ではupdatedSince・固定したupdatedBefore・includeDeleted=trueを使い、全ページ成功後にチェックポイントを更新します。
同じ元データを更新し、安全に再試行
sourceIdとexternalIdで元の行を識別します。同一本文とIdempotency-Keyで再試行すると、失敗した部分書き込みと集計を復旧し、完了済みリクエストは重複しません。日付・通貨変更時は過去の集計も修正します。
通貨と使用単位を保持
KRWとUSD、リクエスト数・トークン・GBを混ぜて合計しません。使用量だけならbilledCost=0、返金は負の金額にします。残高・チャージ額・売上・決済元本をサービス費用として入力しないでください。
参照・入力の例
環境変数にはコンソールで発行したキーとプロジェクト・ソースIDを設定してください。実際の認証情報は含まれていません。
参照API
curl "https://dash.onecloud.im/api/v1/projects/$ONECLOUD_PROJECT_ID/costs?from=2026-10-01&to=2026-10-25&limit=100" \
-H "Authorization: Bearer $ONECLOUD_API_KEY"ソースの登録・名前変更
curl -X POST "https://dash.onecloud.im/api/v1/projects/$ONECLOUD_PROJECT_ID/sources" \
-H "Authorization: Bearer $ONECLOUD_API_KEY" \
-H 'Content-Type: application/json' \
--data '{"externalId":"billing-production","provider":"KakaoCloud","name":"Production collector"}'costs.json
{
"sourceId": "SOURCE_ID",
"records": [
{
"externalId": "invoice-202610-row-001",
"usageDate": "2026-10-24",
"service": "API requests",
"currency": "KRW",
"billedCost": 1200,
"usageQuantity": 1000,
"usageUnit": "requests",
"tags": {
"environment": "production"
}
}
]
}コスト・使用量の一括入力
curl -X POST "https://dash.onecloud.im/api/v1/projects/$ONECLOUD_PROJECT_ID/costs/import" \
-H "Authorization: Bearer $ONECLOUD_API_KEY" \
-H 'Content-Type: application/json' \
-H 'Idempotency-Key: billing-2026-10-batch-001' \
--data-binary @costs.json