{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"92c993d1-e4e5-4fb5-9514-948885242bf8","name":"하이웍스 API","description":"더 편리한 세상을 위해 하이웍스 API를 공유합니다.\n\n하이웍스 API는 HTTP 요청으로 활용할 수 있는 [REST API](https://ko.wikipedia.org/wiki/REST) 형태로 제공하므로 HTTP를 처리할 수 있는 많은 언어에서 사용 가능합니다.\n\n<img src=\"http://customer.gabia.com/cs/file_viewer.php?s=21287\">\n\n하이웍스 API 문서 페이지에서는 [Postman](https://getpostman.com)을 이용하여 API를 테스트할 수 있는 환경을 제공합니다.  \n우측 상단의 [<i>Run in Postman</i>](https://www.getpostman.com/docs/run_button_ux)을 클릭하여 API를 확인해 주세요.\n\n---\n\n# 시작하기\n\n하이웍스 API는 크게 2가지로 분류됩니다.\n\n<img src=\"http://customer.gabia.com/cs/file_viewer.php?s=21286\">\n\n**1\\. 서비스 API**: 푸시 알림, 전자결재 기안하기, 메일 발송하기 등 하이웍스 서비스의 전반적인 기능을 이용할 수 있는 API입니다.\n\n**2\\. 계정 연동 API**: 하이웍스 화면을 아이프레임을 이용해 인트라넷에 삽입하는 SSO와 인트라넷의 조직 정보를 하이웍스 인사 계정에 넣는 조직 API로 구성되어 있습니다.\n\n| 종류 | 설명 |\n| --- | --- |\n| **서비스 API** | 메신저 알림, 전자결재 기안하기, 메일 발송하기 등 하이웍스 서비스의 전반적인 기능을 이용할 수 있는 API입니다. |\n| **계정 연동 API** | 별도 로그인 없이 하이웍스 화면을 인트라넷에 포함하는 SSO와 인트라넷의 조직 정보를 하이웍스 인사 계정에 전달하는 조직 API로 구성되어 있습니다. |\n\n---\n\n# 인증 및 호출하기\n\n하이웍스 API를 이용하기 위해서는 인증이 필요하며 Token(a.k.a API KEY)을 통해 인증을 수행합니다.  \n토큰은 **Office Token**, **Access Token(OAuth)** 총 2가지로 분류됩니다.\n\n<img src=\"https://customer.gabia.com/image?seqno=26941\">\n\n| 종류 | 설명 |\n| --- | --- |\n| `OfficeToken` | 오피스(그룹웨어)의 권한으로 인증하는 방식입니다. **강력한 권한**을 지니므로 관리 시 주의가 필요합니다. |\n| `AccessToken (deprecated)` | OAuth 방식을 활용하여 사용자 계정에 접근하는 인증입니다. 사용자는 최초 인증 시 해당 애플리케이션 승인 절차를 진행합니다. |\n\n## Office Token\n\n\\[오피스 관리 > 오피스 API\\] 페이지에서 `officeToken`을 발급할 수 있습니다. 자세한 내용은 [여기](https://customer.gabia.com/manual/hiworks/3403/4280)에서 확인할 수 있습니다.\n\n- `officeToken`을 비밀번호처럼 사용해 주십시오.\n    \n- 관리자, 개발자 외에 해당 토큰을 공유하지 마십시오.\n    \n- 해당 토큰을 코드에 삽입하거나 URL에 포함하지 마십시오.\n    \n\n> `officeToken`을 이용한 보다 폭 넓은 API 연동을 원할 경우 [제휴 문의](https://partner.hiworks.com/partner/contact)로 연락해주시기 바랍니다. \n  \n\n## Access Token (_deprecated_)\n\nOuth 2.0 방식을 통해 사용자 정보에 접근할 수 있는 `accessToken`을 획득합니다.  \n단, `accessToken`의 신규 발급은 현재 지원하지 않습니다.\n\n1. `Authorization Code` 발급을 위해 URL을 호출합니다.\n    \n2. API를 이용해 `accessToken` 발행을 요청합니다.\n    \n\n## REQUEST\n\nAPI를 호출할 때는 반드시 헤더에 발급받은 `officeToken` 또는 `accessToken`을 포함해야 합니다.\n\nHTTP method(GET, POST)에 따라 API를 호출하는 방식이 다르며, 일반적으로 GET의 경우 parameter로 전달하고, POST/PUT/DELETE 방식은 HTTP BODY 영역에 값을 포함합니다.\n\n---\n\n```\n# GET 방식의 호출 \nhttps://api.hiworks.com/office/v2/sms/count?user_id=admin&{{ref_key}}\n\n ```\n\n```\n# POST 방식의 호출 \n{\n    \"list\":\n        [\n            {\n                \"department_code\": \"001\",\n                \"department_name\": \"코스트센터001\",\n                \"ext_key\": \"center001\"\n            },\n            {\n                \"department_code\": \"002\",\n                \"department_name\": \"코스트센터002\",\n                \"ext_key\": \"center002\"\n            }\n        ]\n}\n\n ```\n\n---\n\n# 제한 정책\n\n`accessToken`을 이용하는 경우, 애플리케이션 당 최대 **1,000건/일**의 API Call(성공 기준)이 가능합니다.  \n`officeToken`을 이용하는 경우, 오피스 당 최대 **1,000건/일**의 API Call(성공 기준)이 가능합니다.\n\n이 외에도 애플리케이션 측에서 악의적으로 API를 이용한다고 판단되는 경우, 악용하는 경우 Hiworks API 플랫폼 보호를 위해 이용을 제한할 수 있습니다.\n\n해당 쿼리를 초과하거나, API를 활용한 사업적 파트너 제휴가 필요할 경우 [제휴 문의](https://partner.hiworks.com/partner/contact)로 연락해주시기 바랍니다.\n\n---\n\n# 지원\n\nAPI에 관련한 정책 및 문의 사항은 [개발자 포럼](https://developers.hiworks.com/community/forum)에 글을 남기거나 [developers@gabia.com](https://mailto:developers@gabia.com)로 연락해주시기 바랍니다. Hiworks API에 대한 다양한 제안 등 다양한 목소리도 환영합니다.\n\n# API 목록","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"6863253","team":296661,"collectionId":"92c993d1-e4e5-4fb5-9514-948885242bf8","publishedId":"S1TVWcri","public":true,"publicUrl":"https://documenter-api.postman.tech/view/6863253/S1TVWcri","privateUrl":"https://go.postman.co/documentation/6863253-92c993d1-e4e5-4fb5-9514-948885242bf8","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"documentationLayout":"classic-double-column","version":"8.10.1","publishDate":"2019-05-31T07:40:30.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[{"name":"production","id":"0d3b5c5f-0464-4998-ab40-a4606e0a7182","owner":"66958","values":[{"key":"hiworks_api_url","value":"https://api.hiworks.com","description":"","enabled":true},{"key":"authorization_bearer","value":"Bearer","description":"","enabled":true}],"published":true}],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/5a276709ee5c406f9abf205204ddae6b675293b35abedb8ae49e6b2af77b703a","favicon":"https://res.cloudinary.com/postman/image/upload/v1552982185/team/ulq21tlyfj79efmdogyk.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"},{"label":"production","value":"66958-0d3b5c5f-0464-4998-ab40-a4606e0a7182"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/S1TVWcri"}