Skip to main content
すべてのRAIL APIリクエストはAPIキーで認証されます。キーはあなたのアカウントに紐づいており、クレジット残高を保持し、使用ログに表示されます。

APIキーの取得

2

ダッシュボードを開く

ダッシュボードに移動し、APIキーセクションに移動します。
3

キーを生成

キーを生成をクリックします。キーはrail_で始まり、一度だけ表示されます。すぐにコピーしてください。
ダイアログを閉じた後、キーは再表示されません。ページを離れる前に安全に保存してください。

APIキーの使用

リクエストごとにAuthorizationヘッダーにBearerトークンとしてキーを渡します:
完全なcURLの例:

SDK認証

両方のSDKはクライアント構築時にAPIキーを受け取り、ヘッダーを自動的に追加します:

環境変数

ソースファイルにAPIキーをハードコーディングしないでください。環境変数を使用し、キーをバージョン管理から除外してください。

キー管理

異なる環境(本番、ステージング、CI)用に複数のキーを作成できます。すべてのキーはダッシュボードから管理します。
ゼロダウンタイムローテーション: 新しいキーを生成し、それをサービスにデプロイして動作を確認した後、古いキーを無効化します。スワッピングは数秒で完了します。

レート制限

レート制限はAPIキーごとに適用されます。制限を超えるとHTTP 429が返されます。

セキュリティのベストプラクティス

  • クライアントサイドコードにキーを露出しないでください。 ブラウザは公開されています。常にバックエンドまたはサーバーレス関数からAPIを呼び出してください。
  • キーを環境変数に保存し、 ソースファイルやDockerイメージにハードコーディングしないでください。
  • 最初のコミットの前に.env.gitignoreに追加し、キーが誤ってプッシュされないようにします。
  • 環境ごとに別々のキーを使用してください。 ステージングが侵害された場合でも、本番は安全です。
  • 露出した場合は即座に無効化してください。 まずは代替を生成し、その後無効化します。
  • スケジュールに従ってローテーションしてください。 定期的にキーを再生成することで、未検出の漏洩の影響範囲を制限します。

認証エラー応答

次は何をするか

クイックスタート

5分以内に最初の評価リクエストを行います。

クレジットと料金

呼び出しごとのクレジットの請求方法を理解します。

APIリファレンス

すべてのエンドポイントの完全なパラメータリファレンス。

ダッシュボード

キーを管理し、使用状況を確認し、クレジット残高を監視します。