REST API 연결 통합 - Amazon Quick
할 수 있는 작업시작하기 전 준비 사항API 엔드포인트 및 인증 준비REST API 통합 설정사용 가능한 작업 작업API 구성 옵션REST API 통합 관리

기계 번역으로 제공되는 번역입니다. 제공된 번역과 원본 영어의 내용이 상충하는 경우에는 영어 버전이 우선합니다.

REST API 연결 통합

Amazon Quick의 REST API 연결 통합을 사용하면 사용자 지정 REST APIs 및 웹 서비스로 작업을 수행할 수 있습니다. 이 통합은 작업 실행만 지원합니다.

할 수 있는 작업

REST API 연결 통합을 사용하면 작업 커넥터를 통해 사용자 지정 REST APIs 및 웹 서비스로 작업을 수행할 수 있습니다.

작업 커넥터

유연한 인증 옵션을 사용하여 HTTP 요청을 수행하고, 데이터를 검색하고, APIs.

참고

REST API 연결 통합은 데이터 액세스 또는 지식 기반 생성을 지원하지 않습니다. 작업 실행 및 사용자 지정 웹 서비스와의 API 상호 작용을 위해 특별히 설계되었습니다.

시작하기 전 준비 사항

REST API 통합을 설정하기 전에 다음이 있는지 확인합니다.

  • 적절한 액세스 권한이 있는 REST API 엔드포인트.

  • API 인증 자격 증명(OAuth, API 키 또는 기타).

  • 대상 웹 서비스에 대한 API 설명서입니다.

API 엔드포인트 및 인증 준비

Amazon Quick에서 통합을 구성하기 전에 REST API 엔드포인트 및 인증 자격 증명을 준비합니다. REST API 연결 통합은 여러 인증 방법을 지원합니다. API 요구 사항과 일치하는 메서드를 선택합니다.

사용자 인증(OAuth)

API 공급자로부터 다음 정보를 수집합니다.

  • 기본 URL - REST API 기본 URL입니다.

  • 클라이언트 ID - OAuth 애플리케이션 클라이언트 ID입니다.

  • 클라이언트 보안 암호 - OAuth 애플리케이션 클라이언트 보안 암호입니다.

  • 토큰 URL - OAuth 토큰 엔드포인트.

  • 인증 URL - OAuth 권한 부여 엔드포인트입니다.

  • 리디렉션 URL - OAuth 리디렉션 URI.

서비스 인증(Service-to-service OAuth)

API 공급자로부터 다음 정보를 수집합니다.

  • 인증 유형 - service-to-service 인증을 위한 OAuth 2.0 클라이언트 자격 증명 권한 부여 흐름입니다.

  • 기본 URL - REST API 기본 URL입니다.

  • 클라이언트 ID - 서비스 인증을 위한 OAuth 애플리케이션 클라이언트 식별자입니다.

  • 클라이언트 보안 암호 - 서비스 인증을 위한 OAuth 애플리케이션 클라이언트 보안 암호입니다.

  • 토큰 URL - 액세스 토큰을 얻기 위한 OAuth 토큰 엔드포인트입니다.

사용자 지정 헤더 및 파라미터

유연한 인증 및 API 상호 작용을 위해 사용자 지정 헤더 및 파라미터를 사용할 수 있습니다.

  • 사용자 지정 인증 헤더입니다.

  • API 버전 헤더.

  • 콘텐츠 유형 사양.

  • 사용자 지정 쿼리 파라미터입니다.

REST API 통합 설정

API 엔드포인트 및 인증 자격 증명을 준비한 후 다음 단계에 따라 REST API 통합을 생성합니다.

  1. Amazon Quick 콘솔에서 통합을 선택합니다.

  2. 통합 옵션에서 REST API 연결을 선택하고 추가(+) 버튼을 클릭합니다.

  3. 통합 세부 정보를 입력합니다.

    • 이름 - REST API 통합의 설명 이름입니다.

    • 설명(선택 사항) - 통합의 목적입니다.

  4. 연결 유형을 선택합니다.

    • 사용자 인증 - 개별 사용자 액세스를 위한 OAuth 기반 인증입니다.

    • 서비스 인증 - 서비스 액세스를 위한 API 키 기반 인증입니다.

  5. 선택한 인증 방법(사용자 또는 서비스)을 기반으로 연결 설정을 입력합니다.

  6. 다음을 선택합니다.

  7. 사용 가능한 작업을 검토합니다.

  8. 생성 및 계속을 선택합니다.

사용 가능한 작업 작업

REST API 통합을 생성한 후 REST API와 상호 작용하는 데 사용할 수 있는 작업을 검토할 수 있습니다. 일반적인 REST API 작업은 다음과 같습니다.

  • 데이터 검색을 위한 HTTP GET 요청입니다.

  • 데이터 생성을 위한 HTTP POST 요청.

  • 데이터 업데이트에 대한 HTTP PUT/PATCH 요청.

  • 데이터 제거를 위한 HTTP DELETE 요청입니다.

  • 사용자 지정 엔드포인트 상호 작용.

  • JSON 및 XML 데이터 처리.

  • 쿼리 파라미터 및 헤더 관리.

참고

사용 가능한 특정 작업은 REST API 엔드포인트와 통합에 대해 구성된 인증 권한에 따라 다릅니다.

API 구성 옵션

특정 요구 사항에 맞게 REST API 통합의 다양한 측면을 구성할 수 있습니다.

엔드포인트 구성

다음 엔드포인트 설정을 구성합니다.

  • 기본 URL 및 엔드포인트 경로.

  • HTTP 메서드 사양입니다.

  • 요청 및 응답 형식 처리.

  • 오류 처리 및 로직 재시도.

태그 처리

통합이 다양한 데이터 형식을 처리하는 방법을 구성합니다.

  • JSON 요청 및 응답 처리.

  • XML 데이터 변환.

  • 양식 데이터 및 멀티파트 업로드.

  • 바이너리 데이터 처리.

REST API 통합 관리

REST API 통합을 생성한 후 다음 옵션을 사용하여 관리할 수 있습니다.

  • 통합 편집 - 인증 설정, 기본 URL 또는 API 구성을 업데이트합니다.

  • 통합 공유 - 조직의 다른 사용자가 통합을 사용할 수 있도록 합니다.

  • 사용량 모니터링 - 통합 활동 및 API 호출 지표를 봅니다.

  • 작업 검토 - 사용 가능한 REST API 작업의 전체 목록을 확인합니다.

  • 엔드포인트 테스트 - API 연결 및 인증을 검증합니다.

  • 통합 삭제 - 통합을 제거하고 관련 인증을 취소합니다.

중요

REST API 통합은 대상 웹 서비스의 가용성 및 구성에 따라 달라집니다. API 또는 인증 요구 사항을 변경하면 통합 기능에 영향을 미칠 수 있습니다.