자습서: 제품 만들기 및 게시

Azure API Management에서 제품에는 하나 이상의 API, 사용 할당량 및 사용 약관이 포함됩니다. 제품이 게시되면 개발자는 제품을 구독하고 제품의 API를 사용할 수 있습니다.

이 자습서에서는 다음을 하는 방법을 알아볼 수 있습니다.

  • 제품 생성 및 게시
  • 제품에 API 추가
  • 제품 API에 액세스

API Management products in portal

필수 조건

제품 생성 및 게시

  1. Azure Portal에 로그인하고 API Management 인스턴스로 이동합니다.

  2. 왼쪽 탐색 창에서 제품>+ 추가를 선택합니다.

    Add product in Azure portal

  3. 제품 추가 창에서, 다음 표에 설명된 값을 입력하여 제품을 만듭니다.

    Add product window

    이름 설명
    Display name 개발자 포털에 표시하려는 이름입니다.
    설명 제품의 용도, 제품에서 액세스할 수 있는 API, 기타 정보 등 제품 정보를 입력합니다.
    State(상태) 제품을 게시하려면 게시됨을 누릅니다. 제품의 API를 호출하려면 먼저 제품을 게시해야 합니다. 기본적으로 새 제품은 게시되지 않으며 관리자 그룹에만 표시됩니다.
    구독 필요 사용자가 제품을 사용하기 위해 구독해야 하고(제품이 보호됨) 제품의 API에 액세스하려면 구독 키를 사용해야 하는지 여부를 선택합니다. 구독이 필요하지 않은 경우(제품이 공개) 제품의 API에 액세스하는 데 구독 키가 필요하지 않습니다. 이 문서 뒷부분의 제품 API에 대한 액세스를 참조하세요.
    승인 필요 관리자가 이 제품에 대한 구독 시도를 검토하고 허용하거나 거부하도록 하려면 선택합니다. 선택하지 않으면 구독 시도가 자동으로 승인됩니다.
    구독 수 제한 필요하다면 여러 동시 구독의 수를 제한합니다.
    약관 구독자가 제품을 사용하기 위해 허용해야 하는 제품의 사용 약관을 포함할 수 있습니다.
    API 하나 이상의 API를 선택합니다. 제품을 만든 후 API를 추가할 수도 있습니다. 자세한 내용은 이 문서의 뒷부분에 나오는 제품에 API 추가를 참조하세요.

    제품이 열려 있는 경우(구독이 필요하지 않음) 다른 열려 있는 제품과 연결되지 않은 API만 추가할 수 있습니다.
  4. 만들기를 선택하여 새 제품을 만듭니다.

주의

구독이 필요하지 않은 제품을 구성할 때는 주의합니다. 이 구성은 지나치게 관대할 수 있으며 제품의 API를 특정 API 보안 위협에 더 취약하게 만들 수 있습니다.

구성 더 추가

저장 후 제품을 계속 구성합니다. API Management 인스턴스의 제품 창에서 제품을 선택합니다. 추가 또는 업데이트:

항목 설명
설정 제품 메타데이터 및 상태 데이터
API 제품과 연결된 API
정책 제품 API에 적용되는 정책
Access Control 개발자 또는 게스트에게 제품 표시 여부
구독 제품 구독자

제품에 여러 API 추가

제품은 하나 이상의 API와 연결됩니다. 여러 API를 포함하고 개발자 포털을 통해 개발자에게 제공할 수 있습니다. 제품 만들기 중에 기존 API를 하나 이상 추가할 수 있습니다. 나중에 제품 설정 페이지에서 또는 API를 만드는 동안 제품에 API를 추가할 수 있습니다.

기존 제품에 API 추가

  1. API Management 인스턴스의 왼쪽 탐색 영역에서 제품을 선택합니다.
  2. 제품을 선택한 다음 API를 선택합니다.
  3. + API 추가를 선택합니다.
  4. 하나 이상의 API를 선택한 다음, 선택을 선택합니다.

Add an API to an existing product

제품 API에 대한 액세스

제품을 게시한 후 개발자는 API에 액세스할 수 있습니다. 제품 구성 방법에 따라 액세스를 위해 제품에 구독해야 할 수도 있습니다.

  • 보호된 제품 - 개발자는 먼저 보호된 제품에 구독해야 제품 API에 액세스할 수 있습니다. 구독하면 해당 제품의 모든 API에 액세스할 수 있는 구독 키를 받습니다. API Management 인스턴스를 만든 경우 사용자는 이미 관리자이므로 기본적으로 모든 제품을 구독한 상태가 됩니다. 자세한 내용은 Azure API Management의 구독을 참조하세요.

    클라이언트가 유효한 제품 구독 키로 API 요청을 하면 API Management가 요청을 처리하고 제품 컨텍스트에서 액세스를 허용합니다. 제품에 대해 구성된 정책 및 액세스 제어 규칙을 적용할 수 있습니다.

    REST API 또는 PowerShell 명령을 통해 사용자 구독을 만들거나 사용자 지정 구독 키가 포함된 제품으로 업데이트할 수 있습니다.

  • 공개 제품 - 개발자는 구독 키 없이 공개 제품의 API에 액세스할 수 있습니다. 그러나 OAuth 2.0, 클라이언트 인증서, 호출자 IP 주소 제한 등 API에 대한 클라이언트 액세스를 보호하기 위해 다른 메커니즘을 구성할 수 있습니다.

    참고 항목

    개발자가 알아보거나 구독할 수 있도록 오픈 제품은 개발자 포털에 나열되지 않습니다. 관리자 그룹에만 표시됩니다. 구독 키 없이 액세스할 수 있는 API를 개발자에게 알리기 위해서는 다른 메커니즘을 사용해야 합니다.

    클라이언트가 구독 키 없이 API 요청을 하는 경우:

    • API Management는 API가 공개 제품과 연결되어 있는지 확인합니다. API는 최대 하나의 공개 제품과 연결할 수 있습니다.

    • 공개 제품이 있으면 해당 열린 제품의 컨텍스트에서 요청을 처리합니다. 공개 제품에 대해 구성된 정책 및 액세스 제어 규칙을 적용할 수 있습니다.

자세한 내용은 API Management에서 구독 키가 있거나 없는 요청을 처리하는 방법을 참조하세요.

다음 단계

이 자습서에서는 다음 작업 방법을 알아보았습니다.

  • 제품 생성 및 게시
  • 제품에 API 추가
  • 제품 API에 액세스

다음 자습서를 진행합니다.