☁️ API 목록
URL | 메서드(METHOD) | 기능 |
---|---|---|
/api/v1/room | POST | 미팅룸 생성 |
/api/v1/room/list | GET | 미팅룸 목록 조회 |
/api/v1/room/{roomUrlId} | GET | 미팅룸 정보 조회 |
/api/v1/room/{roomId}/modify | POST | 미팅룸 정보 수정 |
/api/v1/room/{roomId} | DELETE | 미팅룸 종료 |
/api/v1/room/user/otp/url | POST | 미팅룸 접속 경로 가져오기 |
/api/v1/room/user/otp | POST | 미팅룸 사용자 OTP 생성 |
/api/v1/room/user/kick | POST | 미팅룸 사용자 강퇴 |
/api/v1/log/room | GET | 미팅룸 이력 조회 |
/api/v1/log/room/roomUser | GET | 미팅룸 사용자 이력 조회 |
/api/v1/room/currentRoomUserCnt | GET | 미팅룸 사용자 수 조회 |
☁️ 요청
구루미 OPEN API 의 요청 규격을 구성하는 요소는 다음과 같습니다.
구성요소 | 설명 |
---|---|
호스트 (Host) | 요청을 받는 구루미 OPEN API 서버의 도메인입니다. ex. openapi.gooroomee.com |
메서드 (Method) | 구루미 OPEN API 호출 시 사용되는 HTTP 요청 메서드입니다. ex. GET, POST, DELETE |
요청 경로 (URL) | API를 통해 제공되는 리소스마다 지정된 요청 경로입니다. 호스트와 함께 각 API의 엔드포인트(Endpoint)를 구성합니다. ex. api/v1/room |
헤더 (Header) | 구루미 OPEN API 호출 시 필요한 인증 토큰과 기타 추가 정보를 전달하는 데 사용합니다. 인증 토큰은 구루미에서 발급받은 액세스 토큰을 사용합니다. * 공통 헤더 참고 |
경로 변수 (Path Parameter) | 구루미 OPEN API 호출 시, 사용자가 전달한 값을 포함해 URL을 구성할 때 사용합니다. 미팅룸 정보 조회 등의 일부 구루미 OPEN API는 URL에 경로 변수를 포함합니다. ex. /api/v1/room/{roomUrlId} |
양식 데이터 (Form Data Parameter) | 요청 처리에 필요한 데이터를 전달하는 데 사용합니다. 파라미터는 키와 값의 쌍으로 구성되며, 바디(Body)를 통해 전달합니다. 각 파라미터는 자료형(Data type)과 필수 전달 여부가 지정되어 있습니다. |
1. 요청은 HTTP 프로토콜 1.1 규약을 준수하여 요청합니다.
2. 요청에 사용되는 파라미터는 UTF-8 인코딩을 사용합니다.
3. 요청에 사용되는 파라미터명은 대소문자를 구분합니다.
POST /api/v1/room HTTP/1.1
Accept: application/json
Content-Type: application/x-www-form-urlencoded
X-Grm-Authtoken: 1f23314cc31f14e19dc41fb5c1f6a717ca31dad31950011a43
Host: openapi.gooroomee.com
Content-Length: 164
roomTitle=string&roomUrlId=string&roomType=string&liveMode=false&maxJoinCount=4&liveMaxJoinCount=100&passwd=string&startDate=string&endDate=string&durationMinutes=0
GET /api/v1/room/list?page=1&limit=10&sortCurrJoinCnt=true HTTP/1.1
Accept: application/json
X-Grm-Authtoken: 1f23314cc31f14e19dc41fb5c1f6a717ca31dad31950011a43
Content-Type: application/x-www-form-urlencoded; charset=utf-8
Host: openapi.gooroomee.com
☁️ 응답
1. 응답은 JSON 포맷을 사용합니다.
2. HTTP 컨텐츠 타입을 application/json으로 응답하며, 인코딩은 UTF-8을 사용합니다.
Key | Type | Desc |
---|---|---|
resultCode | String | 결과코드 |
description | String | 결과설명 |
data | Object | 요청에 대한 응답데이터 key/value 형태의 데이터 오브젝트 |
{
"resultCode": "GRM_200",
"description": "방생성에 성공하였습니다.",
"data": {
"roomId": "3ebb248d43ff4f47ae5a05722e59d53b",
"title": "테스트 방"
}
}