Language and Page Formatting Options

용어

Red Hat 3scale API Management 2.6

Red Hat 3scale API Management Platform에서 사용되는 용어에 대해 알아보십시오.

초록

이 가이드에서는 Red Hat 3scale API Management 2.6에서 사용되는 용어에 대해 설명합니다.

1장. 3scale 용어

이 섹션은 3scale 플랫폼에서 사용되는 일반적인 용어집의 용어집 역할을 합니다.

1.1. 액세스 토큰

액세스 토큰은 계정 관리 API, analytics API 및 billing API를 호출할 때 인증하는 데 사용되는 키입니다.

1.2. ActiveDocs

ActiveDocs는 REST API를 문서화하기 위한 3scale 사양입니다. ActiveDocs는 널리 사용되는 Swagger 프레임워크를 기반으로 합니다. ActiveDocs를 사용하면 API에서 대화형 문서를 제공하여 개발자가 웹 서비스를 더 쉽게 이해하고 설치 없이 테스트할 수도 있습니다.

1.3. 관리자 포털

관리 포털에서 API 공급자는 API를 3scale과의 통합을 구성하고, 애플리케이션 계획을 관리하고, 내부 구성원 및 외부 고객에 대한 액세스 권한을 부여하고, 애플리케이션 키당 트래픽을 제한하며, 개발자 포털을 사용자 지정하여 API에 대한 액세스를 관리하고 보호할 수 있는 API 공급자의 중심 콘솔입니다. 관리 포털에는 시작점으로 대시보드가 포함되어 있습니다.

1.4. API

API는 액세스할 수 있는 하나 이상의 메서드 로 구성된 논리 번들입니다. 지정된 API 공급자는 이러한 API를 하나 이상 노출할 수 있습니다. API라는 용어는 서비스 단어와 서로 바꿔 사용합니다.

3scale에는 설명서 → 3scale API Docs 섹션에 있는 관리 포털에서 사용할 수 있는 3scale ActiveDocs에 있는 자체 API 도 있습니다.

1.5. APIcast 게이트웨이

APIcast는 내부 및 외부 API 서비스를 3scale API Management Platform과 통합하는 데 사용되는 NGINX 기반 API 게이트웨이입니다. API Gateway는 API 요청을 처리하는 인터페이스입니다. 구성에 따라 액세스 제어, 속도 제한, 보안 필터링, 로깅, 라우팅, 캐싱…​

APIcast 및 해당 배포 옵션(호스팅, 자체 관리 및 다양한 구성 옵션)에 대한 자세한 내용은 APIcast 개요 를 확인하십시오.

1.6. API 인증 정보

Credentials(자격 증명)는 애플리케이션이 API에 액세스할 수 있도록 허용하는 애플리케이션과 관련된 일련의 키, 시크릿 또는 식별자입니다. 인증 정보에서 사용하는 형식은 API에 사용되는 인증 패턴에 따라 다릅니다.

1.7. API 소비자

API 공급자 가 제공하는 API에 액세스하는 개인, 그룹 또는 회사입니다. 용어는 API를 사용하도록 조직 및 조직에서 작성한 소프트웨어 애플리케이션을 모두 참조할 수 있습니다. 지정된 조직에는 API에 액세스하는 하나 이상의 애플리케이션이 있을 수 있습니다.

1.8. API 키

API 키는 특정 API 에서 호출할 수 있는 애플리케이션의 자격 증명 유형입니다. API 키는 특정 유형의 인증 패턴입니다.

  • 애플리케이션 API 키: 사용자 또는 API를 통해 3scale에서 새 애플리케이션을 생성할 때 생성됩니다. API에 대한 액세스를 제공합니다. 액세스 유형은 애플리케이션 계획에 따라 결정됩니다.
  • 공급자 API 키: 3scale에서 새 공급자 계정을 만들 때 생성됩니다. 공급자 계정과 연결된 3scale API에 대한 전체 액세스 권한을 부여합니다.
참고

서비스 토큰을 사용하여 서비스 관리 API에 대해 인증하고 액세스 토큰을 사용하여 계정 관리 API, analytics API 및 billing API에 대해 인증하는 것이 좋습니다. 사용자 정의/제한 액세스 범위를 사용하면 이 공급자 API 키를 사용하는 것보다 본질적으로 더 안전합니다.

1.9. API 공급자

문서 및 가이드에서 "API 공급자" (3scale 고객)는 하나 이상의 API를 소유하고 3scale API Management Platform을 사용하여 이를 관리하는 개인, 그룹 또는 회사입니다. API 공급자는 조직 내에서 다른 팀에서 또는 외부적으로 또는 타사 개발자, 파트너 또는 일반에게 외부적으로 액세스할 수 있도록 API 를 제공할 수 있습니다.

1.10. 애플리케이션

애플리케이션은 API 소비자가 API에 액세스하기 위해 개발한 소프트웨어 코드입니다. 애플리케이션은 일반적으로 3scale 시스템 내에 API에 대한 고유한 api 자격 증명 세트, 애플리케이션 생성 시 캡처된 API로 전송된 호출의 트래픽 내역 및 메타 데이터 세트입니다. 애플리케이션은 개발자 계정에 연결됩니다.

1.11. 인증

인증은 액세스를 요청하는 사용자 또는 서버의 ID를 확인하는 프로세스입니다. 이 프로세스는 액세스할 수 있는 리소스를 결정하는 권한 부여 프로세스보다 우선합니다.

1.12. 인증 패턴

API ConsumerAPI 의 메서드에 액세스하는 데 필요한 자격 증명을 표현하기 위해 지정된 API에 사용되는 기술 체계입니다. 3scale 내의 각 API에는 하나의 인증 패턴만 선택할 수 있습니다.

1.13. 기본 URL

호스트 URL(예: https://my-api.com)

  • 공용 기본 URL: API 클라이언트가 호출하는 끝점의 루트입니다.
  • 개인 기본 URL: API 백엔드 서비스의 내부 호스트입니다.

1.14. 코드 플러그인

플러그인은 다른 서버를 실행할 필요 없이 API 액세스 제어 및 API 트래픽 보고를 활성화하는 3scale API용 래퍼를 제공합니다. 플러그인은 API를 지원하는 코드 내부에 있습니다. 플러그인은 액세스 제어 및 트래픽 보고를 위해 3scale API를 호출합니다.

1.15. 배포 옵션

"통합 옵션"과 동일합니다. 3scale에서는 일반적으로 3scale API Management Platform이 아닌 APIcast 게이트웨이 배포 방법에 대해 설명할 때 '배포 옵션'을 참조합니다.

1.16. 개발자 계정

개발자 계정은 특정 API에 가입한 계정입니다. 개발자 계정은 애플리케이션의 부모입니다. 새 개발자가 API를 구독하면 서브스크립션된 API를 호출할 수 있는 애플리케이션이 자동으로 생성됩니다.

1.17. 개발자 포털

개발자 포털은 개발자가 API를 구독할 수 있는 사이트입니다. 개발자 포털에서 개발자는 서브스크립션을 관리하고, API 키에 액세스할 수 있고, 애플리케이션을 생성하고, 대화형 API 문서(ActiveDocs)에 액세스하며, API 사용을 확인할 수 있습니다. 박스 기능을 갖춘 3scale CMS를 사용하면 새로운 고객을 위해 필요한 모든 것을 갖춘 개발자 포털을 빠르게 만들 수 있습니다.

1.18. 끝점(API 끝점)

끝점은 애플리케이션에서 API 에서 수행할 수 있는 특정 호출 또는 트랜잭션입니다. 일반적으로 메서드는 개체 목록을 가져오거나 새 개체 생성과 같은 수행할 수 있는 특정 작업에 해당합니다. API에는 일반적으로 여러 끝점이 있습니다. 용어는 "method" 용어와 동일합니다.

1.19. 최종 사용자

최종 사용자는 하나 또는 여러 API를 호출하는 애플리케이션의 사용자입니다.

1.20. 필드 정의

관리 포털의 필드 정의 섹션에서 개발자 계정 및 애플리케이션에서 내부 admins/members에서 데이터를 수집하기 위한 새 필드를 추가하고/또는 생성할 수 있습니다. 새 계정을 만들 때 표시되는 필드입니다. 예를 들어 개발자 포털의 개발자 등록 양식에 추가 필드(예: 'address')를 추가할 수 있습니다. 이러한 필드는 선택 사항 또는 필수 필드로 만들 수 있습니다.

1.21. 통합 오류

잘못된 인증 정보 또는 토큰 으로 호출을 수행하거나 잘못된 Ids를 사용하는 호출의 경우 3scale에서 발생하는 통합 오류 또는 API를 호출하는 애플리케이션에서 발생하는 오류일 수 있습니다. 이러한 오류는 API를 호출하는 API와의 API 통합과 구성 오류일 수 있습니다.

1.22. 통합 옵션

배포 옵션 라고도 하는 통합 옵션은 API를 3scale Management Platform(NGINX, plugins)과 통합하는 데 사용할 수 있는 옵션입니다.

1.23. 매핑 규칙

매핑 규칙은 특정 끝점 의 수신 호출을 3scale로 생성된 해당 메서드 및 지표에 매핑합니다.

사용량 추적, 끝점 액세스 및 제한은 이러한 매핑 규칙으로 구성된 메서드 및 지표[metrics]를 기반으로 합니다.

매핑 규칙에 대한 설명서를 참조하십시오.

1.24. 방법(API 메서드)

방법을 사용하면 3scale에서 API 사용을 추적할 수 있습니다. API의 API 끝점 에서 사용 가능한 각 HTTP 메서드마다 메서드를 추가할 수 있습니다. 메서드는 적중 기반입니다. 기본적으로 3scale에서 메서드 호출은 내장된 Hits-metric을 트리거합니다. 다른 유형의 이벤트를 추적하려면 다양한 단위로 보고하는 메트릭을 추가할 수 있습니다. 개별 방법에 대한 사용 제한 및 가격 규칙은 각 애플리케이션 계획 내에서 정의됩니다.

API 정의 문서 (Methods and Metrics) 문서를 참조하십시오.

1.25. 메트릭

메트릭을 사용하면 통합 페이지의 매핑 규칙 섹션에서 하나 이상의 URL 패턴에 매핑하여 API에 대한 특정 호출을 추적할 수 있습니다. 메트릭은 누적되며 개별적이지 않습니다. 3scale의 최상위 수준 지표는 Hits입니다. 필요한 경우 다른 최상위 메트릭을 추가할 수 있습니다.

API 정의 문서 (Methods and Metrics) 문서를 참조하십시오.

1.26. 수익화

"Monetization" 또는 "API 수익화"라는 용어는 API 액세스 및/또는 사용량에 따라 고객에게 청구한다는 것을 나타냅니다. API Monetization은 계획을 통해 수행할 수 있습니다.

1.27. 계획

계획은 특정 API엔드포인트에 대한 액세스 권한을 부여하고 트래픽을 제한하고 API 사용량을 조정하는 데 사용됩니다. 3scale에는 자체적으로 또는 함께 사용할 수 있는 네 가지 다른 유형의 계획이 있습니다.

  • 애플리케이션 계획: 3scale에서 가장 일반적인 계획 유형입니다. 이를 통해 속도 제한가격 규칙을 지정하여 API에 대한 액세스 권한을 구성할 수 있습니다. 모든 애플리케이션은 계획과 연결되어야 합니다. 애플리케이션 계획을 하나의 애플리케이션에 맞게 사용자 정의할 수 있습니다.
  • 계정 계획: 계정 수준에서 가격 및 기능을 설정하므로 특정 API 서비스에 국한되지 않습니다. 계정 계획은 하나의 계정에 맞게 사용자 정의할 수 있습니다.
  • 서비스 계획: 서비스 수준에서 가격 및 기능을 설정하므로 특정 애플리케이션에 국한되지 않습니다.
  • 최종 사용자 계획: API의 최종 사용자에 대한 사용 제한가격 규칙을 설정합니다. 따라서 애플리케이션 계획에 지정된 지정된 히트 수를 조정할 수 있으므로 단일 사용자가 모든 할당량을 자체적으로 사용할 수 없습니다.

1.28. 잠재적인 업그레이드

잠재적인 업그레이드는 트래픽 제한 경고를 트리거한 개발자 계정입니다. 이러한 개발자 계정은 트래픽 볼륨 측면에서 요구 사항을 충족하는 계획으로 잠재적으로 업그레이드할 수 있습니다.

1.29. 가격 규칙

가격 규칙은 시스템의 특정 트랜잭션 비용을 결정하는 논리 표현식 세트입니다. API 사용을 청구하기 위해 계획 내에서 가격 규칙을 작성하여 청구 및 액세스 수준을 결정합니다. Provision Paid Plans 에서 자세히 알아볼 수 있습니다.

1.30. 속도 제한 또는 사용 제한

속도 제한은 계획과 연관되며, 논리 표현식으로, 특정 메서드, 끝점 또는 메트릭의 API Consumers에 의한 사용량에 대한 임계값을 분류합니다.

이러한 제한은 애플리케이션 계획에서 구성되며 여기에서 자세한 내용을 확인할 수 있습니다.

1.31. 서비스

3scale에서 API 서비스를 참조하는 데 'API' 및 'Service'라는 용어를 모두 사용합니다. API 서비스는 액세스할 수 있는 하나 이상의 메서드(또는 엔드포인트)의 논리 번들입니다. 지정된 API 공급자는 이러한 API 서비스를 하나 이상 노출할 수 있습니다.

3scale에는 문서 → 3scale API Docs 섹션의 관리 포털에서 사용할 수 있는 3scale ActiveDocs의 자체 API 도 있습니다.

1.32. 서비스 토큰

서비스 토큰은 3scale Service Management API를 호출할 때 인증하는 데 사용되는 키입니다.

1.33. 서브스크립션

계정과 서비스 간의 계약(plan)입니다.

1.34. Swagger

ActiveDocs 를 참조하십시오.

1.35. Webhook

Webhook는 이벤트 다음에 트리거되는 프로세스이며 Webhook는 즉각적인 알림 메커니즘으로 작동합니다.

Webhook 에 대한 설명서를 참조하십시오.