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 cũng như 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ơ của tổ chức để thêm hoặc cập nhật thông tin về tổ chức của mình, nếu thích hợp. Ví dụ: Bạn có thể cần phải 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
- Hình thức thanh toán (trả trước, trả sau hoặc cả hai), như mô tả trong bài viết Tìm hiểu về loại thanh toán
- Chu kỳ thanh toán (phân chia theo tỷ lệ hoặc tháng theo lịch)
- 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 của mình 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ơ của tổ chức
Truy cập vào trang Hồ sơ của tổ chức theo 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ẽ hiển thị.
Như được đánh dấu trong hình, trang Hồ sơ tổ chức cho phép bạn:
- Xem các chế độ cài đặt hiện tại của hồ sơ tổ chức
- Chỉnh sửa chế độ cài đặt hồ sơ của tổ chức, trong đó có:
- 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 Quản lý điều khoản và điều kiện
Phiên bản cũ (Đám mây riêng tư)
Cách truy cập vào trang Hồ sơ 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 ở thanh điều hướng trên cùng.
Trang Hồ sơ của tổ chức sẽ hiển thị.
Trang Hồ sơ tổ chức cho phép bạn:
- Xem các chế độ cài đặt hiện tại của hồ sơ tổ chức
- Chỉnh sửa chế độ cài đặt hồ sơ của tổ chức, trong đó có:
- 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 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 Thuế và đơn vị tiền tệ, hãy chỉnh sửa các trường sau:
Trường Nội dung mô tả Mô hình thuế Lưu ý: Chỉ áp dụng nếu bạn đã thiết lập các gói giá chia sẻ doanh thu và muốn tạo chứng từ thanh toán.
Mô hình thuế cho gói giá chia sẻ doanh thu, trong đó 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à một tác nhân đượ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 sẽ được chuyển cho nhà phát triển. Phí hoa hồng của nhà cung cấp API sẽ do nhà phát triển thu dưới dạng hoá đơn hoa hồng. Nhà cung cấp API không xử lý thuế bán hàng thu được 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 tiết lộ: Nhà cung cấp API đóng vai trò là người đại diện không tiết lộ của nhà phát triển, khấu trừ khoản thuế thu được từ người dùng cuối và nộp cho cơ quan thuế địa phương. Nhà phát triển lập hoá đơn cho nhà cung cấp API đối với phần doanh thu chia sẻ mà nhà phát triển trả cho nhà phát triển (trừ thuế bán hàng và tiền hoa hồng của nhà cung cấp API).
- Kết hợp: Nhà cung cấp API đóng vai trò như 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 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 sẽ chuyể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ệ Đơn vị tiền tệ mà tổ chức của bạn hỗ trợ. Đối với các kế hoạch chia sẻ doanh thu, bảng giá và chỉ phí, đơn vị tiền tệ mặc định sẽ được sử dụng cho gói giá của bạn. Khi tạo gói giá hoặc gói chỉ phí, bạn có thể thay đổi đơn vị tiền tệ sẽ sử dụng bằng cách chọn trong danh sách các đơn vị tiền tệ được hỗ trợ. Nếu muốn, 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 đối với 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 đơn vị tiền tệ trên trình đơn thả xuống trong trường Đơn vị tiền tệ.
- Nếu muốn, hãy đặ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ệ đượ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 đơ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 rồi 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ý các đ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ơ của tổ chức bằng API
Quản lý hồ sơ tổ chức bằng API theo mô tả ở các phần sau.
Xem hồ sơ của 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 tuỳ chọn hiển thị, 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 hồ sơ của tổ chức bằng cách gửi yêu cầu PUT tới
/mint/organizations/{org_name}
. Khi chỉnh sửa hồ sơ tổ chức, bạn cần chỉ định tất cả các thuộc tính của hồ sơ 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 cập nhật currency
thành USD và chế độ cài đặt mô hình thuế thành HYBRID
(trong ví dụ này các trường đã cập nhật được làm nổi bật). Để biết thêm thông tin về các tuỳ chọn hiển thị, 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 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.
Đối 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ẽ đượ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 thời hạn thanh toán được đặt ra trong(các) gói có trên hoá đơn.
Để định cấu hình loại thanh toán trả trước và trả sau cho tổ chức, 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
, giá trị mặc định sẽ là PREPAID
khi bạn thêm công ty hoặc nhà phát triển ứng dụng. Trong trường hợp này, bạn có thể thiết lập 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 cách sử dụ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 cách sử dụng API
Để thiết lập 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 theo lịch.CALENDAR_MONTH
: Việc 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
Các 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 | Nội dung 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à một chỉ báo 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 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 |
Kỳ 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 hoạt động của tổ chức, 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 kế hoạch chia sẻ doanh thu: Đơn vị tiền tệ đã chỉ định sẽ được sử dụng cho kế hoạch của bạn. Đối với gói bảng giá (mô hình tính phí): Quy trình này cũng áp dụng tương tự cho 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ỉ 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 |
Mô tả ngắn về tổ chức. |
Không áp dụng | Không |
hasBillingAdjustment |
Cờ chỉ định liệu mức điều chỉnh có đang bật hay không. Nếu được bật, bạn có thể điều chỉnh thông tin 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 bạn. Giá trị có thể là một trong những giá trị sau:
|
Không áp dụng | Không |
hasBroker |
Cờ cho biết 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ờ chỉ định hoạt động kiếm tiền để tạo hoá đơn tự thanh toán thay vì bảng sao kê chia sẻ doanh thu. Hoá đơn tự thanh toán là một chứng từ tài chính nêu chi tiết số tiền phải thanh toán cho nhà phát triển ứng dụng. Hoá đơn này đóng vai trò là 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 những giá trị sau:
|
Không áp dụng | Không |
hasSeparateInvoiceForProduct |
Cờ chỉ định liệu hoá đơn riêng có được tạo cho từng sản phẩm API hay không. Giá trị này có thể là một trong những 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 xem bảng sao kê thanh toán có được tạo khi tạo chứng từ thanh toán hay không. Giá trị có thể là một trong những 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 ròng. |
Không áp dụng | Không |
nettingStmtPerCurrency |
Cờ chỉ định xem có tạo câu lệnh ròng riêng biệt cho từng đơn vị tiền tệ sử dụng hay không. Giá trị có thể là một trong những 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 cơ sở lưu trú 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 bạn bật tính năng hoá đơn tự thanh toán, 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 những giá trị sau:
|
Không áp dụng | Không |
selfBillingForAllDev |
Nếu bạn bật tính năng hoá đơn tự thanh toán, hãy cho biết liệu tính năng này có được bật cho tất cả nhà phát triển ứng dụng hay khô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ý thoả thuận với nhà cung cấp API. Giá trị có thể là một trong những giá trị sau:
|
false | Không |
separateInvoiceForFees |
Cờ cho biết liệu hoá đơn riêng có được xuất bản cho các khoản phí hay không. Giá trị này có thể là một trong những 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 dùng để 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 loại 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 các gói giá chia sẻ doanh thu và muốn tạo chứng từ thanh toán. Mô hình thuế cho gói giá chia sẻ doanh thu, trong đó 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 mà tổ chức được đăng ký cho các mục đích thuế. |
Không áp dụng | Không |
taxRegNo |
Mã số đăng ký thuế hoặc mã số đăng ký thuế giá trị gia tăng (GTGT) của tổ chức, nếu có. Bạn không bắt buộc phải sử dụng tài sản này 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 thông 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, chẳng hạn như kho dữ liệu. |
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_NY hoặc Europe/Paris. Chúng tôi cũng hỗ trợ chữ 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). |
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 cách sử dụng giao diện người dùng hoặc API, như mô tả trong các phần sau: