개요
다우오피스 Works 연동을 위한 <Works 연동 API>입니다. Works 데이터 등록, 삭제, 수정이 가능합니다. 각각의 API의 Parameter는 동일하며, HTTP Method로 액션이 구분됩니다.
[works 앱 관리 – 외부데이터 가져오기]에서 ON 설정 후 인증키 발급 이후 사용 가능합니다.
Request URL
https://api.daouoffice.com/public/v1/works
※ 다우오피스 OpenAPI 서비스는 DOAS 서버로 API 호출을 진행하기 때문에 별도 고객사 그룹웨어 URL이 아닌 “https://api.daouoffice.com”을 사용합니다.
HTTP Method
| 구분 | HTTP Method |
|---|---|
| 등록 | POST |
| 수정 | PUT |
| 삭제 | DELETE |
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>를 통해 전달받은 값 |
| token | String | Y | Y | 사전 발급된 works 토큰. 발급한 사람의 아이디로 변경이력이 남습니다. |
| params | Object | Y | N | Works 연동을 위한 Object[배열] |
- params
| 변수 (Parameter) |
타입(Type) | 필수 여부 |
사전 발급 |
설명 (Description) |
|---|---|---|---|---|
| key | String | Y | Y | 변수(Parameter) |
| value | String | Y | N | 각 변수(Parameter)의 내용(Value) |
연동할 수 있는 컴포넌트 타입은 텍스트, 멀티 텍스트, 숫자, 드롭 박스, 체크박스, 단일 선택, 리스트박스, 날짜, 시간, 날짜와 시간 입니다. 지원하는 컴포넌트 중에 연동 필드로 설정되어 있거나 자동계산 필드라면 대상에서 제외됩니다.
Key값은 Works > 관리 > 외부 데이터 가져오기 > 연동항목관리에서 파라미터명으로 설정한 값으로, 틀린 값이거나 체크되어 있지 않을 경우 값을 보내도 실제 데이터에는 반영되지 않습니다.
날짜와 시간, 날짜, 시간의 경우 각각 "yyyy-MM-dd HH:mm" / "yyyy-MM-dd" / "HH:mm" 의 포멧만 허용됩니다.
Request Example
등록
POST /public/v1/works HTTP/1.1
api.daouoffice.com
Content-Type : application/json; charset=UTF-8
{
"clientId": "a9f5f5dec2e0b4f3",
"clientSecret" : "b5a7e1caffc3a1cbe9c1a3abd5e4b0f0",
"token" : "eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJ3b3JrcyIsImRhdGEiOnsidXNlcklkBwbGV0SWQiOjEwfSwiZXhwIjoxNjA5NDI2Nzk5fQ.xjBTlFOh3ncz0OsCKsIssbsfndx2at0QDJAxh8kyBSk",
"params" : {
"id" : 1,
"datetime" : "2020-11-04 13:00" ,
"date" : "2020-11-04" ,
"time" : "13:00" ,
"title" : "제목 생성",
"listbox" : [1, 2, 3],
"checkbox" : ["체크1", "체크2"],
"radio" : "옵션1",
"dropbox" : ["드롭2"],
"content" : "works 연동 멀티텍스트 예시"
}
}
수정
PUT /public/v1/works HTTP/1.1
api.daouoffice.com
Content-Type : application/json; charset=UTF-8
{
"clientId": "a9f5f5dec2e0b4f3",
"clientSecret" : "b5a7e1caffc3a1cbe9c1a3abd5e4b0f0",
"token" : "eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJ3b3JrcyIsImRhdGEiOnsidXNlcklkBwbGV0SWQiOjEwfSwiZXhwIjoxNjA5NDI2Nzk5fQ.xjBTlFOh3ncz0OsCKsIssbsfndx2at0QDJAxh8kyBSk",
"params" : {
"id" : 1,
"title" : "제목 수정",
"dropbox" : ["드롭2", "드롭3"],
"listbox" : [1, 2, 3]
}
}
삭제
DELETE /public/v1/works HTTP/1.1
api.daouoffice.com
Content-Type : application/json; charset=UTF-8
{
"clientId": "a9f5f5dec2e0b4f3",
"clientSecret" : "b5a7e1caffc3a1cbe9c1a3abd5e4b0f0",
"token" : "eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJ3b3JrcyIsImRhdGEiOnsidXNlcklkBwbGV0SWQiOjEwfSwiZXhwIjoxNjA5NDI2Nzk5fQ.xjBTlFOh3ncz0OsCKsIssbsfndx2at0QDJAxh8kyBSk",
"params" : {
"id" : 1
}
}
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 | 'XXXX'는 유효하지 않은 연동ID(clientId) 입니다. |
| 902 | 유효하지 않은 Client Secret | 연동 ID 'XXXX'의 패스워드가 일치하지 않습니다. |
제약 사항
| 구분 | 누적 호출 제한 횟수 | 비고 |
|---|---|---|
| 월간 | 1,500회 | - |
제공 서비스 유형
| 구분 | 제공 여부 |
|---|---|
| 다우오피스 단독형 | 제공 |
| 다우오피스 설치형 | 제공 |
| 다우오피스 구축형 | 제공 |
| 다우오피스 공유형 | 미제공 |