REST 웹 서비스 패키지

API에 요청을 보내고 응답을 받으려면 REST 웹 서비스 패키지내의 작업을 메서드(DELETE, GET, PATCH, POST, PUT)로 사용합니다.

REST 웹 서비스 작업을 이용한 작업

REST 요청을 보내고 응답을 받으려면 다음 정보를 제공합니다. 모든 메서드에 모든 매개변수가 필요한 것은 아닙니다.
  • URI 입력: API 리소스에 대한 고유 주소.
  • 프록시 구성: 프록시를 설정하려면 프록시 구성에서 시스템 또는 사용자 정의 탭을 선택합니다.
    옵션 설명
    시스템

    시스템 프록시는 봇이 실행 중일 때 봇 러너 시스템에서 구성된 프록시입니다.

    이 옵션을 선택하면 Bot 에이전트는 시스템 프록시를 사용합니다.
    사용자 정의

    이 옵션을 사용하면 작업의 REST 웹 서비스에서 사용자 정의 프록시 설정을 구성할 수 있습니다. 예를 들어 REST API를 시스템 프록시가 아닌 다른 프록시를 통해 라우팅해야 하는 경우에는 사용자 정의 옵션을 선택하고 REST 작업 내에서 프록시 세부 정보를 제공하면 됩니다.

    다음의 세부 정보를 입력합니다.

    • 호스트: 프록시의 호스트 이름 또는 IP 주소입니다.
    • 포트: 프록시의 포트 번호입니다.
    • 사용자 이름(선택 사항): 프록시 인증에 사용되는 사용자 이름입니다.
    • 비밀번호(선택 사항): 프록시 인증에 사용되는 비밀번호입니다.
      주: 구성할 프록시가 인증된 프록시인 경우, 사용자 이름 및 비밀번호 필드에 인증 자격증명을 입력해야 합니다.
    호스트, 포트, 사용자 이름 및 비밀번호 필드에는 자격증명, 변수 또는 안전하지 않은 문자열 탭 중 하나를 선택합니다.
    • 자격증명: 자격증명 저장소에 있는 사용 가능한 값을 사용합니다.
    • 변수: 자격증명 값을 사용자 정의 변수에 저장하는 변수를 사용합니다.
    • 안전하지 않은 문자열: 사용할 값을 수동으로 지정합니다.
  • 인증 모드: 지원되는 인증 모드에는 세 가지가 있습니다.
    • 인증 없음: 서버에 액세스하기 위해 인증이 필요하지 않은 엔드포인트에 액세스하려면 이 옵션을 사용합니다.
    • Control Room 사용자 토큰: REST 웹 서비스 작업은 Control Room에 로그인할 때 생성된 토큰을 사용하여 엔드포인트에 액세스합니다.
    • 기본: 기본은 사용자를 인증하는 가장 간단한 방법입니다. 이 옵션을 선택한 경우 사용자 이름 및 비밀번호를 입력합니다. 이 기술에서는 사용자 이름 및 비밀번호를 base64 인코딩한 표현과 함께 Authorization이라는 헤더를 사용합니다.
    • 로그인한 AD 사용자: 관련 API에 액세스할 권한이 있는 AD(Active Directory) 사용자는 AD를 통해 인증됩니다. 요청에는 자격증명이 필요하지 않습니다.
    • Windows NTLM(NT LAN 관리자) 인증(AD 사용자): 클라이언트가 자신의 사용자 이름과 비밀번호를 암호화된 자격증명 또는 일반 텍스트로 제공할 수 있게 해주는 질문/응답 인증 방법입니다. Automation Anywhere Credential Vault에 저장된 자격증명을 이용하는 것이 좋습니다.
    • OAuth2 - Control Room 관리: OAuth와 Control Room을 통합하면 타사 공급자 인증에 사용되는 토큰을 중앙에서 관리하고 안전하게 보관할 수 있습니다. Control Room에서 OAuth 연결을 사용하려면, 웹 서비스를 구성하고 인증 세부 정보(예: 클라이언트 ID, 클라이언트 비밀, 인증 URL 등)를 메모해 두어야 합니다. 세부 정보는 OAuth에 Control Room 연결 구성 항목을 참조하십시오.

      다음 비디오에서 OAuth의 REST 웹 서비스 연결을 사용하는 방법을 확인할 수 있습니다.

  • 헤더: 모든 메서드에 헤더가 필요한 것은 아닙니다. 헤더는 요청과 연결된 메타데이터를 나타냅니다.
  • 콘텐츠 유형: 헤더에 콘텐츠 유형이 포함된 경우, 클라이언트와 서버 간의 콘텐츠 협상을 정의합니다. REST 웹 서비스 작업은 다음 콘텐츠 유형을 지원합니다.
    • application/x-www-form-urlencoded의 경우: URL의 매개변수를 인코딩합니다.
    • JSON (application/json): JSON 요청 본문을 입력합니다.
    • XML (application/xml): XML 요청 본문을 입력합니다.
    • 텍스트 (text/plain)
    • XML (text/xml)
    • HTML (text/html)
    • multipart/form-data:
      • 대부분의 경우 서버에 파일을 업로드하기 위해 2진 데이터를 전송합니다. 일반적으로 텍스트 데이터(예: 양식 필드)와 파일 업로드 등 단일 요청에 여러 부분을 전송하는 경우에 사용됩니다. FileStream 변수를 사용할 수도 있습니다. 자세한 내용은 다음을 참고하십시오.
      • FileStream: FileStream을 변수에 할당하면 읽을 수 있습니다. 예를 들어 OneDrive 위치의 변수에 할당된 FileStream을 읽을 수 있습니다. 자세한 내용은 파일 할당 작업 항목을 참조하십시오.Rest 웹 서비스 FileStream
    • 바이너리: 바이너리는 이미지, 비디오 및 오디오 파일과 같은 RAW 파일을 보내는 데 사용합니다. 바이너리를 선택할 때 바이너리 파일을 변수로 업로드할 수 있습니다(Control Room 파일 또는 데스크톱 파일).
    • 사용자 정의
      사용자 정의: 표준 콘텐츠 유형에 속하지 않는 사용자 정의 콘텐츠를 추가합니다. 예를 들어 v.11.x에서 Automation 360으로 마이그레이션하는 경우 다음 값은 어떤 표준 콘텐츠 유형에도 속하지 않습니다. application/vnd.whispir.message-v1+json
  • 대체 추가: REST 요청 본문에 변수를 입력할 수 있습니다. 변수는 데이터의 상징적 표현이며, 필요할 때마다 수동으로 입력하지 않고도 값에 액세스할 수 있게 해줍니다. 예를 들어 다음 REST 본문 요청을 생각해 보십시오.
    {
   "name":"{{name}}",
   "email":"{{email}}",
   "status":"Active"
}
    위의 요청 본문에서 대체 추가를 클릭하고 필요한 값을 추가하면 이중 중괄호로 묶인 값을 바꿀 수 있습니다.
  • 고급 옵션:
    • 캡처 실패 응답: 확인란을 선택하면 성공/확인 응답을 제외한 실패 응답을 캡처할 수 있습니다. 실패 응답 세부 정보는 응답 본문에 캡처됩니다.
    • https를 사용할 때 안전하지 않는 연결 허용: 확인란을 선택하면 https를 사용할 때 안전하지 않은 연결을 허용할 수 있습니다.
    • 쿠키 허용: 확인란을 선택하면 서버 응답에서 세션 쿠키를 자동으로 캡처할 수 있습니다.
      • 캡처: 이 기능을 활성화하면 서버 응답에 포함된 세션 쿠키를 캡처합니다.
      • 안전한 저장 공간: 캡처된 쿠키는 프로세스 메모리 내에서 암호화되어 영구적으로 저장되지 않고 자동화 세션 외부에서 접근할 수 없도록 보장합니다.
      • 재사용: 쿠키는 이후 REST 호출에 자동으로 포함되어 수동 쿠키 처리를 제거하고 자동화 안정성을 개선합니다.
      • 다중 쿠키 처리: 이 기능은 서버에서 반환된 여러 개의 쿠키를 원활하게 처리하여 필요한 모든 인증 자격증명이 포함되도록 합니다.
      • 파괴: 자동화 세션이 종료되거나 봇이 실행을 완료하면 캡처된 쿠키가 자동으로 파괴되어 데이터 보안 및 개인정보 보호를 보장합니다.
      주: 캡처된 쿠키는 출처 도메인으로만 사용이 국한되며 다른 도메인으로의 후속 REST 호출에는 자동으로 사용되지 않습니다. 이는 domainA.com에서 캡처된 쿠키는 domainB.com에 대한 요청에 사용되지 않는다는 의미입니다.
    • 파일 다운로드: (Get 메서드에만 사용 가능) 이 확인란을 선택하면 특정 위치로 파일을 다운로드할 수 있습니다. URI는 파일을 반환/다운로드해야 합니다. 원하는 폴더 경로와 확장자가 포함된 파일 이름을 입력합니다. 올바른 파일 확장자를 사용했는지 확인하십시오. 예시: C:/Users/Downloads/image01.jpg
      팁: 파일을 저장하려는 폴더에 이미 존재하는 동일한 이름의 파일을 덮어쓰려면 이미 존재하는 경우 파일 덮어쓰기 옵션을 선택합니다.
      오류 처리:
      잘못된 URI:
      제공된 URI가 올바르지 않으면 오류 메시지가 표시됩니다.
      파일을 찾을 수 없음:
      지정된 위치에 파일이 존재하지 않아 API 응답이 비어 있는 경우 오류 메시지가 표시됩니다.
      권한 불충분:
      다운로드 위치에 대한 쓰기 권한이 없으면 오류 메시지가 표시됩니다.
      파일 확장자 불일치:
      파일 확장자가 예상 유형과 일치하지 않으면 오류 메시지가 표시됩니다.
  • 작업이 완료될 때까지 대기: REST 요청을 보내고 응답을 받을 때 타임아웃 값을 설정할 수 있습니다. POST, PUT, DELETE, PATCH, GET과 같은 작업을 수행할 때 작업 완료 대기 필드에서 대기 시간(밀리초 단위)을 지정할 수 있습니다. 기본적으로 대기 시간은 60,000밀리초입니다.
  • 출력 변수 응답 출력은 사전 변수에 캡처됩니다. 사전 변수는 키-값 쌍입니다. 응답 헤더 이름을 키로 사용하여 헤더 값을 반환하거나 "Body"를 키로 사용하여 응답 본문을 반환합니다.
    주: 해당 값을 가진 응답 키는 REST API의 응답 상태를 표시하기 위해 사전 변수에서 사용할 수 있습니다.
    API 리소스의 헤더 이름 목록을 가져오려면 다음 단계를 수행합니다.
    1. 다음을 삽입합니다. 루프 작업(다음 뒤에: REST 웹 서비스 작업.
    2. 사전 안의 각 키에 대해 반복자를 선택합니다.
    3. 사전 변수 필드에서 REST 웹 서비스 작업 출력을 보유한 변수를 선택합니다.
    4. 각 키의 값을 $prompt-assignment$에 할당합니다.
    5. 다음을 삽입합니다. 파일에 기록 작업.
    6. 헤더 이름 목록을 유지할 텍스트 파일의 파일 경로를 제공합니다.
    7. $prompt-assignment$를 로그할 텍스트 입력 필드에 삽입합니다.
    8. 기존 파일 덮어쓰기 옵션을 선택합니다.
    9. 저장을 클릭합니다.

      봇을 실행하면 API 리소스에서 선택한 파일로 헤더 이름을 인쇄합니다.

안전하게 값 전달

다음의 지원되는 Credential Vault 필드에서 로커, 자격증명 및 속성을 지정하여 웹 서비스로 값을 안전하게 전달할 수 있습니다. 작업 필드:
  • URI
  • 사용자 정의 헤더
  • 본문: application/x-www-form-urlencoded 콘텐츠 유형의 경우, 매개변수 추가를 클릭하여 Credential Vault에서 값을 선택합니다.

    다른 모든 콘텐츠 유형의 경우 매개변수로 자격증명 선택 옵션을 선택하고 선택을 클릭합니다.

REST 웹 서비스 내의 작업 패키지

작업 설명
DELETE 메소드 URI로 식별된 리소스를 제거합니다.
GET 메소드 URI에 포함된 매개변수로 식별된 정보를 검색합니다. GET 메서드에 대한 콘텐츠 유형이 없습니다. 모든 매개변수가 URI의 일부로 전달되기 때문입니다.

GET 메서드의 제한 사항과 특징에는 다음이 포함됩니다.

  • URI 길이는 2,048자로 제한됩니다.
  • 모든 매개변수는 URI로 전달됩니다.
  • GET 메서드는 URI에 있는 데이터를 노출하여 POST 메서드보다 보안성이 떨어집니다.
  • GET은 데이터를 변경하지 않으므로 권한에 상관없이 모든 사용자에게 안전합니다.

Get 메소드 사용 항목을 참조하십시오.
PATCH 메소드 URI로 식별된 리소스를 수정합니다.
POST 메소드 URI에 새 리소스를 만듭니다.
  • 매개변수는 요청 본문에서 전달됩니다.
  • 요청 본문의 길이에는 제한이 없습니다.

Post 메소드 사용 항목을 참조하십시오.
PUT 메소드 URI 또는 본문에 전달된 매개변수를 기반으로 리소스를 업데이트하거나 대체합니다. Put 메소드 사용 항목을 참조하십시오.

프록시 지원

기기가 프록시로 구성된 경우, 이 패키지로부터의 모든 아웃바운드 요청은 프록시 서버를 통해 라우팅됩니다. 프록시를 사용하여 Bot 에이전트를 기기에 연결 항목을 참조하십시오.