수익 창출 서비스 설치

Private Cloud용 Edge v4.18.05

수익 창출 서비스는 Apigee Edge의 확장 프로그램이므로 독립형으로 실행되지 않습니다. 프로세스입니다 All-In-One (AIO)을 제외한 기존 Apigee Edge 설정 내에서 실행됩니다. 구성할 수 있습니다

수익 창출 요구사항

  • 여러 관리 서버를 사용하는 에지 토폴로지에 수익 창출을 설치하는 경우 노드(예: 13노드 설치)를 사용하려면 에지 관리 서버 노드를 둘 다 설치해야 합니다. 수익 창출 설치에 대해 자세히 알아보세요.
  • Edge 설치에 여러 Postgres 노드가 있는 Edge에서 수익 창출을 설치하려면 다음 안내를 따르세요. Postgres 노드를 마스터/대기 모드에서 구성해야 합니다. 수익 창출을 설치할 수 없습니다. Postgres 마스터 노드가 여러 개 있는 경우 자세한 내용은 다음을 참고하세요. 다음에 대한 마스터-대기 복제 설정 Postgres
  • 올인원 (AIO) 구성에서는 수익 창출을 사용할 수 없습니다.

설치 개요

다음 단계에서는 기존 Apigee Edge에 수익 창출 서비스를 추가하는 방법을 보여줍니다. 설치:

  • apigee-setup 유틸리티를 사용하여 Apigee 관리 서버 노드를 다음과 같이 업데이트합니다. 카탈로그 관리, 한도, 알림 등 수익 창출 서비스 사용 설정 구성, 결제, 보고가 포함됩니다

    13노드 설치와 같이 여러 Management Server 노드가 있는 경우 수익 창출을 설치하기 전에 두 에지 관리 서버 노드를 모두 설치해야 합니다.

  • apigee-setup 사용 이 유틸리티는 이 API의 런타임 구성요소를 사용 설정하도록 Apigee 메시지 프로세서를 수익 창출 서비스(예: 거래 기록 정책 및 한도 시행) 만약 여러 개의 메시지 프로세서가 있다면 모두 '수익 창출'을 설치하세요.
  • Edge 조직에 대해 수익 창출 온보딩 프로세스를 수행합니다.
  • 수익 창출을 지원하도록 Apigee 개발자 서비스 포털 (또는 간단히 포털)을 구성합니다. 자세한 내용은 개발자 포털에서 수익 창출을 구성합니다.

수익 창출을 위한 자동 구성 파일 생성

다음은 수익 창출 설치를 위한 자동 구성 파일의 예입니다. 수정 변경할 수 있습니다. 이 파일을 포함하려면 setup.sh에 -f 옵션을 사용합니다.

# Edge configuration properties
# Specify IP address or DNS name of node.
IP1=192.168.1.1  # Management Server, OpenLDAP, UI, ZooKeeper, Cassandra
IP2=192.168.1.2  # ZooKeeper, Cassandra
IP3=192.168.1.3  # ZooKeeper, Cassandra
IP4=192.168.1.4  # Router, Message Processor
IP5=192.168.1.5  # Router, Message Processor
IP6=192.168.1.6  # Qpid
IP7=192.168.1.7  # Qpid
IP8=192.168.1.8  # Postgres
IP9=192.168.1.9  # Postgres

# Must resolve to IP address or DNS name of host - not to 127.0.0.1 or localhost.
HOSTIP=$(hostname -i)

# Edge sys admin credentials
ADMIN_EMAIL=your@email.com
APIGEE_ADMINPW=yourPassword    # If omitted, you are prompted for it.

# Specify the Management Server port.
APIGEE_PORT_HTTP_MS=8080

#
# Monetization configuration properties.
#
# Postgres credentials from Edge installation.
PG_USER=apigee    # Default from Edge installation
PG_PWD=postgres    # Default from Edge installation

# Specify Postgres server.
MO_PG_HOST="$IP8"    # Only specify one Postgres node.

# Create a Postgres user for Monetization.
# Default username is "postgre".
# If you specify a different user, that user must already exist.
MO_PG_USER=postgre
MO_PG_PASSWD=moUserPWord

# Specify one ZooKeeper host.
# Ensure this is a ZooKeeper leader node in a multi-datacenter environment.
ZK_HOSTS="$IP2"

# Specify Cassandra information.
# Ensure CASS_HOSTS is set to the same value as when you installed Edge.
# Must use IP addresses for CASS_HOSTS, not DNS names.
CASS_HOSTS="$IP1:1,1 $IP2:1,1 $IP3:1,1"

# Default is "Apigee", unless it was changed during Edge install.
CASS_CLUSTERNAME=Apigee

# Cassandra uname/pword required only if you enabled Cassandra authentication.
# CASS_USERNAME=
# CASS_PASSWORD=

# Specify the region.
# Default is dc-1 unless you are in a multi-datacenter environment.
REGION=dc-1

# If your Edge config file did not specify SMTP information, add it.
# Monetization requires an SMTP server.
SMTPHOST=smtp.gmail.com
SMTPPORT=465
SMTPUSER=your@email.com
SMTPPASSWORD=yourEmailPassword
SMTPSSL=y
SMTPMAILFROM="My Company <myco@company.com>"

참고:

  • Edge 구성 파일에 SMTP 정보를 지정하지 않은 경우 추가합니다. 수익 창출을 위해서는 있습니다.
  • 단일 데이터 센터 설치에서 모든 주키퍼 노드는 기본적으로 다음과 같이 구성됩니다. 선도 기업입니다 여러 데이터 센터에 Edge를 설치할 때 일부 주키퍼 노드는 다음과 같습니다. 관찰자로 구성되어야 합니다 위의 ZK_HOSTS 속성이 다중 데이터 센터 설치가 가능합니다
  • Cassandra 인증을 사용하면 Cassandra 사용자 이름과 비밀번호를 전달할 수 있습니다. 다음 속성을 사용합니다. 
    CASS_USERNAME
CASS_PASSWORD

수익 창출 서비스를 모든 관리 서버와 통합

관리 서버 노드에 수익 창출을 통합하려면 다음 절차를 따르세요.

  1. 여러 관리 서버를 사용하는 에지 토폴로지에 수익 창출을 설치하는 경우 노드(예: 13노드 설치)를 사용하려면 관리 서버를 노드를 사용하여 수익을 창출할 수 있습니다.
  2. 관리 서버 노드에서 설정 스크립트를 실행합니다.
    /opt/apigee/apigee-setup/bin/setup.sh -p mo -f configFile

    -p mo 옵션은 수익 창출을 통합하도록 지정합니다.

    구성 파일은 'Apigee'에서 액세스하거나 읽을 수 있어야 합니다. 있습니다.

  3. 여러 관리 서버 노드에 수익 창출을 설치하는 경우 다음에서 2단계를 반복합니다. 두 번째 관리 서버 노드입니다.

구성이 완료되면 수익 창출 서비스를 위한 RDBMS 스키마가 사용할 수 있습니다 수익 창출 서비스 및 관련 통합이 완료되었습니다. 구성요소를 살펴보겠습니다

수익 창출 서비스를 모든 메시지 프로세서와 통합

모든 메시지 프로세서에 수익 창출을 통합하려면 다음 절차를 따르세요. 노드라는 두 가지 리소스가 있습니다

  1. 첫 번째 메시지 프로세서 노드의 명령 프롬프트에서 설정 스크립트를 실행합니다. 
    /opt/apigee/apigee-setup/bin/setup.sh -p mo -f configFile

    -p mo 옵션은 수익 창출을 통합하도록 지정합니다.

    구성 파일은 'Apigee'에서 액세스하거나 읽을 수 있어야 합니다. 있습니다.

  2. 모든 메시지 프로세서 노드에서 이 절차를 반복합니다.

구성이 완료되면 메시지 프로세서가 수익 창출 서비스로 업데이트됩니다. 이 수익 창출 서비스 및 관련 구성요소의 통합을 메시지에 프로세서.

수익 창출 온보딩

새 조직을 만들고 수익 창출을 사용 설정하려면 다음 단계를 따르세요.

  1. 새 조직을 만드는 것처럼 조직을 만듭니다. 자세한 내용은 조직 온보딩
  2. 다음에 설명된 대로 수익 창출 프로비저닝 API 사용 사용 설정 수익 창출에 대해 알아봅니다. 이를 위해서는 시스템 관리자가 있어야 합니다. 액세스할 수 있습니다

다음에 Edge UI에 로그인하면 최상위 메뉴에 조직:

수익 창출을 지원하도록 포털을 구성하려면 수익 창출 구성 개발자 포털을 방문하세요.

수익 창출 설치에 관리 서버 노드 추가

기존 Edge 설치에 관리 서버를 추가하는 경우 수익 창출 서비스를 새 관리 서버로 이전하고 모든 관리 서버를 구성하여 통신할 수 있습니다

관리 서버를 추가하려면 다음 단계를 따르세요.

  1. 새 관리 서버를 설치합니다.
  2. 새로운 관리 서버에 수익 창출을 설치합니다.
  3. 원래 관리 서버에서 다음을 호출합니다. 
    /opt/apigee/apigee-service/bin/apigee-service edge-mint-management-server mint-configure-mgmt-cluster
  4. 원래 관리 서버를 다시 시작합니다. 
    /opt/apigee/apigee-service/bin/apigee-service edge-management-server restart
  5. 새 관리 서버에서 다음을 호출합니다. 
    /opt/apigee/apigee-service/bin/apigee-service edge-mint-management-server mint-configure-mgmt-cluster
  6. 새 관리 서버를 다시 시작합니다. 
    /opt/apigee/apigee-service/bin/apigee-service edge-management-server restart

추가 구성

결제 문서를 PDF 파일로 제공

수익 창출에서는 최종 사용자에게 결제 문서를 HTML 형식으로 표시합니다. 결제 정보 제공 문서를 PDF 파일로 제공하면 수익 창출을 PDF를 제공하는 결제 시스템과 통합할 수 있습니다. 또는 라이선스를 부여하는 데 사용될 수 있습니다.

조직 설정 구성

조직 속성을 추가/업데이트하려면 다음과 같이 PUT 요청을 사용하면 됩니다. 예시:

curl -u SYS_ADMIN_EMAIL:SYS_ADMIN_PASSWORD \
  -v http://ms_IP:8080/v1/organizations/orgId -d 'org object with attributes' -X PUT

수익 창출은 조직의 설정으로 응답합니다. 예를 들면 다음과 같습니다.

{
  ...
  "displayName": "Orgnization name",
  "name": "org4",
  "properties": {
    "property": [
      ...
      {
        "name": "MINT_CURRENCY",
        "value": "USD"
      },
      {
        "name": "MINT_COUNTRY",
        "value": "US"
      },
      {
        "name": "MINT_TIMEZONE",
        "value": "GMT"
      }
    ]
  }
}

다음 표에는 GCP Console을 구성하는 데 사용할 수 있는 조직 수준 속성이 민간 조직입니다.

속성 설명
MINT_TAX_MODEL

허용되는 값은 'DISCLOSED', 'UNDISCLOSED', 'HYBRID'입니다. (기본값은 null임)
MINT_CURRENCY

ISO 통화 코드 (기본값은 null)
MINT_TAX_NEXUS

세금 연관성 (기본값은 null)
MINT_DEFAULT_PROD_TAX_CATEGORY

기본 제품 세금 카테고리 (기본값은 null임)
MINT_IS_GROUP_ORG

IS 그룹 조직 (기본값은 'false')
MINT_HAS_BROKER

손상됨 (기본값은 false)
MINT_TIMEZONE

시간대 (기본값은 null)
MINT_TAX_ENGINE_EXTERNAL_ID

세금 엔진 ID (기본값은 null)
MINT_COUNTRY

조직의 국가 (기본값은 null)
MINT_REG_NO

조직의 등록 번호, 영국에서 세금 ID와 다른 번호를 제공함 (기본값은 null임)
MINT_BILLING_CYCLE_TYPE

'PRORATED', 'CALENDAR_MONTH' (기본값은 'CALENDAR_MONTH')
MINT_SUPPORTED_BILLING_TYPE

&quot;PREPAID&quot;/&quot;POSTPAID&quot;/&quot;BOTH&quot; (기본값은 '선불')
MINT_IS_SEPARATE_INV_FOR_FEES

별도의 수수료 인보이스를 생성해야 하는지 여부를 나타냅니다 (기본값은 'false').
MINT_ISSUE_NETTING_STMT

네팅 명세서 발행 여부를 나타냅니다. 기본값은 'false'입니다.
MINT_NETTING_STMT_PER_CURRENCY

수익화 명세서를 통화별로 생성할지 여부를 나타냅니다 (기본값은 'false')
MINT_HAS_SELF_BILLING

조직에 자체 결제가 있는지 여부를 나타냅니다 (기본값은 'false').
MINT_SELF_BILLING_FOR_ALL_DEV

조직에 모든 개발자에 대한 자체 결제가 있는지 여부를 나타냅니다. 기본값은 'false')
MINT_HAS_SEPARATE_INV_FOR_PROD

조직에 제품별로 별도의 인보이스가 있는지 여부를 나타냅니다. 기본값은 'false')
MINT_HAS_BILLING_ADJUSTMENT

조직에서 결제 조정을 지원하는지 여부를 나타냅니다. 기본값은 'false')
features.isMonetizationEnabled

관리 UI에서 수익 창출 관련 메뉴를 표시하는 데 사용됩니다 (기본값은 'false')
ui.config.isOperator

관리 UI가 공급자를 운영자와 조직으로 표시하기 위해 사용합니다 (기본값은 "true")

관리 UI를 사용하여 비즈니스 조직 설정을 구성하는 방법은 다음을 참고하세요. 수익 창출 사용 시작하기

수익 창출 한도

수익 창출 한도를 적용하려면 수익 창출 한도 확인 정책을 API 프록시에 연결하세요. 구체적으로는 다음과 같은 조건에서 정책이 트리거됩니다.

  • 수익 창출 API에 액세스하는 개발자가 등록되지 않았거나 요율을 구독하지 않았습니다. 있습니다.
  • 개발자가 정기 결제한 요금제의 거래량을 초과했습니다.
  • 개발자 선불 계정 잔액 또는 후불 크레딧 한도에 도달했습니다.

수익 창출 한도 확인 정책은 다음과 같은 상황에서 오류를 발생시키고 API 호출을 차단합니다. 선택할 수 있습니다 이 정책은 오류 발생 정책을 확장하며 메시지를 맞춤설정할 수 있습니다. 반환합니다. 적용 가능한 조건은 비즈니스 변수에서 파생됩니다.

자세한 내용은 시행 API 프록시의 수익 창출 한도