개요
다우오피스 OpenAPI 서비스의 근태 유형 연동을 위한 <근태 유형 등록 API> 입니다. 연동된 근태 유형은 DOAS(DaouOffice API System)의 중간 DB에 저장된 후 자체적인 동기화 주기 설정에 따라 다우오피스에 연동됩니다. 근태코드(timelineCode)가 중복으로 API 호출되는 경우 최종 덮어쓰기 방식으로 DOAS 중간 DB에 저장되며, 최종으로 저장된 중간DB 내용이 동기화 됩니다.
<근태 유형 등록>은 근태 기록 동기화를 위한 필수 사항은 아닙니다. 상황에 따라 <근태 기록 등록>만 연동해도 무관합니다.
기본 유형 4개 제공 : 출근(defaultClockIn), 퇴근(defaultClockOut), 업무(defaultOnWorking), 업무종료(defaultOffWorking)
하단 첨부파일에서 근태 연동 설정 가이드를 다운로드 하실 수 있습니다.
Request URL
https://api.daouoffice.com/public/v2/attnd/code
※ 다우오피스 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 | 업무시스템 고객사 식별정보(제휴시스템 사용할 경우 입력) |
| data | Object | Y | N | 근태 유형 정보 상세내용 JSON Object 배열 |
※ productName, productVersion, clientCompanyName은 외부업무시스템의 정보를 전달받아 문제 발생 시 다우기술에서 로그 확인을 위해 필요한 사항입니다. 필수 입력값은 아니므로 초기 개발 시 비워두고 정식 사용 시 값을 입력하는 것을 권장합니다.
- data
| 변수 (Parameter) |
타입(Type) | 필수 여부 |
사전 발급 |
설명 (Description) |
|---|---|---|---|---|
| timelineCode | String | Y | N | 근태상태 코드 / 근태관리와 근태코드의 매핑키 ※ 기본코드 외 연동이 필요한 경우 |
| name | String | Y | N | 근태상태 명칭 / 일반, 휴가, 교육, 출장 등 문구형태 정보 |
| includeWorkingTime | boolean | N | N | 근태상태(코드) 업무시간 포함 여부 (True/False) / default = True |
| useYN | boolean | N | N | 근태상태 사용 여부 (True/False) / default = True |
Request Example
POST /public/v2/attnd/code HTTP/1.1
api.daouoffice.com
Content-Type: application/json
{
"clientId": "f255cbe0b4a9d12f",
"clientSecret": "bafdd7b4cff6fabdc417b8a6b0e4fff6",
"productName" : "DSoft BIS",
"productVersion" : "3.1.21",
"clientCompanyName" : "ddgs11231#1122"
"data": [
{"timelineCode" : "AttndCode101","name" : "휴가","includeWorkingTime" : "True", "useYN" : "True"},
{"timelineCode" : "AttndCode102","name" : "출장","includeWorkingTime" : "True", "useYN" : "True"},
{"timelineCode" : "AttndCode103","name" : "교육","includeWorkingTime" : "False", "useYN" : "True"}
]
}
Response Parameters
| 변수 (Parameter) |
타입 (Type) |
필수 여부 |
사전 발급 |
설명 (Description) |
|---|---|---|---|---|
| code | String | Y | N | API 호출결과 코드 |
| message | String | Y | N | API 호출결과 메시지 |
| messageDetail | String | N | N | API 호출결과 상세내용 (실패한 경우만 리턴함) |
Response Example
Content-Type: application/json;charset=UTF-8
{
"code": "200",
"message": "OK"
}
Return Code
| 구분 | 코드 (Code) |
내용 (Message) |
설명 (Description) |
|---|---|---|---|
| 성공 (Success) |
200 | 성공 | OK |
| 실패 (Error) |
901 | 유효하지 않은 client ID | client ID를 확인하세요. |
| 902 | 유효하지 않은 client Secret | client Secret을 확인하세요. | |
| 970 | 유효하지 않은 데이터 포맷 | 데이터 포맷을 확인하세요. | |
| 971 | 중복 데이터 | 변경 내역이 없는 중복 데이터입니다. |
제공 서비스 유형
| 구분 | 제공 여부 |
|---|---|
| 다우오피스 단독형 | 제공 |
| 다우오피스 설치형 | 제공 |
| 다우오피스 구축형 | 제공 |
| 다우오피스 공유형 | 미제공 |