API 태스크 실시간 엔드포인트

실시간 엔드포인트로 즉시 API 태스크를 호출하십시오. API 태스크 실행 URL을 토큰과 함께 생성하여 API 엔드포인트를 통해 API 태스크 실행을 시작할 수 있습니다.

핵심 이점

  • 프로그래밍 방식 배포: 선호하는 API 클라이언트를 사용하여 API 태스크를 어디서나 실시간으로 호출하십시오.
  • 응답 시간: 실시간에 가까운 응답 속도의 저지연 설계를 통해 일반적으로 밀리초 이내의 즉각적인 응답을 제공하고자 합니다.
  • 프로세싱:
    • 자동화는 클라우드에 로드되어 항상 요청을 수락할 준비가 되어 있습니다. 이를 통해 빠른 처리와 응답이 가능합니다.
    • 프리미엄 라이선스는 자동화를 확장하고 API 태스크의 여러 인스턴스를 실행할 수 있는 더 큰 클라우드 리소스 풀에 액세스하여 동시성을 높이고 더 많은 API 태스크 요청을 동시에 처리할 수 있도록 도와줍니다.
  • 유스케이스:
    • 챗봇과 같은 대화형 서비스에 가장 적합
    • 실시간 부정 행위 탐지
    • 온라인 케이스 생성
    • 그외의 즉각적인 응답이 중요한 모든 유스케이스

선행조건

아래의 코드 조각 예시는 API 태스크를 클라우드 장치에 배포하는 절차를 구현합니다. 또한 API 태스크을 배포할 때 Bot에 변수를 전달할 수도 있습니다.

단계 1: API 태스크 실시간 엔드포인트
Control Room 인스턴스에 대한 액세스를 인증합니다.
단계 2: API 태스크 실시간 엔드포인트
관리자가 API 태스크 할당을 만들 수 있습니다.
단계 3: API 태스크 실시간 엔드포인트
관리자는 모든 API 태스크 할당을 나열할 수 있습니다.
단계 4: API 태스크 실시간 엔드포인트
API 태스크를 배포할 URL과 토큰을 생성합니다.
단계 5: API 태스크 실시간 엔드포인트
토큰과 함께 생성된 고유 URL을 사용하여 API 태스크를 실행합니다.

인증

환경에 대한 액세스 권한을 얻으려면 인증하십시오. 여기에는 일반적으로 액세스 토큰 또는 API 키가 포함됩니다.

POST https://{{ControlRoomURL}}v1/authentication
Header: X-Authorization: <<authentication token>> or Authorization: Bearer <<b
earer token>>

API 태스크 실시간 엔드포인트와 상호 작용하기 위한 두 가지 인증 흐름이 있습니다.

1. 봇 개발자 인증(API 태스크 실행):

이 플로우를 통해 봇 개발자는 API 태스크(API 태스크 실시간 엔드포인트)를 실행하기 위한 URL과 토큰(API 태스크 실시간 엔드포인트)을 생성할 수 있습니다.

모든 API 호출에는 인증 API의 인증 토큰(JSON 웹 토큰 생성) 또는 OAuth 서비스의 전달자 토큰이 포함되어야 합니다. 하나의 API에서 둘 모두를 사용할 수 없습니다.

2 관리자 인증(API 태스크 할당):

이 인증은 봇 개발자가 API 태스크를 실행할 수 있도록 관리자가 클라우드에서 API 태스크를 할당(API 태스크 실시간 엔드포인트)하는 데 필요합니다.

API 태스크 할당 만들기(관리자)

주: API 태스크 할당을 만들려면 관리자 권한이 필요합니다.

API 태스크를 체크인한 후에는 API 태스크를 클라우드에 추가할 수 있습니다. 이 API 엔드포인트는 API 태스크를 클라우드에 추가하고 API 태스크를 실행할 리소스 할당을 생성합니다. API 태스크 내에서 Control Room 할당을 자세히 설명하는 섹션은 클라우드에 API 태스크 추가입니다. API 태스크 할당은 API 태스크가 생성된 후에 수행됩니다. API 태스크 생성과 관련된 자세한 내용은 API 태스크 생성(양식의 API 태스크) 항목을 참조하십시오.

PUT https://{{ControlRoomURL}}orchestrator/v1/hotbot/config/create
요청 본문:
{
  "fileId": "5",
  "runAsUserOrNone": 3,
  "concurrencyLimit": 2
}
응답:
{
  "fileId": "5",
  "runAsUserOrNone": 3,
  "concurrencyLimit": 2
}
요청/응답 매개변수
매개변수 유형 필수 설명
fileId 정수 예

배포할 자동화의 ID.
runAsUserOrNone 정수 아니요 API 태스크에 대한 RunAsUser 컨텍스트를 설정하는 apitaskrunner입니다. Apitaskrunner에 대한 자세한 내용은 API 작업의 사용자로 실행(apitaskrunner) 항목을 참조하십시오.
주: 이 RunAsUser에는 Bot Runner 라이선스가 필요하지 않습니다.
concurrencyLimit 정수 아니요 주어진 실시간(핫봇) 요청에 대해 실행할 최대 동시성 개수입니다.

(선택 사항) API 태스크 할당 나열하기(관리자)

주: API 태스크 할당을 나열하려면 관리자 권한이 필요합니다.

이 API 엔드포인트는 Control Room 내의 모든 API 태스크 할당을 나열합니다. 토큰으로 API 작업 실행 URL을 생성하기 전에 특정 API 태스크가 API 태스크 할당 목록에 추가되었는지 확인할 수 있습니다.

POST https://orchestrator/v1/hotbot/config
요청 본문:
{
  "page": {
    "offset": 0,
    "length": 100
  }
}
요청 매개변수
매개변수 유형 필수 설명
페이지 객체 아니요 object (PageRequest)

페이지 매김 규칙을 통해 원하는 페이지를 기준으로 필터링할 수 있습니다.
오프셋 정수 아니요 페이지 시작 인덱스.
길이 정수 아니요 페이지 길이.
응답:
{
    "list": [
        {
            "fileId": "149",
            "filePath": "Automation Anywhere\\Bots\\Zip Code API Task",
            "fileName": "Zip Code API Task",
            "runAsUserOrNone": "12",
            "concurrencyLimit": 1
        },
        {
            "fileId": "180",
            "filePath": "Automation Anywhere\\Bots\\API_task_String 01 1708025672.bot",
            "fileName": "API_task_String 01 1708025672.bot",
            "runAsUserOrNone": "12",
            "concurrencyLimit": 3
        },
        {
            "fileId": "184",
            "filePath": "Automation Anywhere\\Bots\\API_task_Rest 01 1708026445.bot",
            "fileName": "API_task_Rest 01 1708026445.bot",
            "runAsUserOrNone": "12",
            "concurrencyLimit": 5
        }
    ],
    "page": {
        "offset": 0,
        "total": 3,
        "totalFilter": 3
    }
}
응답 매개변수
매개변수 유형 설명
fileId 정수

자동화의 ID.
filePath 문자열 자동화의 파일 경로
fileName 문자열 자동화의 파일 이름.
runAsUserOrNone 정수 API 태스크에 대한 RunAsUser 컨텍스트를 설정하는 apitaskrunner입니다. Apitaskrunner에 대한 자세한 내용은 클라우드에 API 태스크 추가 항목을 참조하십시오.
concurrencyLimit 정수 주어진 실시간(핫봇) 요청에 대해 실행할 최대 동시성 개수입니다.

태스크 실행 URL/토큰 생성

이 API 엔드포인트는 API 태스크를 배포할 수 있는 태스크 실행 URL과 토큰을 생성합니다.

POST https://orchestrator/v1/hotbot/config/accessdetails
요청 본문:
{
  "botRepositoryPath": [
    "Automation Anywhere\\Bots\\My-API-Task"
  ]
}
요청 매개변수
매개변수 유형 필수 설명
botRepositoryPath 문자열 예 API 태스크의 리포지토리 경로.
응답:
{
  "accessDetails": {
    "Automation Anywhere\\Bots\\My-API-Task": {
      "url": "https://hotbot-2689-knative-0a665343-88e9-17be-8189-936dad5d0144.prod-ause1-ee.my.automationanywhere.digital/execute",
      "headers": {
        "X-Authorization": "eyJhbGciOiJSUzUxMiJ9.eyJzdWIiOiIzODAiLCJ0ZW5hbnRVdWlkIjoiMGE2NjUzNDMtODhlOS0xN2JlLTgxODktOTM2ZGFkNWQwMTQ0IiwiY2xpZW50VHlwZSI6IldFQiIsIm11bHRpcGxlTG9naW4iOnRydWUsImJvdElkIjoyNjg5LCJpYXQiOjE3MDgzNTIxOTgsImV4cCI6MTcwODM5NTM5OCwiaXNzIjoiQXV0b21hdGlvbkFueXdoZXJlIiwibmFub1RpbWUiOjI5OTg3MDkyNzIxNjc5MH0.p8xsnlec7-ZbPJBfDDk1Wq0k8RqAzzsL6bK7BOtLp_jY1NgQvdAO5Yra647-94JV2cY8Vbe5H7zObia3S9oQ9dFXrnmSSSYs3_x7e_-vkaNcwx1Ev3J7lymqnH8Xc73s-TTGyebRlXiI714Ii62DJ_vKBEUvNM47V0H1FQk6xIfpzJAMMDRFZWO3MUvowgD4L-O6xre0RLapCYOSVtH_0CbM0VBfNkuwDAnF1kQeCtpWIvv_nETy7A-UdSox9GqtDp9h2Elkl-v3KJ8kEru7qT4fWZlsuzFPL7XzqkALCP39N7fxOpzlCfHYGPooLRHcFLGIPxpqi1bkfsn-Xk2BfQ"
      }
    }
  },
  "errors": {
  }
}
응답 매개변수
매개변수 유형 설명
url 문자열

URL - API 태스크 배포를 위한 다음 요청의 컨테이너 엔드포인트입니다.
X-Authorization 문자열 헤더에 X-Authorization로 제공해야 하는 토큰을 포함합니다.
주:

API 태스크 실행 URL과 API 태스크 실행에 필요한 헤더를 생성하고 나면 생성된 URL을 통해 배포 요청을 전송할 수 있습니다. 입력을 지정하는 경우 자동화에서 이러한 매핑된 값을 성공적으로 수신하고, 해당 자동화에 해당하는 변수를 입력으로 표시해야 합니다. 또한 자동화의 변수 이름은 요청 본문에 매핑되는 값과 일치해야 합니다.

API 태스크 실행

토큰과 함께 생성된 고유 URL을 사용하여 API 태스크를 실행합니다.

POST https://hotbot-2689-knative-0a665343-88e9-17be-8189-936dad5d0144.prod-ause1-ee.my.automationanywhere.digital/execute
Header: X-Authorization: eyJhbGciOiJSUzUxMiJ9.eyJzdWIiOiIzODAiLCJ0ZW5hbnRVdWlkIjoiMGE2NjUzNDMtODhlOS0xN2JlLTgxODktOTM2ZGFkNWQwMTQ0IiwiY2xpZW50VHlwZSI6IldFQiIsIm11bHRpcGxlTG9naW4iOnRydWUsImJvdElkIjoyNjg5LCJpYXQiOjE3MDgzNTIxOTgsImV4cCI6MTcwODM5NTM5OCwiaXNzIjoiQXV0b21hdGlvbkFueXdoZXJlIiwibmFub1RpbWUiOjI5OTg3MDkyNzIxNjc5MH0.p8xsnlec7-ZbPJBfDDk1Wq0k8RqAzzsL6bK7BOtLp_jY1NgQvdAO5Yra647-94JV2cY8Vbe5H7zObia3S9oQ9dFXrnmSSSYs3_x7e_-vkaNcwx1Ev3J7lymqnH8Xc73s-TTGyebRlXiI714Ii62DJ_vKBEUvNM47V0H1FQk6xIfpzJAMMDRFZWO3MUvowgD4L-O6xre0RLapCYOSVtH_0CbM0VBfNkuwDAnF1kQeCtpWIvv_nETy7A-UdSox9GqtDp9h2Elkl-v3KJ8kEru7qT4fWZlsuzFPL7XzqkALCP39N7fxOpzlCfHYGPooLRHcFLGIPxpqi1bkfsn-Xk2BfQ
요청 본문:
{
   "botInput":{
      "iStrZipCode":{
         "type":"STRING",
         "string":"76131"
      }
   }
}
요청 매개변수
매개변수 유형 필수 설명
botInput 객체
유형 모두 아니요 기본값은 STRING입니다. 유형에 대해 가능한 값은 다음과 같습니다. STRING, NUMBER, BOOLEAN, FILE, ITERATOR, LIST, DICTIONARY, TABLE, VARIABLE, CONDITIONAL, WINDOW, TASKBOT, DATETIME, UIOBJECT, RECORD, EXCEPTION, CREDENTIAL, COORDINATE, IMAGE, REGION, PROPERTIES, TRIGGER, CONDITIONALGROUP, FORM, FORMELEMENT, HOTKEY, and WORKITEM.
응답:
{
   "hotBotResult":{
      "botOutput":{
         "State":{
            "type":"STRING",
            "string":"California"
         },
         "Place":{
            "type":"STRING",
            "string":"San Jose"
         }
      }
   }
}
응답 매개변수
매개변수 유형 설명
hotBotResult 객체

API 태스크 출력이 포함된 객체.