서비스 API 구축 시 주의 사항

Classic/VPC 환경에서 이용 가능합니다.

B2B PRISM Live Studio에서 제공하는 API를 사용하여 서비스 구축 시 주의해야 할 사항을 안내합니다.

API 보안

API를 사용하여 서비스 구축 시 주의해야 할 보안 사항을 설명합니다.

SSL 인증 도입의 중요성

SSL(Secure Socket Layer) 인증은 서비스 제공자와 사용자 간의 통신이 안전하게 이루어지도록 합니다.

• 데이터 보호: SSL을 통해 전송되는 데이터는 암호화되어 외부의 침입자로부터 안전합니다.
• 데이터 무결성: 데이터가 전송 중 변조되거나 손상되는 것을 방지합니다.
• 인증: 사용자가 실제로 의도한 서비스와 통신하고 있는지 확인합니다.

OAuth 2.0 인증 체계의 중요성

OAuth 2.0 인증은 사용자의 권한을 효과적으로 관리하고, 외부 서비스와의 안전한 데이터 공유를 가능하게 합니다.

• 유저 경험 향상: 사용자가 별도의 회원 가입 없이도 서비스를 이용할 수 있습니다.
• 권한 부여 및 관리: 사용자 데이터의 접근과 관리를 세분화하여 안전하게 조절할 수 있습니다.
• 보안 강화: 사용자 인증 정보가 직접적으로 외부 서비스와 공유되지 않으므로 보안을 강화할 수 있습니다.

보안 이슈로 발생 가능한 문제점

보안 사항을 주의하여 서비스를 구축하지 않아 발생할 수 있는 문제는 다음과 같습니다.

• 데이터 유출: SSL이 적용되지 않은 경우, 중간자 공격에 의해 사용자의 중요 정보가 유출될 수 있습니다.
• 데이터 변조: 암호화되지 않은 연결은 데이터 변조의 위험을 갖게 됩니다.
• 권한 무시: OAuth2.0이 구축되지 않은 경우, API를 통한 데이터 접근이 제어되지 않아 민감한 정보가 노출될 위험성이 있습니다.

서비스 API 허용량

API를 사용하여 서비스 구축 시 주의해야 할 API 허용량 관련 사항을 설명합니다.

최소 API 트래픽 허용량 제공

최소 API 트래픽 허용량 관련 주의 사항은 다음과 같습니다.

• B2B PRISM Live Studio는 라이브 1개당 분당 15~30개의 API를 호출하며, 자세한 호출량은 선택 기능에 따라 달라집니다.
• 서비스에 호출되는 서비스 API의 수는 서비스에서 동시에 라이브가 진행되는 채널의 수에 비례합니다. 예를 들어 동시에 1,000개의 채널에서 라이브가 진행될 경우 분당 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와 관련된 장애가 지속적으로 감지될 경우, 서비스의 안정성과 품질을 위하여 일시적으로 해당 서비스를 비활성화할 가능성이 있습니다.