오비스의 오픈 API를 활용할 수 있습니다. 오비스의 기능과 외부 서비스 및 시스템과 연계 / 통합하여 더욱 효율적인 조직 관리 및 협업을 진행해보세요.
대상 플랜
모든 플랜
※ 무료 플랜의 경우 리퀘스트 수의 제한과 같은 사양이 사전 고지 없이 변경될 수 있습니다.
API 키 생성 권한
조직 관리자
API 키 생성 방법
1. 화면의 좌측 상단 버튼 → 조직 → 조직 설정을 클릭합니다. (조직 탭은 조직의 관리자에게만 표시됩니다)
2. API → 콘솔 → API 키 추가를 클릭합니다.
3. API 키의 이름을 입력하고 [ 확인 ]를 클릭합니다.
4. 클라이언트 ID 및 클라이언트 암호를 각각 복사하고 [ 확인 ]을 눌러 닫습니다.
⚠️ 클라이언트 암호는 API 키 생성 시에만 표시됩니다. 창을 닫으면 다시 표시할 수 없으므로 반드시 복사하여 안전한 장소에 보관해주세요! API 암호 분실 시 API를 삭제한 후 재생성하여 주시기 바랍니다.
API의 이용
아래 페이지를 참고하시기 바랍니다.
API 키 활성화 / 비활성화하기
API 키를 일시적으로 비활성화합니다. 활성화 시에도 동일한 방법으로 진행합니다.
1. API 키 우측 [ 작업 ⌄ ]을 눌러 업데이트를 선택합니다.
2. API Key 상태 항목을 비활성화 (또는 활성화)로 설정하고 [ 수정 ] 버튼을 클릭하여 저장합니다.
API 키 삭제하기
API 키를 영구적으로 삭제합니다. API 키를 삭제하기 위해서는 API가 비활성화 상태여야 합니다.
1. API 키 우측 [ 작업 ⌄ ]을 눌러 업데이트를 선택합니다.
2. API Key 상태 항목을 비활성화로 설정하고 [ 수정 ] 버튼을 클릭하여 저장합니다.
3. API 키 우측 [ 작업 ⌄ ]을 눌러 삭제를 선택합니다. 확인 창이 나타나면 삭제 버튼을 클릭합니다.
Tips
- API 키는 한 조직 당 한 개만 발급할 수 있습니다.
- API를 실행할 때 외부에서 클라이언트 ID 및 클라이언트 암호에 접근하지 못하도록 클라이언트 측(브라우저 등)이 아닌 서버 측에서 진행하여야 합니다.
- 만약 클라이언트 ID 및 클라이언트 암호가 유출된 경우에는 즉시 삭제 후 재발급 해주시기 바랍니다.