오픈 API | 조직도 기능 활용하기!
안녕하세요 원티드스페이스입니다😀
원티드스페이스 기능 중 아래 기능은 오픈 API기능을 통해 원티드스페이스 앱을 사용하지 않고, 조직도를 조회할 수 있도록, API기능을 만들었습니다.
아래 내용을 참고해서 API를 연동해주세요.
*아래 내용을 내부 개발자에게 전달해서 사용해주시면 되고, 연동 시 어려운 점이 있으면 챗봇을 통해 문의해주세요
Open API 설정
위 링크를 눌러 해당 페이지로 이동해주세요.
(해당 페이지는 최고 관리자만 접속 가능하니, API키와 시크릿 키는 최고관리자가 발급 후 개발자에게 안내해주세요.)
*API의 경우 근태 등의 정보를 포함하고 있음으로, 설정 및 권한 부여 시 반드시 주의해서 사용해주세요.
발급을 눌러 API와 시크릿키를 생성해주세요.
*** 발급 받은 API키와 시크릿키는 절대 공개된 곳에 오픈하지 마세요.**
API 권한 설정
필요한 API만 선택해서 저장해주세요.
IP보안 설정
API를 호출할 수 있는 IP를 입력해주세요. 입력하지 않으면, 모든 IP에서 해당 API를 호출할 수 있습니다.
인증
- HTTP Header에 Authorization에 오픈API시크릿키를 입력해주세요.
- 요청 시 key에 오픈API키를 입력해주세요.
제한
- 1분에 30번만 호출할 수 있어요.
- 호출당 50개의 결과가 조회돼요.
조직도 팀 조회
[GET] https://api.wantedspace.ai/tools/openapi/org/list_team/
Request Parameters.
| 이름 | 타입 | 필수여부 | 설명 |
|---|---|---|---|
| key | String | O | 오픈API key |
Response
| 이름 | 타입 | 설명 |
|---|---|---|
| team_id | Number | 팀ID |
| team_name | String | 팀명 |
| team_leader_email | Number | 팀리더 이메일 |
| team_parent | String | 상위팀ID |
| team_charger_email | String | 상위팀리더 이메일 |
| team_nums | Number | 팀 인원수 |
Example
Request
curl -H "Authorization: {오픈API시크릿키}"\
-X GET "<https://api.wantedspace.ai/tools/openapi/org/list_team/?key={오픈API키}>"
Response
[
{
"team_id": 512,
"team_name": "인사팀",
"team_parent": 366,
"team_nums": 1,
"team_leader_email": "test2@wantedspace.ai",
"team_charger_email": "test@wantedspace.ai"
},
]
조직도 멤버 조회
[GET] https://api.wantedspace.ai/tools/openapi/org/
Request Parameters
| 이름 | 타입 | 필수여부 | 설명 |
|---|---|---|---|
| key | String | O | 오픈API key |
| team_id | Number | O | 팀ID |
Response
| 이름 | 타입 | 설명 |
|---|---|---|
| next | String | 다음 페이지 URL |
| previous | String | 이전 페이지 URL |
| count | Number | 총 조회 개수 |
| results | Array | 조회결과 |
조회결과
| 이름 | 설명 |
|---|---|
| 이름 | |
| username | 이메일 |
| position | 직책 |
| team_id | 팀ID |
| cmem_status | - WORKING: 회사 내 근무 상태 |
| onduty_detail | - status: 당일 출근, 퇴근 여부 - BEFORE: 출근 전 - WORKING: 근무중 - AWAY: 자리비움 - LEFT: 퇴근완료 - events_txt: 근태이벤트 현황 |
Request
curl -H "Authorization: {오픈API시크릿키}"\
-X GET "<https://api.wantedspace.ai/tools/openapi/org/?key={오픈API키}&team_id=0>"
Response
{
"next": null,
"previous": null,
"count": 1,
"results": [
{
"email": "test@wantedspace.ai",
"username": "강미르",
"position": "",
"team_id": 381,
"onduty_detail": {
"events_txt": "",
"status": "BEFORE"
},
"cmem_status": "WORKING"
},
}