이용안내

미니톡 이용과 관련된 도움말을 제공합니다.
SERVER EndPoint : https://www.yourdomain.com:3121

미니톡 서버호스팅을 사용중이거나, 미니톡 서버라이선스 구입 후 미니톡 서버프로그램을 직접 운영중일 때 해당 미니톡 서버에 REST API 를 호출하여 미니톡 서버통신이 필요한 다양한 작업을 진행할 수 있습니다.

  • 무료호스팅 서비스를 이용중인 사용자만 사용가능합니다.
  • 채팅호스팅 서비스를 이용중인 사용자만 사용가능합니다.
  • 서버호스팅 서비스를 이용중인 사용자만 사용가능합니다.
  • 서버라이선스 구입 후 서버를 직접 설치한 사용자만 사용가능합니다.
/status

미니톡 서버프로그램의 상태를 확인할 수 있습니다.

서버에 접속중인 전체 접속자 및 접속자가 존재하는 채널수, 그리고 서버실행시간 및 메모리 사용량 정보를 확인할 수 있습니다.

Headers
  • Name Type Description
  • authorization string CLIENT_SECRET_KEY 미니톡 클라이언트 설치 시 입력한 암호화키
Example
curl -X GET "https://www.yourdomain.com:3121/status" \ 
 -H "authorization: CLIENT_SECRET_KEY $CLIENT_SECRET_KEY"
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://www.yourdomain.com:3121/status");
curl_setopt($ch, CURLOPT_POST, false);
curl_setopt($ch, CURLOPT_HTTPHEADER, array(
  "authorization: CLIENT_SECRET_KEY $CLIENT_SECRET_KEY"
));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$data = curl_exec($ch);
$http_code = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);
if ($http_code == 200) {
  var_dump(json_decode($data));
}
?>
자바스크립트를 사용하여 이 REST API 를 호출할 경우 브라우저의 소스보기를 통하여 인증정보가 담긴 헤더 데이터가 노출될 수 있습니다.
소스가 노출되지 않는 환경에서만 사용하시거나, PHP 등을 이용하여 인증정보가 노출되지 않도록 주의하시기 바랍니다.
$.ajax({
  type: "GET",
  url: "https://www.yourdomain.com:3121/status",
  dataType: "json",
  beforeSend: function(xhr) {
    xhr.setRequestHeader("authorization", "CLIENT_SECRET_KEY $CLIENT_SECRET_KEY");
  },
  error: function(xhr, status, error) {
    console.log(error);
  },
  success: function(result) {
    console.log(result);
  }
});
Test
미니톡 홈페이지에 로그인한 경우, 회원님의 데이터를 사용하여 테스트해볼 수 있습니다.
Result
HTTP 200 Success!
{
    "status": "서버상태(ONLINE)",
    "channel": "접속자가 1명 이상인 채널수",
    "user": "전체 접속자수",
    "uptime": "서버실행시간(초)",
    "memory": {
        "rss": "메모리 사용량(rss - byte)",
        "heapTotal": "메모리 사용량(heapTotal - byte)",
        "heapUsed": "메모리 사용량(heapUsed - byte)",
        "external": "메모리 사용량(external - byte)",
        "arrayBuffers": "메모리 사용량(arrayBuffers - byte)"
    }
}