🚄빠른 시작 가이드

가급적 문서 전체를 살펴주시는 것을 권장하지만, SSAPI를 빠르게 훑어보고 싶으신 분들을 위해 준비했습니다

빠르게 훑기 위해 음슴체를 사용합니다!

SSAPI 먼저 이해 시켜줘

🤔 SSAPI 뭐임?

아프리카/치지직의 후원과 채팅 데이터를 활용해 더 다양한 방송 콘텐츠를 제작하고, BJ들이 제작비를 충당할 수 있도록 돕는 API 서비스임.

🛠 SSAPI는 어떻게 동작함?

SSAPI의 API를 통해 스트리머를 등록하면 SSAPI 서버가 알아서 채팅을 따서 소켓과 REST API로 제공함 이를 위해 서비스를 분산해두었음

더 궁금하면 SSAPI의 원리와 구성 참고

🤷 근데 이거 왜 써야함?

1~10명 정도 규모의 후원과 채팅 API를 사용하는건 사실 어렵진 않음. 아프리카는 구조에 대한 이해가 조금 필요하지만 엄청 어렵진 않고 치지직도 API가 나오기 때문임.

그럼에도 써야 하는 장점 2가지를 꼽겠음

  • 가장 큰 장점은 다수의 스트리머가 참여하는 컨텐츠에서 빛을 냄 SSAPI는 극강으로 최적화해서 100명당 겨우 2Mbps 정도의 인터넷 대역만을 사용함

    • 심지어 아프리카 공식를 승인받았음에도 대역과 사양을 굉장히 많이 차지해서 SSAPI로 옮긴 사례도 많이 있음

  • 치지직과 아프리카를 하나의 API를 통해 제공하고 문서화도 잘되어있기 때문에 개발 시간을 줄일 수 있는 장점이 있음

더 궁금하면 SSAPI를 사용해야 하는 이유 참고

👥 이거 누가 씀?

게임/컨텐츠/대규모 마크섭 같은데서 많이 씀

이미 뷰어십과 같은곳과 파트너/제휴를 맺고 있고 포켓꾸, 힐링월드 같은 대형 마크섭도 이 API를 쓴거임 개인 개발자들도 컨텐츠 개발을 위해 많이 문의하고 있음

더 궁금하면 SSAPI와 함께하는 프로젝트 참고

💰 유료임?

정책이 따로 있긴 하지만 다수에게 재미있거나 유익하면 무료. 그 이외에는 유료 정책으로 운영함. 대표적으로 대형 마크섭이나 다수가 즐기는 컨텐츠 같은건 무료로 제공함.

더 궁금하면 가격 정책과 이용 정책 참고


API 키 발급 방법 알려주셈

🔑 SSAPI의 이용정책을 확인하고 신청을 통해 쓸 수 있음

근데 개인정보 보호와 보안을 위해 아무나 신청할 순 없고 컨텐츠 개발자나 운영자 같은 사람이 신청해야 함


API 키 발급 한 뒤에는 어떻게 씀?

🎮 혹시 마인크래프트 서버에 쓸꺼면 플러그인 개발해둔게 있음

오픈 소스니까 보면 이해하기 쉬울꺼임

DOCHIS / ssapi-minecraft

📝 다른데 쓸꺼면 먼저 소켓룸에 그 스트리머를 등록해야 함

소켓룸 개념은 복잡하니깐 궁금하면 이 문서 참고하고 일단 등록해야 쓸 수 있다고만 알고 있자.

소켓룸에 등록하는 API는 REST API인데 이 API를 쓰면 됨

📊 이제 REST API 또는 소켓을 통해 데이터를 받을 수 있음

스트리머가 다수라면 Socket으로 개발하는게 네트워크 대역도 적게 쓰고 기능도 더 많음 Socket 이해도가 낮거나 트래픽이 많지 않다면 REST API를 써도 됨


💬 그래도 궁금한게 있다면 문의하셈

Last updated