검색

9.2. API 클라이언트 커넥터 추가 및 관리

download PDF

Fuse Online에서는 다음과 같은 API 클라이언트 커넥터를 생성할 수 있습니다.

  • OpenAPI 문서의 REST API 클라이언트 커넥터입니다. OpenAPI 문서의 콘텐츠에 대한 자세한 내용은 REST API 클라이언트 커넥터 개발을 참조하십시오.
  • WSDL 파일의 Cryostat API 클라이언트 커넥터입니다.

다음 항목에서는 REST API 클라이언트 커넥터를 추가 및 관리하기 위한 정보와 지침을 제공합니다.

API 클라이언트 커넥터를 생성한 후 해당 커넥터 사용에 대한 자세한 내용은 Fuse Online을 애플리케이션 및 서비스에 연결, API 클라이언트에 연결을 참조하십시오.

9.2.1. REST API 클라이언트 커넥터 생성

OpenAPI 문서를 업로드하여 Fuse Online에서 REST API 클라이언트 커넥터를 생성할 수 있습니다.

사전 요구 사항

Fuse Online에서 생성할 커넥터에 대한 OpenAPI 문서가 있습니다.

절차

  1. Fuse Online 탐색 패널에서 사용자 지정 > API 클라이언트 커넥터 를 클릭합니다. 이미 사용 가능한 API 클라이언트 커넥터는 여기에 나열되어 있습니다.
  2. API 커넥터 만들기를 클릭합니다.
  3. API 커넥터 만들기 페이지에서 다음 중 하나를 수행합니다.

    • 점선 상자를 클릭하고 업로드할 OpenAPI 파일을 선택합니다.
    • URL 사용을 선택하고 입력 필드에 OpenAPI 문서의 URL을 붙여넣습니다.
  4. 다음을 클릭합니다. 잘못된 콘텐츠가 있거나 누락된 콘텐츠가 있는 경우 Fuse Online에서 수정해야 하는 사항에 대한 정보를 표시합니다. 다른 OpenAPI 파일을 선택하여 업로드하거나 취소 를 클릭하고 OpenAPI 파일을 수정하고 업데이트된 파일을 업로드합니다.

    스키마가 유효한 경우 Fuse Online에서 커넥터가 제공하는 작업에 대한 요약을 표시합니다. 여기에는 작업 정의에 대한 오류 및 경고가 포함될 수 있습니다.

  5. 요약에 만족하는 경우 다음을 클릭합니다.

    또는 OpenAPI 문서를 수정하려면 검토/편집 을 클릭하여 API Cryostat 편집기를 엽니다. 필요에 따라 스키마를 업데이트합니다. API 편집기 사용에 대한 자세한 내용은 API Creator 를 사용한 API 정의 설계 및 개발을 참조하십시오. 완료되면 변경 사항을 저장하여 새 API 클라이언트 커넥터에 업데이트를 통합합니다. 그런 다음 다음을 클릭하여 API 클라이언트 커넥터를 계속 생성합니다.

    OpenAPI 문서의 URL을 제공하는 경우 Fuse Online에서 업로드할 수 있지만 편집을 위해 열 수는 없습니다. 일반적으로 이는 파일 호스트의 설정으로 인해 발생합니다. 편집을 위해 스키마를 열려면 Fuse Online에서 파일 호스트에 다음이 필요합니다.

    • https URL입니다. (HTTP URL 이 작동하지 않습니다.)
    • 활성화된 CORS.
  6. API의 보안 요구 사항을 나타냅니다. Fuse Online은 OpenAPI 정의를 읽고 API의 보안 요구 사항을 충족하도록 커넥터를 구성하는 데 필요한 정보를 확인합니다. Fuse Online에서는 다음 중 하나를 표시할 수 있습니다.

    1. 보안 없음
    2. HTTP 기본 인증 - API 서비스에서 HTTP 기본 인증을 사용하는 경우 이 확인란을 선택합니다. 나중에 이 커넥터를 사용하여 연결을 생성할 때 Fuse Online에서 사용자 이름과 암호를 입력하라는 메시지를 표시합니다.
    3. OAuth 2.0 - Fuse Online 프롬프트를 입력합니다.

      1. 권한 부여 URL 은 Fuse Online을 API의 클라이언트로 등록하는 위치입니다. 등록은 Fuse Online에서 API에 액세스할 수 있도록 권한을 부여합니다. Fuse Online을 REST API 클라이언트로 등록하여 Fuse Online에 애플리케이션 및 서비스 연결을 참조하십시오. API의 OpenAPI 문서 또는 기타 문서는 이 URL을 지정해야 합니다. 그렇지 않은 경우 이 URL을 받으려면 서비스 공급자에게 문의해야 합니다.
      2. OAuth 인증에는 액세스 토큰 URL 이 필요합니다. 다시 한 번 OpenAPI 문서 또는 API의 다른 문서에서 이 URL을 제공해야 합니다. 그렇지 않은 경우 서비스 공급자에게 문의해야 합니다.
    4. API 키 - API 서비스에 API 키가 필요한 경우 Fuse Online에서 커넥터를 생성하는 데 필요한 정보를 입력하라는 메시지를 표시합니다. 프롬프트는 OpenAPI 정의를 기반으로 합니다. 예를 들어 API 키가 메시지 헤더 또는 쿼리 매개변수에 있는지 여부를 지정해야 할 수 있습니다. OpenAPI 정의에서 API 키 보안과 다른 보안 유형을 지정하는 경우 확인란을 선택하여 이 커넥터를 기반으로 하는 연결에서 API 키 보안을 사용하도록 지정합니다. 나중에 이 커넥터를 사용하여 연결을 생성할 때 Fuse Online에서 API 키 값을 입력하라는 메시지를 표시합니다.
  7. 다음을 클릭합니다. Fuse Online은 OpenAPI 문서에 표시된 대로 커넥터의 이름, 설명, 호스트 및 기본 URL을 표시합니다. 이 커넥터에서 생성하는 연결의 경우,

    • Fuse Online은 호스트 및 기본 URL 값을 연결하여 연결 끝점을 정의합니다. 예를 들어 호스트가 https://example.com 이고 기본 URL이 /api/v1 인 경우 연결 끝점은 https://example.com/api/v1 입니다.
    • Fuse Online은 OpenAPI 문서를 데이터 매핑 단계에 적용합니다. OpenAPI 문서가 두 개 이상의 스키마를 지원하는 경우 Fuse Online에서는 TLS(HTTPS) 스키마를 사용합니다.
  8. 커넥터 세부 정보를 검토하고 선택적으로 커넥터의 아이콘을 업로드합니다. 아이콘을 업로드하지 않으면 Fuse Online에서 하나의 아이콘을 생성합니다. 나중에 아이콘을 업로드할 수 있습니다. Fuse Online에 통합 흐름이 표시되면 해당 커넥터에서 생성된 연결을 나타내는 커넥터의 아이콘이 표시됩니다.
  9. OpenAPI 파일에서 얻은 값을 재정의하려면 변경할 필드 값을 편집합니다.

    중요

    Fuse Online에서 커넥터를 생성한 후에는 변경할 수 없습니다. 변경 사항을 적용하려면 Fuse Online에서 새 커넥터를 만들거나 동일한 스키마를 업로드한 다음 API 편집기에서 편집할 수 있도록 업데이트된 OpenAPI 문서를 업로드해야 합니다. 그런 다음 새 API 클라이언트 커넥터를 생성하는 프로세스를 계속합니다.

  10. 커넥터 세부 정보에 만족하는 경우 저장을 클릭합니다. Fuse Online은 API Client Connectors 목록에 새 커넥터를 표시합니다.

다음 단계

새 API 커넥터 사용에 대한 자세한 내용은 Fuse Online을 애플리케이션 및 서비스에 연결, API 클라이언트에 연결을 참조하십시오.

9.2.2. Cryostat API 클라이언트 커넥터 생성

WSDL 파일을 업로드하여 Fuse Online에서 Cryostat API 클라이언트 커넥터를 생성할 수 있습니다.

인라인 및 외부 URL(WSDL URL) 모두 고유한 네임스페이스가 있는 여러 스키마를 지원합니다.

사전 요구 사항

Fuse Online에서 만들려는 Cryostat 클라이언트 커넥터에 대한 WSDL 파일이 있습니다.

절차

  1. Fuse Online 탐색 패널에서 사용자 지정 > API 클라이언트 커넥터 를 클릭합니다. 이미 사용 가능한 API 클라이언트 커넥터는 여기에 나열되어 있습니다.
  2. API 커넥터 만들기를 클릭합니다.
  3. API 커넥터 만들기 페이지에서 다음 중 하나를 수행합니다.

    • 점선 상자를 클릭하고 업로드할 WSDL (.wsdl) 파일을 선택합니다.

      WSDL 파일에서 참조되는 디스크 기반 외부 스키마는 커넥터로 직접 가져오는( 파일 업로드 폼을 사용하여) 지원되지 않습니다. 업로드된 WSDL 파일은 인라인 스키마를 사용해야 합니다.

    • URL 사용을 선택하고 입력 필드에 WSDL (.wsdl) 파일의 URL을 붙여넣습니다.

      URL 기반 WSDL은 WSDL로 호스팅되는 외부 스키마를 지원합니다. 또한 URL 기반 WSDL만 WSDL의 기본 경로의 상대 URL을 기반으로 하는 외부 스키마를 지원합니다.Also, only URL-based WSDLs support external schemas that are based on the relative URLs from the WSDL's base path. 구문 분석 및 검증을 위해 런타임에 WSDL 커넥터가 WSDL URL을 사용할 수 있어야 합니다. 따라서 WSDL 및 스키마가 영구 URL에서 호스팅되는지 확인합니다.

  4. 다음을 클릭합니다.
  5. 서비스 및 포트 페이지에서 서비스와 포트를 확인합니다.
  6. 다음을 클릭합니다. 잘못된 콘텐츠가 있거나 누락된 콘텐츠가 있는 경우 Fuse Online에서 수정해야 하는 사항에 대한 정보를 표시합니다. 다른 WSDL 파일을 선택하여 업로드하거나 취소 를 클릭하고 WSDL 파일을 수정한 다음 업데이트된 파일을 업로드합니다. 스키마가 유효한 경우 Fuse Online에는 API 정의 요약(이름 및 설명)과 작업 수와 같은 가져온 요소 목록이 표시됩니다.
  7. 다음을 클릭합니다.
  8. WSDL 엔드포인트를 호출할 때 사용할 보안 요구 사항을 나타냅니다. Fuse Online에서는 API 정의를 읽고 API의 보안 요구 사항을 충족하도록 커넥터를 구성하는 데 필요한 정보를 확인합니다. Fuse Online에서는 다음 중 하나를 표시할 수 있습니다.

    • 없음 (보안 없음)
    • HTTP 기본 인증 - API 서비스에서 HTTP 기본 인증을 사용하는 경우 이 확인란을 선택합니다. 나중에 이 커넥터를 사용하여 연결을 생성할 때 Fuse Online에서 사용자 이름과 암호를 입력하라는 메시지를 표시합니다.
    • WS-Security Username Token - Fuse Online에서 다음 정보를 표시합니다.

      1. timestamp - Fuse Online에서 WS-Security 헤더에 타임스탬프를 추가하려면 이 옵션을 선택합니다.
      2. 암호 유형 - Digest,text 또는 None 을 선택합니다.

        텍스트 또는 다이제스트 를 선택하는 경우:

        • 사용자 이름과 암호를 지정합니다.
        • Fuse Online에서 WS-Security Username Token 헤더에 Nonce 요소를 추가하려면 Username Token Nonce 를 선택합니다.
        • Fuse Online에서 "Created" timestamp 요소를 WS-Security Username Token 헤더에 추가하려면 Username Token Created 를 선택합니다.
  9. 다음을 클릭합니다. Fuse Online에는 커넥터의 이름, 설명 및 WSDL 엔드포인트 주소가 표시됩니다.

    1. 선택적으로 커넥터의 아이콘을 업로드합니다. 나중에 아이콘을 업로드할 수도 있습니다.

      참고: 이 릴리스에서는 아이콘을 업로드하지 않으면 Fuse Online에서 사용자를 위해 하나를 생성하지 않습니다.

      Fuse Online에 통합 흐름이 표시되면 해당 커넥터에서 생성된 연결을 나타내는 커넥터의 아이콘이 표시됩니다.

    2. 이름 의 경우 이 연결을 다른 연결과 구별하는 데 도움이 되는 이름 선택을 입력합니다.
    3. 설명 에서는 선택적으로 이 연결에 대해 알 수 있는 정보를 입력합니다.
  10. 커넥터 세부 정보를 검토하고 WSDL 파일에서 얻은 값을 재정의하려면 변경할 필드 값을 편집합니다.

    중요

    Fuse Online에서 커넥터를 생성한 후에는 변경할 수 없습니다. 변경 사항을 적용하려면 Fuse Online에서 새 커넥터를 만들거나 동일한 스키마를 업로드한 다음 API 편집기에서 편집할 수 있도록 업데이트된 OpenAPI 문서를 업로드해야 합니다. 그런 다음 새 API 클라이언트 커넥터를 생성하는 프로세스를 계속합니다.

  11. 커넥터 세부 정보에 만족하는 경우 저장을 클릭합니다. Fuse Online은 API Client Connectors 목록에 새 커넥터를 표시합니다.

다음 단계

새 API 커넥터 사용에 대한 자세한 내용은 Fuse Online을 애플리케이션 및 서비스에 연결, API 클라이언트에 연결을 참조하십시오.

9.2.3. 새 API 클라이언트 커넥터를 생성하여 API 클라이언트 커넥터 업데이트

API 클라이언트 커넥터를 만든 OpenAPI 문서 또는 WSDL 파일이 업데이트되고 API 클라이언트 커넥터가 이러한 업데이트를 사용하려면 새 API 클라이언트 커넥터를 생성해야 합니다. API 클라이언트 커넥터를 직접 업데이트할 수 없습니다. 새 API 클라이언트 커넥터를 생성한 후 이를 사용하여 새 연결을 만든 다음, 오래된 커넥터에서 생성된 연결을 사용하는 각 통합을 편집합니다.

사전 요구 사항

다음 중 하나를 수행할 준비가 되어 있습니다.

  • REST API 클라이언트 커넥터의 경우:

    • 업데이트된 OpenAPI 문서를 업로드합니다.
    • 최신 스키마를 다시 업로드하고 API Splunk에서 업데이트합니다.
  • Cryostat API 클라이언트 커넥터의 경우 업데이트된 WSDL 파일을 업로드합니다.

절차

  1. 업데이트된 OpenAPI 문서 또는 WSDL 파일을 기반으로 새 API 클라이언트 커넥터를 만듭니다. 이전 커넥터와 새 커넥터를 쉽게 구분하기 위해 커넥터 이름 또는 커넥터 설명에 버전 번호를 지정할 수 있습니다.

    REST API 클라이언트 커넥터 개발을 참조하십시오.

  2. 새 커넥터에서 새 연결을 만듭니다. 다시 말하지만 이전 커넥터에서 생성된 연결과 새 커넥터에서 생성된 연결을 쉽게 구분할 수 있어야 합니다. 연결 이름 또는 연결 설명의 버전 번호가 도움이 됩니다.
  3. 이전 연결을 제거하고 새 연결을 추가하여 이전 커넥터에서 생성된 연결을 사용하는 각 통합을 편집합니다.
  4. 업데이트된 각 통합을 게시합니다.
  5. 권장 사항이지만 필수는 아님: 이전 커넥터 및 이전 연결을 삭제합니다.

9.2.4. API 클라이언트 커넥터 삭제

해당 커넥터에서 생성된 연결이 있고 이 연결이 통합에서 사용되는 커넥터는 삭제할 수 없습니다. API 클라이언트 커넥터를 삭제한 후에는 해당 커넥터에서 생성된 연결을 사용할 수 없습니다.

절차

  1. 왼쪽 패널에서 사용자 지정 > API 클라이언트 커넥터 를 클릭합니다.
  2. 삭제할 커넥터 이름 오른쪽에 있는 경우 삭제를 클릭합니다.
  3. 확인 팝업에서 커넥터를 삭제하려는 경우 삭제 를 클릭합니다.
Red Hat logoGithubRedditYoutubeTwitter

자세한 정보

평가판, 구매 및 판매

커뮤니티

Red Hat 문서 정보

Red Hat을 사용하는 고객은 신뢰할 수 있는 콘텐츠가 포함된 제품과 서비스를 통해 혁신하고 목표를 달성할 수 있습니다.

보다 포괄적 수용을 위한 오픈 소스 용어 교체

Red Hat은 코드, 문서, 웹 속성에서 문제가 있는 언어를 교체하기 위해 최선을 다하고 있습니다. 자세한 내용은 다음을 참조하세요.Red Hat 블로그.

Red Hat 소개

Red Hat은 기업이 핵심 데이터 센터에서 네트워크 에지에 이르기까지 플랫폼과 환경 전반에서 더 쉽게 작업할 수 있도록 강화된 솔루션을 제공합니다.

© 2024 Red Hat, Inc.