Q. 구루미 OPEN API 적용 순서가 궁금합니다.
일반적으로 구루미 OPEN API 적용을 할 때, 아래의 시나리오로 진행한다고 가정합니다.
- 발표자 - 연동 대상 사이트 회원 로그인 > 미팅룸 생성 > OTP 발급 로그인
- 참여자 - 발표자 공유 URL 전달 > 참여자 접속
위와 같은 시나리오에서 API 는 [미팅룸 생성(공유 URL 함께 생성)] > [미팅룸 사용자 OTP 생성] 또는 [미팅룸 접속 가져오기] 의 순서로 진행할 수 있습니다.
Q. 구루미 OPEN API 는 어떤 charset 을 사용하나요?
구루미 OPEN API 에서 제공되는 API는 모두 UTF-8 charset을 사용하고 있습니다.
Q. TLS 버전 관련 오류가 나는데 어떻게 해야하나요?
구루미는 보안 위험성으로 인해 TLS v1.0, v1.1 에 대한 지원을 하지 않습니다.
따라서 OPEN API 호출 시 아래와 같은 오류 메시지를 수신하였다면, TLS 버전을 업그레이드하여야 합니다.
Error Message
javax.net.ssl.SSLException: Received fatal alert: protocol_version
참고. Java 버전별 프로토콜 버전
| Java Version | SSL/TLS Default | Other Supported Versions |
|---|---|---|
| Java 6 | TLS 1.0 | TLS 1.1 (update 111 and later), SSLv3.0* |
| Java 7 | TLS 1.0 | TLS 1.2, TLS 1.1, SSLv3.0* |
| Java 8 | TLS 1.2 | TLS 1.1, TLS 1.0, SSLv3.0* |
- Java 6을 사용중인 경우에는 반드시 Java 7 이상으로 업그레이드 해야 합니다.
Q. 구루미 OPEN API 응답 데이터는 어떤 형태로 제공되나요?
구루미 OPEN API 의 모든 응답은 JSON 형태로 제공되고 있습니다.
구루미 OPEN API 응답 부분을 참고해주세요.
Q. API 호출시 인증토큰은 어떤 형태로 입력하나요?
인증토큰은 요청 헤더의 X-Grm-Authtoken 파라매터의 값으로 추가하여 사용하실 수 있습니다.
공통 헤더 부분을 참고해주세요.
Q. API 사용중 에러가 발생하였습니다. 무엇이 문제일까요?
API 사용 중 에러가 발생할 경우, HTTP 응답코드 값을 보고 에러사유를 판단할 수 있습니다.
아래의 응답코드 표를 참고하세요.추가적으로 응답은 성공하였지만 원하는 값이 보여지지 않는 경우에는 API 결과 코드를 참고하여 원인을 판단할 수 있습니다.
Q. API 파라매터 값에 한글이나 특수 문자 이용이 가능한가요?
구루미 OPEN API의 파라매터 값은 별도의 인코딩 처리 없이 바로 한글이나 특수문자를 값으로 사용할 수 있습니다.
Q. OTP 가 무엇인가요? 따로 발급을 받아야하나요?
OTP 는 구루미에서 미팅룸에 접속하기 위한 사용자 토큰을 이야기합니다.
OTP 는 미팅룸에 입장하기 전에 생성하여 사용자가 가지고 입장하게됩니다.OTP 는 KEY 방식의 고유값으로 랜덤으로 생성하여 사용자에게 주어지며, 중복되지 않기 때문에 사용자의 중복 입장 체크에도 이용됩니다.
모든 OTP 는 사용에 대한 유효시간이 있기 때문에 유효시간이 지나면 정상적인 요청이 이루어지지 않습니다.
Q. 미팅룸 생성은 하였는데, 미팅룸에 입장이 되지 않습니다. 어떻게 해야하나요?
사용자가 미팅룸에 들어가기 위해서는 해당 방에 맞는 OTP가 있어야만 합니다.
미팅룸 접속 경로 가져오기 API 를 사용하여 사용자 OTP를 생성하고, OTP가 포함된 접속 url 을 사용하여 방에 접속하여야 합니다.또한 미팅룸의 상태가 현재 사용이 불가하거나 해당 미팅룸의 인원이 꽉 차있는 경우도 있기 때문에 미팅룸 목록 조회 API 또는 미팅룸 정보 조회 API를 사용하여 입장하고자 하는 미팅룸의 상태를 확인하여야 합니다.
