Bạn đang xem tài liệu về Apigee Edge.
Chuyển đến
Tài liệu về Apigee X. thông tin
Các phần sau đây giới thiệu về 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 hoạt động kiếm tiền ban đầu , 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 phù hợp). 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ế.
Định cấu hình thông tin cơ bản về tổ chức của bạn, bao gồm:
- Tên tổ chức, địa chỉ và quốc gia hoạt động
- 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 (chia theo tỷ lệ hoặc theo tháng theo 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ý hồ sơ tổ chức bằng giao diện người dùng và API, như mô tả trong các phần sau đây.
Khám phá trang Hồ sơ của tổ chức
Truy cập trang Hồ sơ của tổ chức như mô tả dưới đây.
Edge
Cách truy cập vào trang Hồ sơ của 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ơ của tổ chức sẽ được hiển thị.
Như được đánh dấu trong hình, trang Hồ sơ của tổ chức cho phép bạn:
- Xem chế độ cài đặt hồ sơ hiện tại của tổ chức
- Chỉnh sửa chế độ cài đặt hồ sơ 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ư được mô tả trong phần Quản lý điều khoản và điều kiện
Classic Edge (Đám mây riêng tư)
Cách truy cập vào trang Hồ sơ của tổ chức bằng giao diện người dùng Classic Edge:
- Đă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ơ của tổ chức sẽ được hiển thị.
Trang Hồ sơ tổ chức cho phép bạn:
- Xem chế độ cài đặt hồ sơ hiện tại của tổ chức
- Chỉnh sửa chế độ cài đặt hồ sơ 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ư được 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 phần 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 gói tỷ lệ chia sẻ doanh thu và muốn để tạo chứng từ thanh toán.
Mô hình thuế cho gói tỷ lệ chia sẻ doanh thu giúp 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ông bố: Nhà cung cấp API đóng vai trò là đại lý được công bố 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 là được truyền cho nhà phát triển. Hoa hồng của nhà cung cấp API được thu từ nhà phát triển 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 chịu trách nhiệm để báo cáo thuế bán hàng.
- Không được tiết lộ: Nhà cung cấp API đóng vai trò là một tác nhân chưa được tiết lộ của nhà phát triển đồng thời khấu trừ thuế thu được từ người dùng cuối rồi trả cho cơ quan thuế địa phương. Nhà phát triển lập hoá đơn doanh thu ròng cho nhà cung cấp API chia sẻ do nhà phát triển (giảm thuế bán hàng và phí hoa hồng).
- Kết hợp: Nhà cung cấp API đóng vai trò là một tác nhân được công bố của nhà phát triển. Tuy nhiên, nhà cung cấp API sẽ trả thuế bán hàng thu được từ người đăng ký với cơ quan thuế địa phương thay mặt cho nhà phát triển. API nhà cung cấp chuyển doanh thu còn lại cho nhà phát triển, sau đó lập hoá đơn cho phí hoa hồng.
Đơn vị tiền tệ Đơn vị tiền tệ mà tổ chức của bạn hỗ trợ. Đối với gói chia sẻ doanh thu, bảng giá và gói chỉ chia sẻ phí, đơn vị tiền tệ mặc định sẽ được dùng cho gói giá của bạn. Khi tạo bảng giá hoặc gói chỉ tính phí, bạn có thể thay đổi đơn vị tiền tệ sử dụng bằng cách chọn từ danh sách đơn vị tiền tệ được hỗ trợ. Nếu muốn, bạn có thể đặt số tiền nạp 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 của họ cho từng đơn vị tiền tệ.
Cách thêm đơ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ệ từ trình đơn thả xuống trong trường Đơn vị tiền tệ.
- Nếu muốn, nhà phát triển ứng dụng có thể thêm 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 của họ bằng đơn vị tiền tệ được chỉ định trong trường Nạp tiền 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 được liên kết.
- Lặp lại các bước để thêm các đơn vị tiền tệ khác.
Để xóa 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 xóa và nhấp vào .
- Quản lý các điều khoản và điều kiện, như mô tả trong bài viết 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 hồ sơ tổ chức của bạn bằng cách gửi yêu cầu GET tới
/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 hiển thị, hãy xem phần Thuộc tính cấu hình của 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 hồ sơ tổ chức bằng cách gửi yêu cầu PUT cho
/mint/organizations/{org_name}
. Khi chỉnh sửa hồ sơ tổ chức, bạn cần chỉ định tất cả
thuộc tính hồ sơ tổ chức chứ không chỉ các thuộc tính 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
đơn vị tiền tệ ISO 4217
mã 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 cập nhật currency
thành USD và mô hình thuế
thành HYBRID
(các trường được cập nhật được đánh dấu 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ấ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 loại hình thanh toán trả trước và trả sau bằng API
Tài khoản nhà phát triển có thể được định cấu hình để 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 sẽ thanh toán trước cho việc sử dụng API của bạn. Tiền được khấu trừ từ số dư trả trước của nhà phát triển được duy trì 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ẽ phải thanh toá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 sản phẩm API dựa trên điều khoản thanh toán do(các) gói có trong hoá đơn đặt ra.
Để thiết lập loại phương thức 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 đặt giá trị thành BOTH
,
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õ loại thanh toán cho công ty hoặc nhà phát triển ứng dụng bằng API, như mô tả trong
Công ty quản lý 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
: Thanh toán dựa trên số ngày mà một sản phẩm API được sử dụng trong một tháng dương lịch.CALENDAR_MONTH
: Thanh toán được thực hiệ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 đây 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) mã, quốc gia và chỉ báo liệu đây có phải là địa chỉ chính của tổ chức. |
Không áp dụng | Không |
approveTrusted |
Cờ này không được sử dụng. |
Không áp dụng | Không |
approveUntrusted |
Cờ này không được sử dụng. |
Không áp dụng | Không |
billingCycle |
Chu kỳ thanh toán. Giá trị có thể là một trong những giá trị sau:
Xem bài viết Đị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 cho tổ chức này, chẳng hạn như Brazil tại Brazil. |
Không áp dụng | Có |
currency |
Mã ISO 4217 cho "cơ sở" hoặc đơn vị tiền tệ kế toán mà tổ chức sử dụng (chẳng hạn như đô la Mỹ tại Hoa Kỳ) đô la). Đối với gói chia sẻ doanh thu: Đơn vị tiền tệ đã chỉ định sẽ được dùng cho kế hoạch của bạn. Đối với gói thẻ giá (mô hình tính phí): Quy định này cũng áp dụng cho 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 do tổ chức. Đối với gói chỉ trả 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 được hỗ trợ tổ chức. |
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 liệu các mức điều chỉnh có đang bật hay không. Nếu được bật, bạn có thể đối với chi tiết 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 bạn có thể là một trong các giá trị sau:
|
Không áp dụng | Không |
hasBroker |
Cờ chỉ định liệu doanh thu có dựa trên doanh thu thuần hay không. Giá trị có thể là một trong số như sau:
|
Không áp dụng | Không |
hasSelfBilling |
Gắn cờ hướng dẫn kiếm tiền để tạo hoá đơn tự thanh toán thay vì doanh thu câu lệnh chia sẻ. Hoá đơn tự lập hoá đơn là một chứng từ tài chính nêu chi tiết số tiền do nhà phát triển ứng dụng. Có vai trò như một hoá đơn cho 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 các giá trị sau:
|
Không áp dụng | Không |
hasSeparateInvoiceForProduct |
Cờ cho biết liệu hoá đơn riêng biệt có được tạo cho từng sản phẩm API hay không. Chiến lược phát hành đĩa đơn có thể là một trong các 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 bảng sao kê ròng có được tạo khi tạo thông tin thanh toán hay không tài liệu. Giá trị có thể là một trong các giá trị sau:
|
Không áp dụng | Không |
logoUrl |
URL 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 |
Ghi chú tư vấn về khoản thanh toán thực. |
Không áp dụng | Không |
nettingStmtPerCurrency |
Cờ chỉ định liệu một câu lệnh mạng riêng có được tạo cho mỗi loại đơn vị tiền tệ đã sử dụng. Giá trị có thể là một trong các giá trị sau:
|
Không áp dụng | Không |
regNo |
Số đăng ký của tổ chức. Số mà bạn nhập cho tài sản này là được hiển thị ở cuối chứng từ thanh toán. |
Không áp dụng | Không |
selfBillingAsExchOrg |
Nếu hoá đơn tự thanh toán được bật, hãy cho biết liệu hoá đơn có được bật để trao đổi không tổ chức. Giá trị có thể là một trong các giá trị sau:
|
Không áp dụng | Không |
selfBillingForAllDev |
Nếu hoá đơn tự thanh toán được bật, hãy cho biết liệu hoá đơn có được bật cho tất cả tài khoản người dùng hay không nhà phát triển ứng dụng. Theo mặc định, hoá đơn tự thanh toán chỉ được tạo cho những nhà phát triển ứng dụng đã ký một thoả thuận với nhà cung cấp API. Giá trị có thể là một trong các giá trị sau:
|
false | Không |
separateInvoiceForFees |
Cờ cho biết liệu một hoá đơn riêng có được xuất bản tính phí hay không. Giá trị có thể là một trong hai điều kiện 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 dành cho nhà phát triển dùng để thanh toán. Giá trị có thể là một trong những giá trị sau:
Xem cách Định cấu hình loại hình 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 gói tỷ lệ chia sẻ doanh thu và muốn để tạo chứng từ thanh toán. Mô hình thuế cho gói tỷ lệ chia sẻ doanh thu giúp 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 được đăng ký cho mục đích thuế. |
Không áp dụng | Không |
taxRegNo |
Mã số đăng ký thuế hoặc đăng ký thuế giá trị gia tăng (GTGT) của tổ chức số, nếu có. Thuộc tính này là 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 ở tất cả các quốc gia. Số bạn nhập cho yêu cầu này được hiển thị ở 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 tới, chẳng hạn như dữ liệu kho hàng. |
Không áp dụng | Không |
timezone |
Giá trị nhận dạng múi giờ cho các hoạt động của tổ chức, chẳng hạn như America/New_ Được hoặc Châu Âu/Paris. Từ viết tắt múi giờ, chẳng hạn như UTC, EST (Miền Đông) Giờ chuẩn) 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 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 công ty hoặc nhà phát triển ứng dụng bằng cách sử dụng giao diện người dùng hoặc API, như mô tả trong các phần sau: