조직 프로필 관리

현재 Apigee Edge 문서가 표시되고 있습니다.
Apigee X 문서로 이동
정보

다음 섹션에서는 조직 프로필을 소개하고 UIAPI를 사용하여 이를 관리하는 방법을 설명합니다.

조직 프로필 정보

Apigee Edge 구성팀에서 수익 창출 초기 설정 과정 중 조직 프로필을 설정합니다.

필요에 따라 조직 프로필을 수정하여 조직에 대한 정보를 추가하거나 업데이트해야 합니다. 예를 들어 결제 유형, 통화 설정 또는 세금 모델을 업데이트해야 할 수 있습니다.

다음을 포함한 조직의 기본 정보를 구성합니다.

  • 조직 이름, 주소, 운영 국가
  • 결제 유형 이해에 설명된 결제 유형 (선불, 후불 또는 둘 다)
  • 결제 주기 (비례 배분 또는 역월)
  • 기본 통화
  • 조직에서 사용하는 세금 모델

다음 섹션에 설명된 대로 UIAPI를 사용하여 조직 프로필을 관리할 수 있습니다.

조직 프로필 페이지 살펴보기

아래에 설명된 대로 조직 프로필 페이지에 액세스합니다.

에지

Edge UI를 사용하여 조직 프로필 페이지에 액세스하려면 다음 안내를 따르세요.

  1. apigee.com/edge에 로그인합니다.
  2. 왼쪽 탐색 메뉴에서 게시 > 수익 창출 > 조직 프로필을 선택합니다.

조직 프로필 페이지가 표시됩니다.

그림에 강조 표시된 것처럼 조직 프로필 페이지를 통해 다음을 할 수 있습니다.

  • 현재 조직 프로필 설정 보기
  • 다음을 포함하여 조직 프로필 설정을 수정합니다.

Classic Edge (Private Cloud)

기본 Edge UI를 사용하여 조직 프로필 페이지에 액세스하려면 다음 안내를 따르세요.

  1. http://ms-ip:9000에 로그인합니다. 여기서 ms-ip는 관리 서버 노드의 IP 주소 또는 DNS 이름입니다.
  2. 상단 탐색 메뉴에서 관리자 > 조직 프로필을 선택합니다.

조직 프로필 페이지가 표시됩니다.

조직 프로필 페이지에서 다음을 수행할 수 있습니다.

  • 현재 조직 프로필 설정 보기
  • 다음을 포함하여 조직 프로필 설정을 수정합니다.

UI를 사용하여 조직 프로필 수정

UI를 사용하여 조직 프로필을 수정하려면 다음 안내를 따르세요.

  1. 조직 프로필 페이지에 액세스합니다.
  2. 수정을 클릭합니다.
  3. 이름 및 정보에서 조직 이름과 운영 국가를 수정합니다.
  4. 세금 및 통화에서 다음 필드를 수정합니다.
    필드 설명
    세금 모델

    참고: 수익 공유 요금제를 설정하고 결제 문서를 생성하려는 경우에만 적용됩니다.

    필요한 결제 문서 유형을 식별하는 수익 공유 요금제의 세금 모델입니다.

    유효한 값으로 다음이 포함되어 있습니다.

    • 공개: API 제공업체가 개발자의 공개된 에이전트 역할을 합니다. 최종 사용자로부터 수집한 총 수익 (판매세 포함)이 개발자에게 전달됩니다. API 제공업체의 수수료는 개발자로부터 수수료 인보이스 형태로 징수됩니다. API 제공업체는 최종 사용자로부터 징수된 판매세를 처리하지 않으며, 판매세를 신고하는 것은 개발자의 책임입니다.
    • 비공개: API 제공업체가 개발자의 비공개 대리인 역할을 하며 최종 사용자로부터 징수된 세금을 공제하여 현지 세무 당국에 납부합니다. 개발자는 판매세와 API 제공업체의 수수료를 공제하여 개발자가 부담한 순수익 공유 금액을 API 제공업체에 인보이스를 발행합니다.
    • 하이브리드: API 제공업체가 개발자의 공개된 에이전트 역할을 합니다. 하지만 API 제공업체는 개발자를 대신하여 구독자로부터 부과된 판매세를 현지 세무 당국에 납부합니다. API 제공업체가 잔여 수익을 개발자에게 전달한 후 수수료 인보이스를 발행합니다.
    통화

    조직에서 지원하는 통화입니다. 수익 공유, 요율표, 수수료 전용 요금제의 경우 요금제에 기본 통화가 사용됩니다. 요율표나 수수료 전용 요금제를 만드는 경우 지원되는 통화 목록에서 선택하여 사용할 통화를 변경할 수 있습니다. 원하는 경우 앱 개발자가 각 통화의 선불 계정 잔액에 추가할 수 있는 최소 충전 금액을 설정할 수 있습니다.

    통화를 추가하는 방법은 다음과 같습니다.

    1. 통화 추가를 클릭합니다.
    2. 통화 입력란의 드롭다운 메뉴에서 통화를 선택합니다.
    3. 원하는 경우 앱 개발자가 선불 계정 잔액에 추가할 수 있는 최소 금액을 Minimum 잔액 충전 입력란에 지정된 통화로 설정합니다.
    4. Add를 클릭합니다.
    5. 원하는 경우 관련 라디오 버튼을 클릭하여 기본 통화로 설정합니다.
    6. 통화를 추가하려면 이 단계를 반복합니다.

    통화를 삭제하려면 삭제하려는 통화 위에 커서를 놓고 를 클릭합니다.

  5. UI를 사용하여 이용약관 관리에 설명된 대로 이용약관을 관리합니다.
  6. 저장을 클릭합니다.

API를 사용하여 조직 프로필 관리

다음 섹션에 설명된 대로 API를 사용하여 조직 프로필을 관리합니다.

API를 사용하여 조직 프로필 보기

/mint/organizations/{org_name}에 GET 요청을 전송하여 조직 프로필을 확인하세요. 예를 들면 다음과 같습니다.

curl -X GET "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}" \
  -H "Accept: application/json" \
  -u email:password

다음은 응답의 예시입니다. 표시된 옵션에 대한 자세한 내용은 API의 조직 프로필 구성 속성을 참조하세요.

{
    "address" : [ {
      "address1" : "Test address”,
      "city" : "Test City",
      "country" : "US",
      "id" : "test-address",
      "isPrimary" : true,
      "state" : "CA",
      "zip" : "54321"
    } ],
    "approveTrusted" : false,
    "approveUntrusted" : false,
    "billingCycle" : "CALENDAR_MONTH",
    "country" : "US",
    "currency" : "USD",
    "description" : "Test organization",
    "hasBillingAdjustment" : true,
    "hasBroker" : false,
    "hasSelfBilling" : false,
    "hasSeparateInvoiceForProduct" : false,
    "id" : "{org_name}"
    "issueNettingStmt" : false,
    "logoUrl" : " https://dl.dropboxusercontent.com/u/48279818/LOGOS/testorg.jpeg",
    "name" : "myorg",
    "nettingStmtPerCurrency" : false,
    "regNo" : "RegNo-1234-myorg",
    "selfBillingAsExchOrg" : false,
    "selfBillingForAllDev" : false,
    "separateInvoiceForFees" : true,
    "status" : "ACTIVE",
    "supportedBillingType" : "PREPAID",
    "taxModel" : "UNDISCLOSED",
    "taxRegNo" : "TaxRegNo-1234-myorg",
    "timezone" : "UTC"
}

API를 사용하여 조직 프로필 수정

/mint/organizations/{org_name}에 PUT 요청을 실행하여 조직 프로필을 수정합니다. 조직 프로필을 수정할 때 수정 중인 속성뿐만 아니라 모든 조직 프로필 속성을 지정해야 합니다.

조직의 기본 통화를 수정하려면 currency 값을 기본 통화로 설정하려는 지원되는 통화의 ISO 4217 통화 코드로 설정하세요.

예를 들어 다음 API 호출은 currency를 USD로 업데이트하고 세금 모델 설정을 HYBRID로 업데이트합니다 (예시에서는 업데이트된 필드가 강조 표시됨). 표시된 옵션에 대한 자세한 내용은 API의 조직 프로필 구성 속성을 참조하세요.

curl -X PUT "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}" \
  -H "Content-Type: application/json" \
  -d '{
  "address" : [ { 
    "address1" : "Test address”,
    "city" : "Test City",
    "country" : "US",
    "id" : "corp-address",
    "isPrimary" : true,
    "state" : "CA",
    "zip" : "54321"
  } ], 
  "approveTrusted" : false, 
  "approveUntrusted" : false, 
  "billingCycle" : "CALENDAR_MONTH", 
  "country" : "US", 
  "currency" : "USD", 
  "description" : "Test organization", 
  "hasBillingAdjustment" : true, 
  "hasBroker" : false, 
  "hasSelfBilling" : false, 
  "hasSeparateInvoiceForProduct" : false,
  "id" : "myorg", 
  "issueNettingStmt" : false, 
  "logoUrl" : "https://dl.dropboxusercontent.com/u/48279818/LOGOS/testorg.jpeg",
  "name" : "{org_name}", 
  "nettingStmtPerCurrency" : false, 
  "regNo" : "RegNo-1234-myorg", 
  "selfBillingAsExchOrg" : false, 
  "selfBillingForAllDev" : false, 
  "separateInvoiceForFees" : false, 
  "status" : "ACTIVE", 
  "supportedBillingType" : "POSTPAID",
  "taxModel" : "HYBRID", 
  "taxRegNo" : "TaxRegNo-1234-myorg", 
  "timezone" : "UTC" 
}' \

-u email:password

API를 사용한 선불 및 후불 결제 유형 구성

개발자 계정은 선불, 후불 또는 둘 다와 같은 결제 유형을 사용하도록 구성할 수 있습니다.

선불 계정에서는 개발자가 API 사용에 대한 요금을 미리 지불합니다. 자금은 통합 결제 서비스 제공업체를 통해 관리되는 개발자의 선불 잔액에서 차감됩니다. 개발자는 API를 구매하기에 충분한 선불 잔액을 유지해야 합니다.

후불 계정을 사용하는 경우 개발자에게 매월 말에 인보이스를 통해 요금이 청구됩니다. 개발자는 인보이스에 포함된 요금제에 규정된 결제 약관에 따라 API 제품 사용에 대한 비용을 지불합니다.

조직의 선불 및 후불 결제 유형을 구성하려면 supportedBillingType 속성을 PREPAID, POSTPAID, BOTH 값 중 하나로 설정하여 유효한 결제 유형을 나타냅니다. 값을 BOTH로 설정하는 경우 앱 개발자 또는 회사를 추가할 때 기본값은 PREPAID입니다. 이 경우 회사 및 앱 개발자 관리에 설명된 대로 API를 사용하여 회사 또는 앱 개발자의 결제 유형을 명시적으로 설정할 수 있습니다.

예를 들면 다음과 같습니다.

curl -X PUT "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}" \
  -H "Content-Type: application/json" \
  -d '{
  "address" : [ {
    "address1" : "Test address",
    "city" : "Test City",
    "country" : "US",
    "id" : "corp-address",
    "isPrimary" : true,
    "state" : "CA",
    "zip" : "54321"
  } ],
  "approveTrusted" : false,
  "approveUntrusted" : false,
  "billingCycle" : "CALENDAR_MONTH",
  "country" : "US",
  "currency" : "USD",
  "description" : "Test organization",
  "hasBillingAdjustment" : true,
  "hasBroker" : false,
  "hasSelfBilling" : false,
  "hasSeparateInvoiceForProduct" : false,
  "id" : "myorg",
  "issueNettingStmt" : false,
  "logoUrl" : "https://dl.dropboxusercontent.com/u/48279818/LOGOS/testorg.jpeg",
  "name" : "{org_name}",
  "nettingStmtPerCurrency" : false,
  "regNo" : "RegNo-1234-myorg",
  "selfBillingAsExchOrg" : false,
  "selfBillingForAllDev" : false,
  "separateInvoiceForFees" : false,
  "status" : "ACTIVE",
  "supportedBillingType" : "POSTPAID",
  "taxModel" : "HYBRID",
  "taxRegNo" : "TaxRegNo-1234-myorg",
  "timezone" : "UTC"
  }' \
  -u email:password

API를 사용하여 결제 주기 구성

조직의 결제 주기를 구성하려면 billingCycle 속성을 다음 값 중 하나로 설정합니다.

  • PRORATED: 한 달 동안 API 제품이 사용된 일수를 기준으로 요금이 청구됩니다.
  • CALENDAR_MONTH: 매월 청구됩니다.

예를 들면 다음과 같습니다.

curl -X PUT "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}" \
  -H "Content-Type: application/json" \
  -d '{
    "address" : [ {
      "address1" : "Test address",
      "city" : "Test City",
      "country" : "US",
      "id" : "corp-address",
      "isPrimary" : true,
      "state" : "CA",
      "zip" : "54321"
    } ],
    "approveTrusted" : false,
    "approveUntrusted" : false,
    "billingCycle" : "CALENDAR_MONTH",
    "country" : "US",
    "currency" : "USD",
    "description" : "Test organization",
    "hasBillingAdjustment" : true,
    "hasBroker" : false,
    "hasSelfBilling" : false,
    "hasSeparateInvoiceForProduct" : false,
    "id" : "myorg",
    "issueNettingStmt" : false,
    "logoUrl" : "https://dl.dropboxusercontent.com/u/48279818/LOGOS/testorg.jpeg",
    "name" : "{org_name}",
    "nettingStmtPerCurrency" : false,
    "regNo" : "RegNo-1234-myorg",
    "selfBillingAsExchOrg" : false,
    "selfBillingForAllDev" : false,
    "separateInvoiceForFees" : false,
    "status" : "ACTIVE",
    "supportedBillingType" : "POSTPAID",
    "taxModel" : "HYBRID",
    "taxRegNo" : "TaxRegNo-1234-myorg",
    "timezone" : "UTC"
  }' \
  -u email:password

API의 조직 프로필 구성 속성

조직 프로필을 사용하면 API를 사용하여 다음 구성 속성을 설정할 수 있습니다.

이름 설명 기본 계정 필수 여부
address

조직 주소(상세 주소, 시/도, 주/도, 우편번호, 국가 및 조직의 기본 주소인지 여부를 표시하는 정보 포함)

N/A No
approveTrusted

이 플래그는 사용되지 않습니다.

N/A No
approveUntrusted

이 플래그는 사용되지 않습니다.

N/A No
billingCycle

결제 주기 기간입니다. 이 값은 다음 중 하나일 수 있습니다.

  • 일할 계산: 한 달에 API 제품이 사용된 일 수를 기준으로 요금이 청구됩니다.
  • CALENDAR_MONTH: 결제가 매월 이루어집니다.

API를 사용하여 결제 주기 구성을 참고하세요.

N/A 지원됨
country

조직의 운영 국가용 ISO 3166-2 코드(예: 브라질의 경우 BR)

N/A 지원됨
currency

조직에서 사용하는 '기본' 또는 회계 통화의 ISO 4217 코드입니다 (예: 미국 달러의 경우 USD).

수익 공유 계획의 경우: 지정된 통화가 계획에 사용됩니다.

요율표 (청구 모델) 요금제의 경우: 수익 공유 요금제와 동일하게 적용됩니다. 단, 통화 설정을 조직에서 지원하는 통화로 변경할 수 있습니다.

수수료 전용 요금제: 통화 설정을 조직에서 지원하는 통화로 변경할 수 있습니다.

N/A 지원됨
description

조직에 대한 간략한 설명입니다.

N/A No
hasBillingAdjustment

조정의 사용 설정 여부를 지정하는 플래그입니다. 사용 설정하면 API 서비스에서 API 제품에 대해 기록하는 트래픽 세부정보를 조정할 수 있습니다. 이 값은 다음 중 하나일 수 있습니다.

  • true: 조정이 사용 설정됩니다.
  • false: 조정이 사용 설정되지 않습니다.
N/A No
hasBroker

수익이 순수익을 기준으로 하는지 지정하는 플래그입니다. 값은 다음 중 하나일 수 있습니다.

  • true: 수익은 순수익을 기반으로 합니다.
  • false: 수익은 순수익을 기준으로 하지 않습니다.
N/A No
hasSelfBilling

수익 공유 명세서 대신 자체 결제 인보이스를 생성하도록 수익 창출을 지시하는 플래그입니다. 자체 결제 인보이스는 앱 개발자에게 지급해야 할 금액이 자세히 설명된 재무 문서입니다. 앱 개발자를 대신하여 API 제공업체에 대한 인보이스 역할을 합니다. 값은 다음 중 하나일 수 있습니다.

  • true: 수익 배분 명세서 대신 자체 결제 인보이스를 생성합니다.
  • false: 자체 결제 인보이스를 사용 중지합니다.
N/A No
hasSeparateInvoiceForProduct

각 API 제품에 대해 별도의 인보이스를 생성할지 여부를 지정하는 플래그입니다. 이 값은 다음 중 하나일 수 있습니다.

  • true: API 제품별로 별도의 인보이스가 생성됩니다.
  • false: API 제품별로 별도의 인보이스가 생성되지 않습니다.
N/A No
id

조직의 ID입니다.

N/A No
issueNettingStmt

청구 문서를 만들 때 상계 명세서를 생성할지 여부를 지정하는 플래그입니다. 값은 다음 중 하나일 수 있습니다.

  • true: 청구 문서를 만들 때 상계 명세서가 생성됩니다.
  • false: 결제 문서를 만들 때 상계 명세서가 생성되지 않습니다.
N/A No
logoUrl

조직 로고 URL입니다.

N/A No
name

조직의 이름입니다.

N/A 지원됨
netPaymentAdviceNote

순 결제 조언 메모

N/A No
nettingStmtPerCurrency

사용된 통화별로 별도의 상계 명세서를 생성할지 여부를 지정하는 플래그입니다. 값은 다음 중 하나일 수 있습니다.

  • true: 사용된 각 통화에 대해 별도의 상계 명세서가 생성됩니다.
  • false: 사용된 각 통화에 대해 별도의 상계 명세서가 생성되지 않습니다.
N/A No
regNo

조직의 등록 번호 이 속성에 입력한 번호는 결제 문서 하단에 표시됩니다.

N/A No
selfBillingAsExchOrg

자체 결제 인보이스가 사용 설정된 경우 거래소 조직에 사용 설정되어 있는지 여부를 나타냅니다. 값은 다음 중 하나일 수 있습니다.

  • true: 거래소 조직에서 자체 결제 인보이스를 사용할 수 있습니다.
  • false: 거래소 조직에 대해 자체 결제 인보이스를 사용할 수 없습니다.
N/A No
selfBillingForAllDev

자체 결제 인보이스가 사용 설정된 경우 모든 앱 개발자를 대상으로 사용 설정 여부를 나타냅니다. 기본적으로 자체 결제 인보이스는 API 제공업체와 계약에 서명한 앱 개발자를 위해서만 생성됩니다. 값은 다음 중 하나일 수 있습니다.

  • true: 모든 앱 개발자가 자체 결제 인보이스를 사용 설정합니다.
  • false: 모든 앱 개발자가 자체 결제 인보이스를 사용할 수 있는 것은 아닙니다.
false No
separateInvoiceForFees

수수료에 대한 별도의 인보이스를 게시할지 지정하는 플래그입니다. 값은 다음 중 하나일 수 있습니다.

  • true: 수수료를 위한 별도의 인보이스가 게시됩니다.
  • false: 수수료가 부과되는 별도의 인보이스가 게시되지 않습니다.
false 지원됨
status

조직의 상태입니다. 유효한 값으로 다음이 포함되어 있습니다.

  • 활성: 조직 계정이 수익 창출에 등록되어 있으며 사용할 수 있습니다.
  • INACTIVE: 조직 계정이 수익 창출에 등록되었지만 사용할 수 없습니다.
N/A No
supportedBillingType

결제에 사용되는 개발자 결제 모델 이 값은 다음 중 하나일 수 있습니다.

  • 선불: 개발자가 API 제품 사용에 대해 선불로 지불합니다. API 제품을 사용하면 개발자의 잔액에서 자금이 차감됩니다. 개발자는 API 제품을 구매하기에 충분한 선불 잔액을 유지해야 합니다.
  • 후불: 개발자에게 API 제품 사용 요금이 매월 (인보이스를 통해) 청구됩니다. 개발자는 인보이스에 포함된 요금제에서 설정한 결제 약관에 따라 API 제품 사용 비용을 지불합니다.
  • BOTH: 두 결제 유형 중 하나를 지원합니다. 기본값은 PREPAID입니다.

API를 사용한 선불 및 후불 결제 유형 구성을 참조하세요.

선불 지원됨
taxModel

참고: 수익 공유 요금제를 설정하고 결제 문서를 생성하려는 경우에만 적용됩니다.

필요한 결제 문서 유형을 식별하는 수익 공유 요금제의 세금 모델입니다.

유효한 값으로 다음이 포함되어 있습니다.

  • 공개: API 제공업체가 개발자의 공개된 에이전트 역할을 합니다. 최종 사용자로부터 수집한 총 수익 (판매세 포함)이 개발자에게 전달됩니다. API 제공업체의 수수료는 개발자로부터 수수료 인보이스 형태로 징수됩니다. API 제공업체는 최종 사용자로부터 징수된 판매세를 처리하지 않으며, 판매세를 신고하는 것은 개발자의 책임입니다.
  • 비공개: API 제공업체가 개발자의 비공개 대리인 역할을 하며 최종 사용자로부터 징수된 세금을 공제하여 현지 세무 당국에 납부합니다. 개발자는 판매세와 API 제공업체의 수수료를 공제하여 개발자가 부담한 순수익 공유 금액을 API 제공업체에 인보이스를 발행합니다.
  • 하이브리드: API 제공업체가 개발자의 공개된 에이전트 역할을 합니다. 하지만 API 제공업체는 개발자를 대신하여 구독자로부터 부과된 판매세를 현지 세무 당국에 납부합니다. API 제공업체가 잔여 수익을 개발자에게 전달한 후 수수료 인보이스를 발행합니다.
N/A 지원됨
taxNexus

조직이 과세 목적으로 등록된 국가입니다.

N/A No
taxRegNo

조직의 세금 등록 번호 또는 부가가치세(VAT) 등록 번호(해당하는 경우) 세금 등록 번호 또는 VAT 등록 번호가 일부 국가에는 적용되지 않으므로 이 속성은 선택사항입니다. 이 매개변수에 입력한 번호는 결제 문서 하단에 표시됩니다.

N/A No
transactionRelayURL

트랜잭션을 릴레이할 수 있는 다른 시스템의 URL(예: 데이터 웨어하우스)

N/A No
timezone

조직 운영의 시간대 식별자입니다(예: America/New_York 또는 유럽/파리). UTC, EST (동부 표준시) 또는 CET (중부 유럽 표준시)와 같은 시간대 약어도 지원됩니다.

N/A 지원됨

회사 또는 앱 개발자의 수익 창출 프로필 설정 재정의

다음 섹션에 설명된 대로 UI 또는 API를 사용하여 회사 또는 앱 개발자의 수익 창출 프로필 설정을 재정의합니다.