SERVICE REST API

기본 주소 https://api.minitalk.io/service

미니톡 채팅호스팅 및 서버호스팅을 이용하는 경우, 외부에서 미니톡 서비스와 관련된 데이터를 이용할 수 있도록 서비스 REST API 를 제공하고 있습니다.

해당 REST API 를 이용하기 위해서는 미니톡 서비스의 client_id 및 client_secret 값이 필요하며, 해당 정보는 미니톡 서비스 신청 후 마이페이지 > 나의 서비스 관리 메뉴에서 확인하실 수 있습니다.

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

GET

이름	설명
`GET /:client_id/channels`	무료호스팅 또는 채팅호스팅에 현재 접속자가 있는 채널명과 해당 채널에 접속한 유저수를 가져옵니다.
`GET /:client_id/status`	특정 클라이언트 아이디를 가진 자신의 서비스의 상태정보를 확인할 수 있습니다.

GET /:client_id/channels

GET 안정 v6.4.0부터 무료호스팅 채팅호스팅

GET https://api.minitalk.io/service/:client_id/channels

무료호스팅 또는 채팅호스팅에 현재 접속자가 있는 채널명과 해당 채널에 접속한 유저수를 가져옵니다.

접속자가 존재하는 채널이 없는 경우 channels 값은 NULL 일 수 있습니다.

채널 접속자수는 실시간이 아니라, latest_update 시각의 접속자수를 의미하며, 접속자수는 최대 5분마다 갱신되고 있습니다.

요청주소의 [client_id] 부분에 자신의 서비스(채팅호스팅, 서버호스팅)의 클라이언트 아이디를 대입하여 요청해야 합니다.

경로 변수

이름	설명
`:client_id`	미니톡 서비스 클라이언트 아이디

요청 헤더

이름	타입	설명
`MINITALK_CLIENT_SECRET`	`string`	미니톡 서비스의 클라이언트 암호화키

예제

curl -X GET "https://api.minitalk.io/service/:client_id/channels" \
 -H "MINITALK_CLIENT_SECRET: $MINITALK_CLIENT_SECRET"

<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://api.minitalk.io/service/:client_id/channels");
curl_setopt($ch, CURLOPT_POST, false);
curl_setopt($ch, CURLOPT_HTTPHEADER, array(
  "MINITALK_CLIENT_SECRET: $MINITALK_CLIENT_SECRET"
));
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));
}
?>

$.ajax({
  type: "GET",
  url: "https://api.minitalk.io/service/:client_id/channels",
  dataType: "json",
  beforeSend: function(xhr) {
    xhr.setRequestHeader("MINITALK_CLIENT_SECRET", "$MINITALK_CLIENT_SECRET");
  },
  error: function(xhr, status, error) {
    console.log(error);
  },
  success: function(result) {
    console.log(result);
  }
});

결과 (HTTP 200)

{
    "success": "성공여부",
    "channels": {
        "개설된 채널명 #1": "유저수",
        "개설된 채널명 #2": "유저수"
    },
    "latest_update": "마지막 갱신시각"
}

최종수정일 : 2021.04.17

GET /:client_id/status

GET 안정 v6.4.0부터 무료호스팅 채팅호스팅 서버호스팅

GET https://api.minitalk.io/service/:client_id/status

특정 클라이언트 아이디를 가진 자신의 서비스의 상태정보를 확인할 수 있습니다.

요청주소의 [client_id] 부분에 자신의 서비스(채팅호스팅, 서버호스팅)의 클라이언트 아이디를 대입하여 요청해야 합니다.

경로 변수

이름	설명
`:client_id`	미니톡 서비스 클라이언트 아이디

요청 헤더

이름	타입	설명
`MINITALK_CLIENT_SECRET`	`string`	미니톡 서비스의 클라이언트 암호화키

예제

curl -X GET "https://api.minitalk.io/service/:client_id/status" \
 -H "MINITALK_CLIENT_SECRET: $MINITALK_CLIENT_SECRET"

<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://api.minitalk.io/service/:client_id/status");
curl_setopt($ch, CURLOPT_POST, false);
curl_setopt($ch, CURLOPT_HTTPHEADER, array(
  "MINITALK_CLIENT_SECRET: $MINITALK_CLIENT_SECRET"
));
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));
}
?>

$.ajax({
  type: "GET",
  url: "https://api.minitalk.io/service/:client_id/status",
  dataType: "json",
  beforeSend: function(xhr) {
    xhr.setRequestHeader("MINITALK_CLIENT_SECRET", "$MINITALK_CLIENT_SECRET");
  },
  error: function(xhr, status, error) {
    console.log(error);
  },
  success: function(result) {
    console.log(result);
  }
});

결과 (HTTP 200)

{
    "success": "성공여부",
    "service": {
        "client_id": "서비스 클라이언트 아이디",
        "client_secret": "서비스 클라이언트 비밀키",
        "category": "서비스분류 (FREE : 무료호스팅, CHATTING : 채팅호스팅, SERVER : 서버호스팅)",
        "service": "서비스상세분류",
        "title": "서비스명",
        "version": "미니톡 클라이언트 버전 (6, 7)",
        "reg_date": "등록일",
        "exp_date": "만료일(무료호스팅, 채팅호스팅, 서버호스팅인 경우)",
        "client_version": "클라이언트버전 (서비스가 미니톡 클라이언트와 연결된 경우)",
        "client_url": "클라이언트 API 주소 (서비스가 미니톡 클라이언트와 연결된 경우)",
        "status": "서비스상태 (LINKED : 연결됨, EXPIRED : 만료됨, UNLINKED : 연결대기)",
        "server": "서버주소",
        "user": "현재 접속자수 (무료호스팅, 채팅호스팅인 경우)",
        "channel": "현재 접속자가 존재하는 채널수 (무료호스팅, 채팅호스팅인 경우)",
        "connection": "최대 동시접속자수 (무료호스팅, 채팅호스팅인 경우)",
        "latest_update": "접속자 및 채널수를 갱신한 최근 시각 (무료호스팅, 채팅호스팅인 경우)",
        "latest_sync": "미니톡 클라이언트에 접속자 정보를 동기화한 최근시각 (무료호스팅, 채팅호스팅인 경우)",
        "latest_sync_result": "미니톡 클라이언트에 접속자 정보를 동기화한 결과 (200 : 정상)",
        "next_payment_date": "다음 자동결제 예정일 (자동결제 사용시)",
        "ip": "서버 아이피주소 (서버호스팅인 경우)",
        "user_id": "서버접속 유저아이디 (서버호스팅인 경우)",
        "password": "서버접속 패스워드 (서버호스팅인 경우)"
    }
}

최종수정일 : 2021.04.17