웹 API¶

웹 API는 https 통신에서 STRIX 서버로 JSON 메시지를 송신하여 STRIX의 처리를 실행하게 하는 구조입니다. 게임 클라이언트와 STRIX 서버 간의 통신이 아닌 주로 외부 서버와 STRIX 서버를 연계할 목적으로 사용합니다.

설정¶

Strix Cloud에서 웹 API를 이용하려면 애플리케이션 대시보드의 옵션 화면에서 [웹 API 활성화됨] 체크박스를 체크해 둡니다.

웹 API에서는 마스터 서버와 방 서버 각각이 독립적인 엔드 포인트를 가집니다. 1개의 서버 인스턴스가 마스터 서버와 방 서버를 겸하고 있는 경우에도 웹 API용 엔드 포인트는 마스터 서버용과 방 서버용으로 다른 URL이 할당됩니다.

서버 측의 엔드 포인트 URL은

<baseurl>/strix/handler

입니다. 여기서 <baseurl>은 애플리케이션 대시보드의 정보 화면 하단에 있는 [서버 주소]에서 확인할 수 있습니다. 예를 들어, <baseurl>이

https://rp.strixcloud.net/00112233-4455-6677-8899-AABBCCDDEEFF/master/

이면 실제 엔드 포인트 URL은

https://rp.strixcloud.net/00112233-4455-6677-8899-AABBCCDDEEFF/master/strix/handler

입니다.

웹 API의 엔드 포인트 URL로 JSON 메시지를 POST 송신하면 서버가 처리를 하고, 결과가 JSON 응답으로 돌아옵니다.

STRIX 서버는 웹 API의 요구가 적절한 송신원에서 보내졌는지 확인하기 위해 API 키를 사용합니다.

Strix Cloud에서는 API 키가 자동으로 생성되며, 애플리케이션 대시보드의 정보 화면에서 확인할 수 있습니다. 같은 애플리케이션에 속한 모든 서버가 이 API 키를 사용합니다. STRIX 서버와 연계시킬 외부 서버에 이 API 키를 공유해 둡니다.

참고

API 키란 비밀번호와 같은 것입니다. 엔드 포인트 URL과 해당 서버의 API 키를 알고 있으면 제삼자가 서버에 액세스할 수 있습니다.

API 키 정보가 외부로 유출되지 않도록 관리에 주의해 주십시오.