FlytBaseFlytBase Documentation

強化された API アクセス

拡張 API アクセスを使用して API 認証情報を安全に管理します。

Pre-Flight Modules

FlytBase による拡張 API アクセス機能は、API 資格情報を管理するための堅牢な方法を導入し、従来のアクセス パターンに比べて大幅な改善を提供します。 この機能は、統合ごとに制御された資格情報を提供し、安全なストレージと有効期間の短いアクセス トークンの使用を保証するように設計されています。 また、他のシステムに影響を与えることなくアクセスを無効化または削除できるため、管理が容易になり、操作がより安全になります。 拡張 API アクセスは、古いアクセス パターンによってもたらされる課題に対処します。そのため、統合によって資格情報を分離し、ライフサイクル制御を強制し、アクセス マテリアルの交換が必要な場合の影響を最小限に抑えることが困難になることがよくありました。 この機能は、各 API キーまたはクライアント シークレットを明示的かつ追跡可能にすることで、セキュリティと運用効率を強化します。 これは、特に複数の統合を管理し、API 認証情報を処理するための安全で管理しやすい方法を必要とするユーザーにとって、より広範な FlytBase 製品ワークフローにシームレスに適合します。 拡張 API アクセスの主な利点は、より安全で管理しやすい資格情報管理システムを提供することで日常業務を合理化できることであり、単純なサービスと複雑な企業統合の両方に最適です。

APIアクセス設定
APIアクセス設定

仕組み

拡張 API アクセスは、セキュリティと運用制御を保証する高度な認証情報管理システムを通じて動作します。 このシステムの核となるのは、1 回限りのシークレットの公開、資格情報の値は作成時にのみ表示されます。 FlytBase は、これらの資格情報の保護された一方向表現を保持し、元のシークレットの取得を防ぎます。 このメカニズムにより、資格情報が公開された場合でも、それが再利用されたり、さらに侵害されたりすることがなくなります。 システムはまた、範囲を限定した運用管理、統合ごとにアクセスを管理できるようになります。 これは、チームが他のシステムに影響を与えることなく 1 つの認証情報を無効にできることを意味し、API アクセスに対するきめ細かい制御を提供します。

このシステムのもう 1 つの重要なコンポーネントは、有効期間の短いクライアント資格情報トークン。 これらのトークンはクライアントの資格情報によって発行され、有効期間が短くなるように設計されているため、トークンが漏洩した場合のリスクが軽減されます。 トークンはリフレッシュ トークンを使用して更新できるため、アクセスが安全で制御された状態に保たれます。 このアプローチにより、資格情報が長期間漏洩するリスクが大幅に軽減され、システム全体のセキュリティ体制が強化されます。

拡張 API アクセス機能は、認証情報を管理するための 2 つの主要なオプションをサポートしています。APIキーそしてクライアントの資格情報。 API キーは、単一のベアラー資格情報によるサーバー間の直接 API 呼び出しに使用されるため、単純なサービスに最適です。 一方、クライアント資格情報は、クライアント ID と有効期限の短いアクセス トークンのシークレットを交換する必要がある統合に使用され、エンタープライズ レベルの統合により適しています。 この二重のアプローチにより、さまざまな種類のサービスおよび統合にわたる API 認証情報の管理における柔軟性と拡張性が可能になります。

APIキー管理インターフェース
APIキー管理インターフェース

前提条件

拡張 API アクセス機能を使用する前に、次の前提条件が満たされていることを確認してください。

  • 管理者権限を持つアクティブな FlytBase アカウント。
  • API 認証情報を管理できる FlytBase ダッシュボードへのアクセス。
  • 現在の API 統合とその構成方法についての理解。

段階的な構成

  1. に移動します FlytBase ダッシュボード > API 資格情報管理。 ここで、アカウントに関連付けられたすべての API 認証情報を管理できます。
    1. API キーとクライアント認証情報の両方のオプションが表示されます。
  2. クリックの上新しい API キーの作成。 このアクションにより、サーバー間の API 呼び出しに使用できる新しい API キーが生成されます。
    1. 新しい API キーを示すダイアログが表示されます。 キーは作成時に一度だけ表示されることに注意してください。
  3. 選択 クライアントの資格情報メニューから。 このオプションを使用すると、トークンベースのアクセスのクライアント ID とシークレットを管理できます。
    1. クライアント ID を入力し、クライアント シークレットを生成するためのフィールドが表示されます。
  4. 入力必要な詳細クライアントIDそしてクライアントシークレットそしてクリックの上アクセストークンの生成。 これにより、API 統合に使用できる新しいクライアント資格情報セットが作成されます。
    1. 生成されたアクセス トークンの有効期間は短く、リフレッシュ トークンを使用して更新できます。
  5. レビューアクティブなキー、期限切れのキー、および無効なキーのリストAPIキーセクション。 これは、API キーのライフサイクルを効果的に管理するのに役立ちます。
    1. 他の統合に影響を与えることなく、必要に応じてキーを無効化または削除できます。
クライアント資格情報管理インターフェイス
クライアント資格情報管理インターフェイス

制約と制限

成分詳細
主な用途API キー: サーバー間の直接呼び出し。 クライアント認証情報: トークン交換
秘密の可視性作成時に一度表示されます。 後で取り戻せない
有効期限と交換計画的なキーの交換と削除。 トークン交換の新しいシークレット
動作を無効にするAPIリクエストやトークン発行を即時に停止します
ベストフィットAPI キー: 単純なサービス。 クライアント認証情報: エンタープライズ統合

拡張 API アクセス機能の制約は、主にセキュリティと運用制御に重点が置かれています。 不正アクセスを防ぐため、シークレットの公開範囲は作成時点に限定されます。 この制限により、資格情報が公開された場合でも再利用できなくなります。 計画された有効期限とキーの交換により、資格情報が定期的にローテーションされ、長期的な漏洩のリスクが軽減されます。 資格情報を無効にすると、API リクエストまたはトークンの発行が即座に停止され、潜在的なセキュリティ違反を軽減する簡単な方法が提供されます。 この機能は、セキュリティと統合管理が重要な環境に最適です。


エッジケースとトラブルシューティング

  • 問題: 作成後に API キーを取得できません。
    • 原因: API キーは、セキュリティ上の理由から、作成時にのみ表示されます。
    • 解決: API キーは生成後すぐに安全に保管してください。
  • 問題: 認証情報を無効にすると API リクエストが失敗します。
    • 原因: 認証情報を無効にすると、それに関連付けられたすべての API リクエストが即座に停止されます。
    • 解決: 統合を確認し、必要な認証情報のみが無効になっていることを確認してください。
  • 問題: 有効期限の短いトークンは頻繁に期限切れになります。
    • 原因: トークンは、セキュリティを強化するために有効期間が短くなるように設計されています。
    • 解決: トークンの有効期限を処理するために、アプリケーションにトークン更新メカニズムを実装します。
  • 問題: クラシック アクセスから拡張アクセスへの移行が困難。
    • 原因: 資格情報管理とセキュリティ慣行の違い。
    • 解決: FlytBase が提供する移行ガイドに従って、スムーズに移行してください。

関連ページ

Was this helpful?