Docs/overview

概要

ReCoron APIとは

ReCoron APIは、Cron Jobの管理とAPIキーの管理を提供するRESTful APIです。

Base URL: https://your-domain.com/api

レスポンス形式

すべてのAPIレスポンスは統一された形式で返されます。

成功レスポンス

{
  "success": true,
  "message": "success",
  "data": { ... }
}

エラーレスポンス

{
  "success": false,
  "message": "エラーメッセージ",
  "data": null
}

HTTPステータスコード

ステータスコード説明
200成功
201作成成功
400バリデーションエラー
401認証エラー
403権限エラー
404リソースが見つからない
500サーバーエラー

プランと制限

ReCoronは使用量追跡システムにより、リソースの削除による制限回避を防止しています。

プラン別制限

プランジョブ数月間実行数実行間隔API呼び出しログ保存
FREE5個500回30分100回/日3日
HOBBY20個10,000回5分500回/日14日
PRO100個50,000回1分2,000回/日30日

使用量追跡の仕組み

ReCoronは以下の3つのレベルで使用量を追跡します:

  1. 月次使用量: 削除されたリソースも含む総実行回数・API呼び出し回数
  2. 日次使用量: その日の実行回数・API呼び出し回数
  3. リソース履歴: すべてのジョブ・APIキーの作成・削除を記録

詳細は Usage API (usage-api.md) をご覧ください。

制限回避の防止

  • ジョブやAPIキーを削除しても使用量はリセットされません
  • 今日の作成・削除活動の合計も制限されます
  • すべての操作履歴が記録され、不正利用を検知できます

サポート

質問や問題が発生した場合は、以下のチャンネルでサポートを受けることができます:

変更履歴

v1.2.0 (2025-11-04)

  • 🎉 使用量追跡システムを実装
    • 削除されたリソースも含む完全な使用履歴
    • 月次・日次使用量の追跡
    • リソース作成・削除履歴の記録
    • 制限回避の防止機能
  • 新しいエンドポイント: GET /api/usage
  • プラン制限の大幅な緩和(個人開発者向け)
  • 料金を円表記に変更

v1.1.0 (2025-11-04)

  • レスポンス形式を統一 (success, message, data フィールド)
  • バッチジョブ作成API (POST /api/jobs/batch) を追加
  • エラーハンドリングの改善
  • サンプルコードにエラーハンドリングを追加

v1.0.0 (2025-11-04)

  • 初回リリース
  • Jobs API
  • API Keys API
  • 認証とスコープシステム