개요
다우오피스 OpenAPI 서비스의 연동을 위하여 발급받은 인증키를 재발급하기 위한 <인증키 재발급 API> 입니다.
Request URL
https://api.daouoffice.com/public/v1/alliance/reissue
※ 다우오피스 OpenAPI 서비스는 DOAS 서버로 API 호출을 진행하기 때문에 별도 고객사 그룹웨어 URL이 아닌 “https://api.daouoffice.com”을 사용합니다.
HTTP Method
POST (Content-Type: application/json; charset=UTF-8)
Request Parameters
| 변수 (Parameter) |
타입(Type) | 필수 여부 |
사전 발급 |
설명 (Description) |
|---|---|---|---|---|
| siteUrl | String | Y | Y | 다우오피스 접속 URL / 고객사 DO URL (ex. daoutech.daouoffice.com) |
| clientID | String | Y | Y | 고객사 식별/인증을 위한 서비스 인증ID / Client ID ※ <인증키 발급 API>를 통해 전달받은 값 |
| adminId | String | Y | Y | 다우오피스 관리자 계정 / SiteAdmin ID / 이메일 주소 형식 (ex. admin@daouoffice.com) |
| adminPw | String | Y | Y | 다우오피스 관리자 비밀번호 / 고객사 SiteAdmin PW |
| productName | String | N | N | 업무시스템 제품명(제휴시스템 사용할 경우 입력) |
| productVersion | String | N | N | 업무시스템 제품버전(제휴시스템 사용할 경우 입력) |
| clientCompanyName | String | N | N | 업무시스템 고객사 식별정보(제휴시스템 사용할 경우 입력) |
※ productName, productVersion, clientCompanyName은 외부업무시스템의 정보를 전달받아 문제 발생 시 다우기술에서 로그 확인을 위해 필요한 사항입니다. 필수 입력값은 아니므로 초기 개발 시 비워두고 정식 사용 시 값을 입력하는 것을 권장합니다.
Request Example
POST /public/v1/alliance/reissue HTTP/1.1
api.daouoffice.com
Content-Type: application/json
{
"siteUrl" : "partner.daouoffice.com",
"clientId": "f255cbe0b4e1wgasf",
"adminId" : "admin@partner.daouoffice.com",
"adminPw" : "password1234#",
"productName" : "제휴서비스/제품 명",
"productVersion" : "제휴서비스/제품 버전",
"clientCompanyName" : "제휴서비스/제품 식별코드"
}
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) |
|---|---|---|---|---|
| clientId | String | Y | Y | 고객사 식별/인증을 위한 서비스 인증ID ( Client_ID ) |
| clientSecret | String | Y | N | 고객사 식별/인증을 위한 서비스 보안KEY ( Secret_Key ) |
Response Example
Content-Type: application/json;charset=UTF-8
{
"code": "200",
"message": "OK",
"data":{
"clientId": "f255cbe0b4e1wgasf",
"clientSecret": "bafdd7bf1e12esdc417b8a6b0e4fff6"
}
}
Return Code
| 구분 | 코드 (Code) |
내용 (Message) |
설명 (Description) |
|---|---|---|---|
| 성공(Success) | 200 | 성공 | OK |
|
실패 |
901 | 유효하지 않은 client ID | client ID를 확인하세요. |
| 910 | 유효하지 않은 파라미터 | 도메인을 포함한 이메일 형식이여야 합니다. | |
| 911 | 계정 형식 오류 | 도메인을 포함한 이메일 형식이여야 합니다. | |
| 951 | 존재하지 않는 계정 | 'XXXX'는 존재하지 않는 계정입니다. | |
| 999 | 유효하지 않는 라이선스 | 발급받은 라이선스를 확인하세요. |
제공 서비스 유형
| 구분 | 제공 여부 |
|---|---|
| 다우오피스 단독형 | 제공 |
| 다우오피스 설치형 | 제공 |
| 다우오피스 구축형 | 제공 |
| 다우오피스 공유형 | 미제공 |