Control Room API

Automation Anywhere Control Room은 사용자(그리고 자동화)가 Automation Anywhere와 상호 작용하는 방법을 맞춤 설정할 수 있는 API를 제공합니다.

중요사항:
  • Automation 360 v.34부터 다음 WLM API 엔드포인트는 사용이 중단되며, v.38 릴리스와 함께 지원 종료(EoL)될 예정입니다.
    • POST /v3/wlm/workitemmodel
    • GET /v3/wlm/workitemmodels/{id}
    • GET /v3/wlm/queues/{id}
    • POST /v3/wlm/queues/{id}/consumers
    • POST /v3/wlm/queues/{id}/participants
    • PUT /v3/wlm/queues/{id}/members/{userId}
    • POST /v3/wlm/queues/{id}/file
    • PUT /v3/wlm/queues/{id}/workitems/{workItemId}
    위의 API 엔드포인트를 다음 API 엔드포인트로 바꾸십시오.
    • POST /v4/wlm/workitemmodel
    • GET /v4/wlm/workitemmodels/{id}
    • GET /v4/wlm/queues/{id}
    • POST /v4/wlm/queues/{id}/consumers
    • POST /v4/wlm/queues/{id}/participants
    • PUT /v4/wlm/queues/{id}/members/{userId}
    • POST /v4/wlm/queues/{id}/file
    • PUT /v4/wlm/queues/{id}/workitems/{workItemId}
  • Automation 360 v.34부터, Bot 스케줄러 API 엔드포인트: /v1/schedule/automations는 더 이상 사용되지 않으며 /v2/schedule/automations로 대체됩니다. v1 버전은 v.38 릴리스와 함께 지원 종료(EoL)될 예정입니다.

다음 API 참조 섹션에서 모든 Control Room API 모듈 및 관련 엔드포인트를 보고 탐색할 수 있습니다.

아래의 다양한 API 버전은 시간 경과에 따른 다양한 API 반복을 나타냅니다. API가 발전함에 따라 새로운 기능이나 개선 사항이 도입됩니다. 이러한 변경 사항을 관리하고 기존 애플리케이션과의 호환성을 유지하기 위해 개발자는 버전 관리를 사용합니다.

v1 엔드포인트

모듈 설명
인증 API v1 인증 API를 사용하여 JSON 웹 토큰(JWT)의 진위성과 무결성을 확인하고, 활성 사용자 세션을 종료합니다.
감사 API 감사 API를 사용하여 Control Room에서 감사 로그 데이터를 검색합니다.
기기 API 기기 API를 사용하여 무인 Bot Runner 라이선스를 가진 이용 가능한 사용자 전체를 식별하거나 이름으로 사용자를 필터링합니다.
자동화 API 지원 중단됨 v1 Bot 스케줄러 API(자동화 API)를 이용하여 예약된 자동화에 대한 세부 정보를 생성, 업데이트, 삭제 및 반환합니다.
트리거 API 트리거 API를 사용하여 트리거를 유인 Bot Runner 사용자에 대한 역할 또는 사용자에 매핑합니다. 이벤트 트리거를 생성 및 삭제할 수도 있습니다.
API 태스크 실행 API API-태스크 실행 API를 사용하여 토큰과 함께 API 태스크 실행 URL을 생성하고 API 엔드포인트를 통해 API-태스크 실행을 시작합니다.
정책 관리 API 정책 관리 API를 사용하여 Control Room 내의 코드 분석, 정책 및 규칙을 관리합니다.
AI Agent Studio API AI Agent Studio 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에서 액세스할 수 있는 권한이 있는 객체(봇, 폴더 및 파일)에 대해 특정 태스크를 수행합니다.
BotInsight API Bot Insight API를 사용하여 실시간 비즈니스 인사이트 및 디지털 워크포스 퍼포먼스 데이터에 액세스하여 배포된 자동화에서 콘텐츠 수준의 생산성 데이터를 활용합니다.
BLM API BLM(봇 수명주기 관리) API를 이용하여 종속성 파일 및 명령 패키지와 함께 봇을 내보내고 가져올 수 있어 포괄적인 자동화 수명주기 관리가 가능합니다.
기기 풀 API 기기 풀 API를 사용하여 기기 풀을 만들고, 나열하고, 업데이트하고, 삭제합니다.
라이선스 API 라이선스 API를 사용하여 Control Room 라이선스 세부 정보를 검색하고 라이선스 재할당 또는 갱신 후 Control Room을 라이선스 서버와 수동으로 동기화합니다.
Process Composer API Processor Composer API를 사용하여 프로세스에서 새 요청을 만들고, 초기 양식을 검색하고, 참조 ID로 요청합니다.
자동화 API v2 Bot 스케줄러 API(자동화 API)를 이용하여 예약된 자동화에 대한 세부 정보를 생성, 업데이트, 삭제 및 반환합니다.
정책 관리 API v2 정책 관리 API를 사용하여 Control Room 내에서 코드 분석, 정책 및 규칙을 관리합니다.

v3 엔드포인트

모듈 설명
Bot 배포 API v3 Bot Deploy API를 사용하여 공용 워크스페이스에서 Bot Runner 장치로 Bot을 배포합니다.
워크로드 관리 API v3 워크로드 관리(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 장치로 봇을 배포합니다.
워크로드 관리 API v4 워크로드 관리(WLM) API를 사용하여 Control Room에서 작업 항목 모델, 대기열, 작업 항목 및 자동화를 프로그래밍 방식으로 관리하고 생성할 수 있습니다.
마이그레이션 API(Bot 마이그레이션) v4 마이그레이션 API를 사용하여 Enterprise 클라이언트 버전 Enterprise 11 및 Enterprise 10에서 생성한 TaskBot 및 MetaBot을 Automation 360으로 마이그레이션할 수 있습니다.
주: 오류를 방지하고 요청을 원활하게 처리하기 위해 모든 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 사용이 더 이상 권장되지 않지만 작동은 한다는 것을 나타냅니다. 개발자들은 최신 지원 버전의 API로 마이그레이션하는 것이 좋습니다. API는 원활한 전환을 위해 EoL(지원 종료) 날짜와 릴리스 버전까지 제공됩니다.

API EoL(지원 종료)이란 API가 더 이상 작동하지 않고, 더 이상 사용할 수 없게 되는 날짜와 릴리스 버전을 나타냅니다. 개발자들은 이 날짜 전에 최신 지원 버전의 API로 마이그레이션을 완료했어야 합니다.

다음 시나리오에서는 API 지원 중단이 필요할 수 있습니다.

  • 보안 취약점: 이전 API 버전에는 최신 버전에서 수정된 알려진 보안 취약점이 포함되어 있습니다.
  • 기술 부채 이전 API 버전은 더 이상 지원되지 않는 오래된 기술, 접근 방식 또는 프레임워크를 기반으로 구축될 수 있어 유지 관리나 개선이 어렵습니다.
  • 성능: 이전 API 버전은 최신 유스케이스나 규모 증가에 최적화되어 있지 않아 성능 저하와 느린 응답 시간을 초래합니다.
  • 사용자 경험: 지원 중단된 API 버전에는 사용자가 탐색하기 어렵게 만드는 혼란스럽거나 중복된 엔드포인트가 포함될 수 있습니다.

API는 최소 2년 동안 지원됩니다. 2년 후 API 지원 중단이 발표될 수 있으며, API는 최소 1년(4번의 릴리스) 동안 제공되어 최신 버전으로 전환할 충분한 시간을 제공합니다.

주: 위 정책은 공개 API의 보안 취약점으로 인한 사용 중단에는 적용되지 않습니다. 이러한 케이스에서는 위험을 완화하기 위해 즉각적인 조치가 필요하며, 가능한 한 빨리 이러한 변경 사항을 알리기 위해 모든 노력을 기울일 것입니다.