1. Home
  2. 관리자 사용설명서
  3. [보안 관리] Open API Key 발급 및 사용 방법
  1. Home
  2. 보안 관리
  3. [보안 관리] Open API Key 발급 및 사용 방법

[보안 관리] Open API Key 발급 및 사용 방법

;Docswave Open API 서비스를 이용하여 다양하게 ;Docswave를 이용해 보세요!

;Docswave Open API Server : https://openapi.docswave.com/

Open API Key 발급

;Docswave를 다양하게 활용하고 싶은 ;Docswave Premium 고객을 위해 공개된 API를 제공합니다.

1. Open API Key 발급받기

(1) 관리자 메뉴 > 보안 관리 메뉴 > ‘Open API 관리’로 이동합니다.

(2) 우측 상단 [+] 버튼을 클릭합니다.

(3) [Key 명]을 입력합니다.

(4) 우측 [저장] 버튼을 클릭합니다.

  • 여러 시스템에서 Open API를 이용하신다면 사용 목적에 맞게 여러 Open API Key를 발급받아 사용할 수 있습니다.

2. Open API Key 수정하기

발급받은 Open API Key 명을 수정할 수 있습니다.

(1) 관리자 메뉴 > 보안 관리 메뉴 > ‘Open API 관리’로 이동합니다.

(2) 발급된 Open API Key 우측 [펜] 버튼을 클릭합니다.

(3) [Key 명]을 수정합니다.

(4) 우측 [저장] 버튼을 클릭합니다.

3. Open API Key 사용 중지하기

만약 비정상적인 Open API 호출이 의심되신다면 즉시 Key 사용을 중지할 수 있습니다.

(1) 관리자 메뉴 > 보안 관리 메뉴 > ‘Open API 관리’로 이동합니다.

(2) 발급된 Open API Key 좌측 [사용 설정]OFF로 변경하시면 해당 Open API Key 사용이 중지됩니다.


Open API 사용 방법

‘Open API 관리’에서 발급받은 Key로 이용하실 수 있습니다.

1. Open API Key 테스트하기

(1) 관리자 메뉴 > 보안 관리 메뉴 > ‘Open API 관리’로 이동합니다.

(2) 발급 받은 ‘OPEN API KEY’를 복사합니다. (Ctrl + C)

(3) ;Docswave Open API Server로 이동합니다. (https://openapi.docswave.com)

(4) 조직 정보 조회, 부서 정보 조회, 조직원 정보 조회 중 테스트 하고자 하는 항목을 클릭합니다.

(5) Parameters 부분에 [Try it out] 버튼을 클릭합니다.

(6) 발급 받은 ‘OPEN API KEY’를 입력합니다. (Ctrl + V)

(7) 하단 [Execute] 버튼을 클릭합니다.

(8) 하단에서 해당 결과를 조회할 수 있습니다.

2. Open API Key 내역 확인하기

(1) 관리자 메뉴 > 보안 관리 메뉴 > ‘Open API 사용 내역 관리’로 이동합니다.

(2) 발급 받은 ‘OPEN API KEY’에 대한 요청 내역을 모두 확인할 수 있습니다.

  • Open API Key
  • 요청 일시
  • 요청 URL
  • 요청 메소드
  • 요청 헤더
  • 요청 파라미터
  • 응답 상태
  • 응답 값
  • 에러 메세지
  • 요청 IP
  • 요청 기기
  • 요청 브라우저

Updated on 2020년 6월 23일

이 글이 도움이 되셨나요?

관련있는 문서