개요

다우오피스 OpenAPI 서비스의 계정 정보 조회 연동을 위한 <계정 정보 조회 API> 입니다. 개인정보 조회에 동의하지 않으면 부가 정보들은 NULL 처리된 정보로 조회됩니다. 계정 정보 조회 시 회사 내 전체 임직원의 계정 정보가 전달됩니다.

 

Request URL

https://api.daouoffice.com/public/v1/account
※ 다우오피스 OpenAPI 서비스는 DOAS 서버로 API 호출을 진행하기 때문에 별도 고객사 그룹웨어 URL이 아닌 “https://api.daouoffice.com”을 사용합니다.

 

HTTP Method

POST (Content-Type: application/json; charset=UTF-8)

 

Request Parameters

변수
(Parameter)
타입(Type) 필수
여부
사전
발급
설명
(Description)
clientId String Y Y 고객사 식별/인증을 위한 서비스 인증ID / Client ID
※ <
인증키 발급 API>를 통해 전달받은 값
clientSecret String Y Y 고객사 식별/인증을 위한 서비스 보안KEY / Secret Key
※ <
인증키 발급 API>를 통해 전달받은 값
productName String N N 업무시스템 제품명(제휴시스템 사용할 경우 입력)
productVersion String N N 업무시스템 제품버전(제휴시스템 사용할 경우 입력)
clientCompanyName String N N 업무시스템 고객사 식별정보(제휴시스템 사용할 경우 입력)

※ productName, productVersion, clientCompanyName은 외부업무시스템의 정보를 전달받아 문제 발생 시 다우기술에서 로그 확인을 위해 필요한 사항입니다. 필수 입력값은 아니므로 초기 개발 시 비워두고 정식 사용 시 값을 입력하는 것을 권장합니다.

 

Request Example

POST /public/v1/account HTTP/1.1
api.daouoffice.com
Content-Type: application/json
{
"clientId": "f255cbe0b4a9d12f",
"clientSecret": "bafdd7b4cff6fabdc417b8a6b0e4fff6",
"productName" : "DSoft BIS",
"productVersion" : "3.1.21",
"clientCompanyName" : "ddgs11231#1122"
}

 

Response Parameters

변수
(Parameter)
타입
(Type)
필수
여부
사전
발급
설명
(Description)
code String Y N API 호출결과 코드
message String Y N API 호출결과 메시지
messageDetail String N N API 호출결과 상세내용 (실패한 경우만 리턴함)
data Object Y N API 호출결과 상세내용 JSON Object 배열

 

- data

변수
(Parameter)
타입(Type) 필수
여부
사전
발급
설명
(Description)
enName String N N 영문 이름
zhcnName String N N 중국 간체 이름
zhtwName String N N 중국 번체 이름
viName String N N 베트남어 이름
status String N N 계정 상태 ※ 정상 ONLINE(default) / 중지 STOP / 메일휴면 DORMANT
positionCode String N N 직위 코드 ※ 빈 값은 null로 표시
positionName String N N 직위명 ※ 빈 값은 null로 표시
gradeCode String N N 직급 코드 ※ 빈 값은 null로 표시
gradeName String N N 직급명 ※ 빈 값은 null로 표시
code String Y Y 사용자그룹 코드 ※ 빈 값은 null로 표시
name String Y Y 사용자그룹 명 ※ 빈 값은 null로 표시
locale String N N 사용언어 ※ ko, en, ja, zh_CN, zh_TW, vi
mobileNo String N Y 휴대전화 ※ 빈 값은 null로 표시
directTel String N Y 직통전화 ※ 빈 값은 null로 표시
repTel String N Y 회사/부서 대표전화 ※ 빈 값은 null로 표시
messanger String N Y 메신저 ※ 빈 값은 null로 표시
address String N Y 주소 ※ 빈 값은 null로 표시
birthday String N Y 생일 YYYY-MM-DD / lunarCal(음력) Y/N ※ 빈 값은 null로 표시
fax String N Y 팩스번호 ※ 빈 값은 null로 표시

 

Response Example

Content-Type: application/json;charset=UTF-8
{
"code": "200",
"message": "OK",
"data": [
{ 내용생략 … }
]
}

 

Return Code

구분 코드
(Code)
내용
(Message)
설명
(Description)
성공
(Success)
200 성공 OK
실패
(Error)

901 유효하지 않은 client ID client ID를 확인하세요.
902 유효하지 않은 client Secret client Secret을 확인하세요.
955 도메인 코드 오류 'XXXX'는 존재하지 않는 도메인 코드입니다.

 

제약 사항

구분 누적 호출 제한 횟수 비고
월간 900회 -

 

제공 서비스 유형

구분 제공 여부
다우오피스 단독형 제공
다우오피스 설치형 제공
다우오피스 구축형 제공
다우오피스 공유형 미제공

추가 도움이 필요하신가요?

이용/기능 문의는 스피키를 이용해 보세요.

기술지원은 상단 [문의등록]를 통해 제공해드립니다.