サービス API構築時の注意事項
    • PDF

    サービス API構築時の注意事項

    • PDF

    記事の要約

    Classic/VPC環境で利用できます。

    B2B PRISM Live Studioが提供する APIを使用してサービスを構築する際に注意すべき事項をご案内します。

    APIのセキュリティ

    APIを使用してサービスを構築する際に注意すべきセキュリティについて説明します。

    SSL認証導入の重要性

    Secure Socket Layer(SSL)認証は、サービスプロバイダとユーザー間の通信が安全に行われるようにします。

    • データ保護: SSLを介して送信されるデータは暗号化され、外部からの侵入者から安全です。
    • データの整合性: データが転送中に改ざんされたり、破損するのを防ぎます。
    • 認証: ユーザーが実際に意図したサービスと通信しているかを確認します。

    OAuth 2.0認証体系の重要性

    OAuth 2.0認証は、ユーザーの権限を効果的に管理し、外部サービスとの安全なデータ共有を可能にします。

    • ユーザーエクスペリエンスの向上: ユーザーが別途会員登録しなくてもサービスを利用できます。
    • 権限付与と管理: ユーザーデータのアクセスと管理を細分化して安全に調節できます。
    • セキュリティ強化: ユーザー認証情報が直接外部サービスと共有されないため、セキュリティを強化できます。

    セキュリティ問題で発生しうる問題点

    セキュリティ事項に注意してサービスを構築しないことで発生しうる問題は、次の通りです。

    • データ流出: SSLが適用されていない場合、中間者攻撃によってユーザーの重要情報が流出する可能性があります。
    • データ改ざん: 暗号化されていない接続はデータ改ざんの危険性があります。
    • 権限無視: OAuth2.0が構築されていない場合、APIを通じたデータアクセスが制御されず、機密情報が公開される危険性があります。

    サービス APIの許容量

    APIを使用してサービスを構築する際に注意すべき APIの許容量に関する事項について説明します。

    最小 APIトラフィック許容量の提供

    最小 APIトラフィック許容量に関する注意事項は、次の通りです。

    • B2B PRISM Live Studioは1つのライブにつき1分間に15~30個の APIを呼び出し、詳細な呼び出し量は選択機能によって異なります。
    • サービスに呼び出されるサービス APIの数は、サービスで同時にライブが行われるチャンネルの数に比例します。例えば、同時に1000チャンネルでライブが行われる場合、毎分15,000~30,000の呼び出しが発生します。

    最大 APIトラフィック許容量(Rate Limit)の制限

    最大 APIトラフィック許容量の制限に関する注意事項は、次の通りです。

    • API許容量を制限(Rate Limit)せずに外部に公開されたサービスは、DDoSなど予想可能なサービス攻撃に非常に脆弱です。
    • サービスの不安定性に加え、個人情報が盗まれるリスクに直面することになります。
    • 過度の API呼び出しによりサービスが不安定になる場合、サービス全体の安定性のために当該サービスを無効にすることができます。

    最大 APIのレスポンス時間

    最大 APIのレスポンス時間に関する注意事項は、次の通りです。

    • サービス APIのレスポンス時間は1秒以内を推奨し、最大2秒を超えないようにしてください。
    • サービス APIのレスポンス時間が2秒を超える場合、API timeoutが発生して配信開始に失敗したり、ストリーマーに放送状態や統計情報を正常に提供できない場合があります。
    • 2秒を超えるレスポンス時間が続く場合、B2B PRISM Live Studioは当該サービスの状態を障害状態と判断し、サービス全体の安定性のために当該サービスを無効にすることができます。

    APIの障害時に発生しうる状況

    サービス APIに障害が発生した場合、ストリーマーに発生しうる問題は、次の通りです。

    • 配信開始失敗
      • API呼び出しにより、放送が予定通り開始されない場合があります。これは、サーバのレスポンス遅延やデータ送信エラーが原因で発生する可能性があります。
    • 異常な配信終了
      • 放送が進行中の状況でも、やむを得ず異常終了することがあります。これは、データパケットの損失や切断が原因で発生する可能性があります。
    • 長時間の障害検出時にサービスを無効化
      • もし長時間にわたって APIに関連する障害が継続的に検出される場合、サービスの安定性と品質のために一時的に当該サービスを無効にする可能性があります。

    この記事は役に立ちましたか?

    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.