Bạn đang xem tài liệu về Apigee Edge.
Truy cập vào
tài liệu Apigee X. thông tin
Các phần sau đây giới thiệu hồ sơ tổ chức và mô tả cách bạn có thể quản lý hồ sơ đó bằng giao diện người dùng và API.
Giới thiệu về hồ sơ tổ chức
Trong quá trình thiết lập ban đầu tính năng kiếm tiền, nhóm cấu hình Apigee Edge sẽ thiết lập hồ sơ tổ chức của bạn.
Bạn cần chỉnh sửa hồ sơ tổ chức để thêm hoặc cập nhật thông tin về tổ chức của mình (nếu có). Ví dụ: bạn có thể cần cập nhật loại thanh toán, chế độ cài đặt đơn vị tiền tệ hoặc mô hình thuế.
Thiết lập thông tin cơ bản về tổ chức của bạn, bao gồm:
- Tên, địa chỉ và quốc gia hoạt động của tổ chức
- Loại thanh toán (trả trước, trả sau hoặc cả hai), như mô tả trong phần Tìm hiểu về loại thanh toán
- Chu kỳ thanh toán (tính theo tỷ lệ hoặc theo tháng dương lịch)
- Đơn vị tiền tệ cơ sở
- Mô hình thuế mà tổ chức của bạn sử dụng
Bạn có thể quản lý trang doanh nghiệp của tổ chức bằng giao diện người dùng và API, như mô tả trong các phần sau.
Khám phá trang Hồ sơ tổ chức
Truy cập vào trang Hồ sơ tổ chức, như mô tả bên dưới.
Edge
Cách truy cập vào trang Hồ sơ tổ chức bằng giao diện người dùng Edge:
- Đăng nhập vào apigee.com/edge.
- Chọn Xuất bản > Kiếm tiền > Hồ sơ tổ chức trong thanh điều hướng bên trái.
Trang Hồ sơ tổ chức sẽ xuất hiện.

Như minh hoạ trong hình, trang Hồ sơ tổ chức cho phép bạn:
- Xem chế độ cài đặt hồ sơ tổ chức hiện tại
- Chỉnh sửa chế độ cài đặt trang doanh nghiệp của tổ chức, bao gồm:
- Tên và thông tin
- Thuế và đơn vị tiền tệ
- Điều khoản và điều kiện, như mô tả trong phần Quản lý điều khoản và điều kiện
Classic Edge (Private Cloud)
Cách truy cập vào trang Hồ sơ tổ chức bằng giao diện người dùng Edge phiên bản cũ:
- Đăng nhập vào
http://ms-ip:9000, trong đó ms-ip là địa chỉ IP hoặc tên DNS của nút Máy chủ quản lý. - Chọn Quản trị > Hồ sơ tổ chức trong thanh điều hướng trên cùng.
Trang Hồ sơ tổ chức sẽ xuất hiện.

Trang Hồ sơ tổ chức cho phép bạn:
- Xem chế độ cài đặt hồ sơ tổ chức hiện tại
- Chỉnh sửa chế độ cài đặt trang doanh nghiệp của tổ chức, bao gồm:
- Tên và thông tin
- Thuế và đơn vị tiền tệ
- Điều khoản và điều kiện, như mô tả trong phần Quản lý điều khoản và điều kiện
Chỉnh sửa hồ sơ tổ chức bằng giao diện người dùng
Cách chỉnh sửa hồ sơ tổ chức bằng giao diện người dùng:
- Truy cập vào trang Hồ sơ tổ chức.
- Nhấp vào Chỉnh sửa.
- Trong mục Tên và thông tin, hãy chỉnh sửa tên tổ chức và quốc gia hoạt động.
- Trong mục Thuế và đơn vị tiền tệ, hãy chỉnh sửa các trường sau:
Trường Mô tả Mô hình thuế Lưu ý: Chỉ áp dụng nếu bạn thiết lập kế hoạch tỷ lệ chia sẻ doanh thu và muốn tạo chứng từ thanh toán.
Mô hình thuế cho các gói giá chia sẻ doanh thu, xác định loại chứng từ thanh toán bắt buộc.
Các giá trị hợp lệ bao gồm:
- Được tiết lộ: Nhà cung cấp API đóng vai trò là một tác nhân được tiết lộ của nhà phát triển. Tổng doanh thu (bao gồm cả thuế bán hàng) thu được từ người dùng cuối sẽ được chuyển cho nhà phát triển. Nhà phát triển sẽ trả hoa hồng cho nhà cung cấp API dưới dạng hoá đơn hoa hồng. Nhà cung cấp API không xử lý thuế bán hàng thu từ người dùng cuối và nhà phát triển có trách nhiệm báo cáo thuế bán hàng.
- Không công bố: Nhà cung cấp API đóng vai trò là một đại lý không công bố của nhà phát triển, đồng thời khấu trừ thuế thu được từ người dùng cuối và trả cho cơ quan thuế địa phương. Nhà phát triển lập hoá đơn cho nhà cung cấp API về phần doanh thu ròng phải trả cho nhà phát triển (trừ thuế bán hàng và hoa hồng của nhà cung cấp API).
- Kết hợp: Nhà cung cấp API đóng vai trò là một đại lý được công bố của nhà phát triển. Tuy nhiên, nhà cung cấp API sẽ thay mặt nhà phát triển thanh toán thuế bán hàng thu được từ người đăng ký cho cơ quan thuế địa phương. Nhà cung cấp API chuyển phần doanh thu còn lại cho nhà phát triển, sau đó lập hoá đơn cho các khoản phí hoa hồng.
Đơn vị tiền tệ Các đơn vị tiền tệ mà tổ chức của bạn hỗ trợ. Đối với các gói chia sẻ doanh thu, thẻ giá và chỉ tính phí, đơn vị tiền tệ mặc định sẽ được dùng cho gói giá của bạn. Khi tạo thẻ giá hoặc gói chỉ tính phí, bạn có thể thay đổi đơn vị tiền tệ cần sử dụng bằng cách chọn trong danh sách các đơn vị tiền tệ được hỗ trợ. Bạn có thể đặt số tiền nạp tối thiểu mà nhà phát triển ứng dụng có thể thêm vào số dư tài khoản trả trước cho mỗi đơn vị tiền tệ (không bắt buộc).
Cách thêm một đơn vị tiền tệ:
- Nhấp vào Thêm đơn vị tiền tệ.
- Chọn một đơn vị tiền tệ trong trình đơn thả xuống ở trường Đơn vị tiền tệ.
- Bạn có thể đặt số tiền tối thiểu mà nhà phát triển ứng dụng có thể thêm vào số dư tài khoản trả trước bằng đơn vị tiền tệ đã chỉ định trong trường Số tiền nạp tối thiểu.
- Nhấp vào Thêm.
- Đặt làm đơn vị tiền tệ mặc định (nếu muốn) bằng cách nhấp vào nút chọn tương ứng.
- Lặp lại các bước để thêm các đơn vị tiền tệ khác.
Để xoá một đơn vị tiền tệ, hãy di chuyển con trỏ lên đơn vị tiền tệ bạn muốn xoá rồi nhấp vào biểu tượng
. - Quản lý điều khoản và điều kiện, như mô tả trong phần Quản lý điều khoản và điều kiện bằng giao diện người dùng.
- Nhấp vào Lưu.
Quản lý hồ sơ tổ chức bằng API
Quản lý hồ sơ tổ chức bằng API, như mô tả trong các phần sau.
Xem hồ sơ tổ chức bằng API
Xem trang doanh nghiệp của tổ chức bằng cách gửi yêu cầu GET đến /mint/organizations/{org_name}. Ví dụ:
curl -X GET "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}" \
-H "Accept: application/json" \
-u email:password
Sau đây là ví dụ về phản hồi. Để biết thêm thông tin về các lựa chọn xuất hiện, hãy xem phần Các thuộc tính cấu hình hồ sơ tổ chức cho 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" }
Chỉnh sửa hồ sơ tổ chức bằng API
Chỉnh sửa trang doanh nghiệp của tổ chức bằng cách gửi yêu cầu PUT đến /mint/organizations/{org_name}. Khi chỉnh sửa trang doanh nghiệp của tổ chức, bạn cần chỉ định tất cả các thuộc tính của trang doanh nghiệp của tổ chức, chứ không chỉ những thuộc tính mà bạn đang chỉnh sửa.
Để chỉnh sửa đơn vị tiền tệ mặc định cho tổ chức, hãy đặt giá trị currency thành mã đơn vị tiền tệ ISO 4217 của đơn vị tiền tệ được hỗ trợ mà bạn muốn đặt làm mặc định.
Ví dụ: lệnh gọi API sau đây sẽ cập nhật currency thành USD và chế độ cài đặt mô hình thuế thành HYBRID (các trường được cập nhật sẽ được làm nổi bật trong ví dụ). Để biết thêm thông tin về các lựa chọn xuất hiện, hãy xem phần Các thuộc tính cấu hình hồ sơ tổ chức cho 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
Định cấu hình các loại thanh toán trả trước và trả sau bằng API
Bạn có thể định cấu hình tài khoản nhà phát triển để sử dụng các loại thanh toán sau: trả trước, trả sau hoặc cả hai.
Với tài khoản trả trước, nhà phát triển thanh toán trước cho việc sử dụng API của bạn. Các khoản tiền được khấu trừ vào số dư trả trước của nhà phát triển thông qua một nhà cung cấp dịch vụ thanh toán tích hợp. Nhà phát triển phải duy trì số dư trả trước đủ để mua các API.
Với tài khoản trả sau, nhà phát triển sẽ được lập hoá đơn hằng tháng (thông qua hoá đơn) vào cuối tháng. Nhà phát triển thanh toán cho việc sử dụng các sản phẩm API dựa trên các điều khoản thanh toán do(các) gói có trong hoá đơn đặt ra.
Để định cấu hình các loại thanh toán trả trước và trả sau cho tổ chức của bạn, hãy đặt thuộc tính supportedBillingType thành một trong các giá trị sau để cho biết loại thanh toán nào hợp lệ: PREPAID, POSTPAID hoặc BOTH. Nếu bạn đặt giá trị thành BOTH, thì giá trị mặc định sẽ là PREPAID khi bạn thêm nhà phát triển ứng dụng hoặc công ty. Trong trường hợp này, bạn có thể đặt rõ ràng loại thanh toán cho một công ty hoặc nhà phát triển ứng dụng bằng API, như mô tả trong phần Quản lý công ty và nhà phát triển ứng dụng.
Ví dụ:
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
Định cấu hình chu kỳ thanh toán bằng API
Để định cấu hình chu kỳ thanh toán cho tổ chức của bạn, hãy đặt thuộc tính billingCycle thành một trong các giá trị sau:
PRORATED: Phí được tính dựa trên số ngày sử dụng một sản phẩm API trong một tháng dương lịch.CALENDAR_MONTH: Bạn sẽ thanh toán hằng tháng.
Ví dụ:
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
Thuộc tính cấu hình hồ sơ tổ chức cho API
Hồ sơ tổ chức cho phép bạn đặt các thuộc tính cấu hình sau bằng API.
| Tên | Mô tả | Mặc định | Bắt buộc? |
|---|---|---|---|
address |
Địa chỉ của tổ chức, có thể bao gồm địa chỉ đường phố, thành phố, tiểu bang, mã bưu chính, quốc gia và thông tin cho biết đây có phải là địa chỉ chính của tổ chức hay không. |
Không áp dụng | Không |
approveTrusted |
Cờ này không được dùng. |
Không áp dụng | Không |
approveUntrusted |
Cờ này không được dùng. |
Không áp dụng | Không |
billingCycle |
Khoảng thời gian của chu kỳ thanh toán. Giá trị có thể là một trong những giá trị sau:
Hãy xem phần Định cấu hình chu kỳ thanh toán bằng API. |
Không áp dụng | Có |
country |
Mã ISO 3166-2 cho quốc gia nơi tổ chức hoạt động, chẳng hạn như BR cho Brazil. |
Không áp dụng | Có |
currency |
Mã ISO 4217 cho đơn vị tiền tệ "cơ sở" hoặc đơn vị tiền tệ kế toán mà tổ chức sử dụng (chẳng hạn như USD cho đô la Mỹ). Đối với các gói chia sẻ doanh thu: Đơn vị tiền tệ được chỉ định sẽ được dùng cho gói của bạn. Đối với các gói thẻ giá (mô hình tính phí): Áp dụng tương tự như đối với các gói chia sẻ doanh thu. Tuy nhiên, bạn có thể thay đổi chế độ cài đặt đơn vị tiền tệ thành bất kỳ đơn vị tiền tệ nào mà tổ chức hỗ trợ. Đối với các gói chỉ tính phí: Bạn có thể thay đổi chế độ cài đặt đơn vị tiền tệ thành bất kỳ đơn vị tiền tệ nào mà tổ chức hỗ trợ. |
Không áp dụng | Có |
description |
Nội dung mô tả ngắn gọn về tổ chức. |
Không áp dụng | Không |
hasBillingAdjustment |
Cờ chỉ định xem có bật chế độ điều chỉnh hay không. Nếu được bật, bạn có thể điều chỉnh thông tin chi tiết về lưu lượng truy cập do Dịch vụ API ghi lại cho các sản phẩm API của mình. Giá trị có thể là một trong những giá trị sau:
|
Không áp dụng | Không |
hasBroker |
Cờ chỉ định liệu doanh thu có dựa trên giá trị ròng hay không. Giá trị có thể là một trong những giá trị sau:
|
Không áp dụng | Không |
hasSelfBilling |
Cờ hướng dẫn việc kiếm tiền để tạo hoá đơn tự lập thay vì bảng chia sẻ doanh thu. Hoá đơn tự lập là một chứng từ tài chính nêu rõ số tiền phải trả cho nhà phát triển ứng dụng. Đây là hoá đơn gửi đến Nhà cung cấp API thay mặt cho nhà phát triển ứng dụng. Giá trị có thể là một trong hai giá trị sau:
|
Không áp dụng | Không |
hasSeparateInvoiceForProduct |
Cờ chỉ định xem có tạo hoá đơn riêng cho từng sản phẩm API hay không. Giá trị có thể là một trong hai giá trị sau:
|
Không áp dụng | Không |
id |
Mã nhận dạng của tổ chức. |
Không áp dụng | Không |
issueNettingStmt |
Cờ chỉ định liệu có tạo bảng bù trừ khi tạo chứng từ thanh toán hay không. Giá trị có thể là một trong hai giá trị sau:
|
Không áp dụng | Không |
logoUrl |
URL của biểu trưng của tổ chức. |
Không áp dụng | Không |
name |
Tên tổ chức. |
Không áp dụng | Có |
netPaymentAdviceNote |
Phiếu báo thanh toán ròng. |
Không áp dụng | Không |
nettingStmtPerCurrency |
Cờ chỉ định việc có tạo bảng sao kê bù trừ riêng cho từng đơn vị tiền tệ được sử dụng hay không. Giá trị có thể là một trong hai giá trị sau:
|
Không áp dụng | Không |
regNo |
Số đăng ký của tổ chức. Số bạn nhập cho tài sản này sẽ xuất hiện ở cuối chứng từ thanh toán. |
Không áp dụng | Không |
selfBillingAsExchOrg |
Nếu hoá đơn tự lập được bật, hãy cho biết liệu hoá đơn này có được bật cho các tổ chức trao đổi hay không. Giá trị có thể là một trong hai giá trị sau:
|
Không áp dụng | Không |
selfBillingForAllDev |
Nếu bạn bật hoá đơn tự lập, hãy cho biết liệu bạn đã bật tính năng này cho tất cả nhà phát triển ứng dụng hay chưa. Theo mặc định, hoá đơn tự lập chỉ được tạo cho những nhà phát triển ứng dụng đã ký thoả thuận với nhà cung cấp API. Giá trị có thể là một trong hai giá trị sau:
|
false | Không |
separateInvoiceForFees |
Cờ chỉ định việc có xuất bản hoá đơn riêng cho các khoản phí hay không. Giá trị có thể là một trong hai giá trị sau:
|
false | Có |
status |
Trạng thái của tổ chức. Các giá trị hợp lệ bao gồm:
|
Không áp dụng | Không |
supportedBillingType |
Mô hình thanh toán của nhà phát triển được dùng để lập hoá đơn. Giá trị có thể là một trong những giá trị sau:
Xem phần Định cấu hình các loại hình thức thanh toán trả trước và trả sau bằng API. |
TRẢ TRƯỚC | Có |
taxModel |
Lưu ý: Chỉ áp dụng nếu bạn thiết lập kế hoạch tỷ lệ chia sẻ doanh thu và muốn tạo chứng từ thanh toán. Mô hình thuế cho các gói giá chia sẻ doanh thu, xác định loại chứng từ thanh toán bắt buộc. Các giá trị hợp lệ bao gồm:
|
Không áp dụng | Có |
taxNexus |
Quốc gia nơi tổ chức đăng ký cho mục đích thuế. |
Không áp dụng | Không |
taxRegNo |
Số đăng ký thuế hoặc số đăng ký Thuế giá trị gia tăng (GTGT) của tổ chức (nếu có). Đây là thuộc tính không bắt buộc vì mã số đăng ký thuế hoặc mã số đăng ký thuế GTGT không áp dụng ở một số quốc gia. Số mà bạn nhập cho tham số này sẽ xuất hiện ở cuối chứng từ thanh toán. |
Không áp dụng | Không |
transactionRelayURL |
URL của một hệ thống khác mà giao dịch có thể được chuyển tiếp đến, chẳng hạn như một kho dữ liệu. |
Không áp dụng | Không |
timezone |
Giá trị nhận dạng múi giờ cho hoạt động của tổ chức, chẳng hạn như America/New_York hoặc Europe/Paris. Các tên viết tắt của múi giờ, chẳng hạn như UTC, EST (Giờ chuẩn miền Đông) hoặc CET (Giờ Trung Âu) cũng được hỗ trợ. |
Không áp dụng | Có |
Ghi đè chế độ cài đặt hồ sơ kiếm tiền cho một công ty hoặc nhà phát triển ứng dụng
Ghi đè chế độ cài đặt hồ sơ kiếm tiền cho một công ty hoặc nhà phát triển ứng dụng bằng giao diện người dùng hoặc API, như mô tả trong các phần sau: