Control Room API
- 최종 업데이트2024/09/09
Control Room API
Automation Anywhere Control Room은 사용자(그리고 자동화)가 Automation Anywhere와 상호 작용하는 방법을 사용자 정의할 수 있는 API를 제공합니다.
중요사항:
- Automation 360 V.33에서 인증 API: POST
v1/authentication
및 POSTv1/authentication/token
은 사용 중단되고 작동이 중지됩니다. 중단 없는 액세스를 보장하려면 애플리케이션이 v2 버전의 인증 API를 사용하도록 업데이트하십시오. POSTv2/authentication
및 POSTv2/authentication/token
. - Automation 360 V.33에서 사용자 관리 API:
v1/usermanagement
가 사용 중단되고 작동이 중지됩니다. 중단 없는 액세스를 보장하려면 애플리케이션이 v2 버전의 사용자 관리 APIv2/usermanagement
를 사용하도록 업데이트하십시오.
다음 API 참조 테이블에서 모든 Control Room API 모듈 및 관련 엔드포인트를 보고 탐색할 수 있습니다:
버전1 | 엔드포인트 | 설명 |
---|---|---|
v1 | 인증 API | v1 인증 API를 사용하여 JSON 웹 토큰(JWT)의 진위성과 무결성을 확인하고, 활성 사용자 세션을 종료합니다. |
감사 API | 감사 API를 사용하여 Control Room에서 감사 로그 데이터를 검색합니다. | |
기기 API | 기기 API를 사용하여 무인 Bot Runner 라이선스를 가진 이용 가능한 사용자 전체를 식별하거나 이름으로 사용자를 필터링합니다. | |
자동화 API | Bot 스케줄러 API(자동화 API)를 이용하여 예약된 자동화에 대한 세부 정보를 생성, 업데이트, 삭제 및 반환합니다. | |
트리거 API | 트리거 API를 사용하여 이벤트 트리거를 만들고 삭제할 수 있으며, 트리거를 유인 Bot Runner의 사용자 또는 역할에 매핑할 수도 있습니다. | |
API 태스크 실행 API | API-태스크 실행 API를 사용하여 토큰과 함께 API 태스크 실행 URL을 생성하고 API 엔드포인트를 통해 API-태스크 실행을 시작합니다. | |
v2 | 인증 API | v2 인증 API를 사용하여 모든 Enterprise Control Room API에서 인증에 필요한 JSON 웹 토큰(JWT)을 생성하고 새로 고칩니다. |
사용자 관리 API | 사용자 관리 API를 사용하여 Control Room에서 역할과 사용자를 보고 삭제하십시오. | |
Credential Vault API | Credential Vault API를 사용하여 자격증명, 자격증명 속성 값, 로커 및 키를 생성, 검색, 업데이트 및 삭제할 수 있습니다. | |
Bot 실행 오케스트레이터 API | v2 Bot Execution Orchestrator API를 사용하여 장치를 모니터링합니다. | |
리포지토리 관리 API | 리포지토리 관리 API를 사용하여 Control Room에서 액세스할 수 있는 권한이 있는 객체(bot, 폴더 및 파일)에 대해 특정 태스크를 수행합니다. | |
BotInsight API | Bot Insight API를 사용하여 실시간 비즈니스 인사이트 및 디지털 워크포스 퍼포먼스 데이터에 액세스하여 배포된 자동화에서 콘텐츠 수준의 생산성 데이터를 활용합니다. | |
BLM API | Bot 수명주기 관리(BLM) API를 이용하여 종속성 파일 및 명령 패키지와 함께 Bot을 내보내고 가져올 수 있어 포괄적인 자동화 수명주기 관리가 가능합니다. | |
기기 풀 API | 기기 풀 API를 사용하여 기기 풀을 만들고, 나열하고, 업데이트하고, 삭제합니다. | |
라이선스 API | 라이선스 API를 사용하여 Control Room 라이선스 세부 정보를 검색하고 라이선스 재할당 또는 갱신 후 Control Room을 라이선스 서버와 수동으로 동기화합니다. | |
Process Composer API | Processor Composer API를 사용하여 프로세스에서 새 요청을 만들고, 초기 양식을 검색하고, 참조 ID로 요청합니다. | |
v3 | Bot 배포 API | v3 Bot Deploy API를 사용하여 공개 작업 공간에서 Bot Runner 장치로 Bot을 배포합니다. |
워크로드 관리 API | 워크로드 관리(WLM) API를 사용하여 Control Room에서 작업 항목 모델, 대기열, 작업 항목 및 자동화를 프로그래밍 방식으로 관리하고 생성할 수 있습니다. | |
마이그레이션 API(Bot 마이그레이션) | v3 마이그레이션 API를 사용하여 Enterprise 클라이언트 버전 Enterprise 11 및 Enterprise 10에서 생성한 TaskBot 및 MetaBot을 Automation 360으로 마이그레이션할 수 있습니다. | |
Bot 실행 오케스트레이터 API | v3 Bot Execution Orchestrator API를 사용하여 자동화 활동 진행 상황을 모니터링합니다. | |
v4 | Bot 배포 API(V4) | v4 Bot Deploy API를 사용하여 공개 작업 공간에서 Bot Runner 장치로 Bot을 배포합니다. |
마이그레이션 API(Bot 마이그레이션) | v4 마이그레이션 API를 사용하여 Enterprise 클라이언트 버전 Enterprise 11 및 Enterprise 10에서 생성한 TaskBot 및 MetaBot을 Automation 360으로 마이그레이션할 수 있습니다. |
1API 버전은 시간 경과에 따른 다양한 API 반복을 나타냅니다. API가 발전함에 따라 새로운 기능이나 개선 사항이 도입됩니다. 이러한 변경 사항을 관리하고 기존 애플리케이션과의 호환성을 유지하기 위해 개발자는 버전 관리를 사용합니다.
주: 오류를 방지하고 요청을 원활하게 처리하기 위해 모든 JSON 매개변수 이름은 대소문자를 구분한다는 점을 기억하십시오. 자세한 내용은 API 참조 문서의 관련 섹션에서 올바른 대소문자를 사용하여 쿼리와 요청 본문을 구성하는 데 도움이 되는 명확한 지침과 예시를 참조하십시오.
Control Room 시작하기
모든 요청에는 JSON 인증 토큰이 있는 X-Authorization 헤더 또는 Control Room 요청에 대한 전달자 토큰이 있는 인증 헤더가 포함되어야 합니다. 다음 섹션에서는 사용 가능한 Control Room API 엔드포인트, 메서드, 리소스, 인증 프로토콜, 매개변수 및 헤더에 대한 세부 정보와 일반적인 요청 및 응답의 예를 보여줍니다.
주: 전달자 토큰은 Automation 360 v.27 릴리스 이상부터 지원됩니다. 이전 릴리스에서는 지원되지 않으며 무시됩니다. OAuth 서비스에서 전달자 토큰을 가져와야 합니다. 액세스 권한을 부여하려면 X-Authorization(인증 API 사용) 또는 인증(OAuth 사용)을 사용합니다. 동일한 API에서 둘 모두를 사용할 수 없습니다.
Control Room Swagger를 사용하여 API를 보고 실행할 수 있습니다. https://{control-room}/swagger/ 링크를 사용하여 Control Room Swagger 문서에 액세스하고 {control-room}을 Control Room 인스턴스로 교체합니다. 다음 섹션에서는 Control Room API 요청 작성 방법에 대한 유용한 정보를 제공합니다.
- 일부 API에서는 원하는 출력을 얻기 위해 결과를 필터링, 페이지 매김, 정렬해야 합니다. 필터링, 페이지 매김, 정렬에 대한 자세한 내용은 필터링, 페이지 매김 및 정렬를 참고하십시오.
- 응답의 API 응답 코드는 API 응답 코드에 설명되어 있습니다.
- Automation 360 및 Enterprise 11 API 비교는 Enterprise 11과 Automation 360 API를 비교합니다.