ヘルスチェック
GET /health - 現在のサービスステータスを返します。認証は不要です。
サービスが完全に稼働している場合は
"healthy"。稼働時間の監視やロードバランサーのヘルスプローブに使用します。常に
"rail-score-engine"です。キー検証
POST /verify - APIキーが有効でアクティブであることを検証します。キーに関連するプランと残りのクレジットを返します。
キーがアクティブで認可されている場合は
true。キーが取り消されているか存在しない場合はfalse。このキーに関連するプラン:
"free"、"pro"、"business"、または"enterprise"。現在の月間期間に残っているクレジット残高。
エラー応答
| ステータス | 意味 |
|---|---|
401 | Authorizationヘッダーが欠落または無効 |
403 | キーが取り消されているか非アクティブ |
503 | サービスが一時的に利用できません - 指数バックオフで再試行してください |
SDKでの使用
次のステップ
認証
APIキーの生成と管理方法。
クレジット & 価格
各エンドポイントのクレジットコストとプランの割り当て。