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 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 để 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ần). Ví dụ: bạn có thể cần cập nhật loại hình 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 (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.
Khám phá trang Hồ sơ tổ chức
Truy cập vào trang Hồ sơ tổ chức theo 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ư được làm nổi bật 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
Edge phiên bản cũ (Đám mây riêng)
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 các gói tỷ lệ chia sẻ doanh thu và muốn tạo tài liệu thanh toán.
Mô hình thuế cho các gói giá chia sẻ doanh thu xác định loại giấy 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à đại lý được tiết lộ của nhà phát triển. Doanh thu gộp (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 được thu thập từ nhà phát triển dưới dạng hoá đơn phí hoa hồng. Nhà cung cấp API không xử lý thuế bán hàng được 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 từ người dùng cuối và trả thuế 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 thuộc về 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à đạ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 nộp 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 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 gói chia sẻ doanh thu, bảng giá và chỉ tính phí, hệ thống sẽ sử dụng đơn vị tiền tệ mặc định 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 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 của họ cho mỗi đơn vị tiền tệ (không bắt buộc).
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ệ trong trình đơn thả xuống của 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 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 liên quan.
- Lặp lại các bước để thêm đơn vị tiền tệ khác.
Để xoá một đơn vị tiền tệ, hãy di chuyển con trỏ đến đơn vị tiền tệ bạn muốn xoá rồi nhấp vào .
- 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 hồ sơ tổ chức của bạn 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 tuỳ chọn được hiển thị, hãy xem phần 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ơ tổ chức bằng cách đưa ra yêu cầu PUT đến /mint/organizations/{org_name}
. Khi chỉnh sửa trang doanh nghiệp, bạn cần chỉ định tất cả thuộc tính trang doanh nghiệp, 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ã 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ập nhật được làm nổi bật trong ví dụ). Để biết thêm thông tin về các tuỳ chọn hiển thị, hãy xem 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 hình 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ẽ trả trước để sử dụng API của bạn. Khoản tiền sẽ được khấu trừ vào số dư trả trước của nhà phát triển do một nhà cung cấp dịch vụ thanh toán tích hợp duy trì. 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 tính phí 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 nêu 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
, 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 hệ thống 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
: Hệ thống tính phí 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
: Hệ thống sẽ tính phí 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 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ỳ thanh toán. Giá trị này có thể là một trong những giá trị sau:
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 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ệ "gốc" 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 theo bảng giá (mô hình tính phí): 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 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ị này 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 doanh thu ròng hay không. Giá trị này có thể là một trong các 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ì thông báo chia sẻ doanh thu. Hoá đơn tự lập là một tài liệu tài chính nêu chi tiết số tiền nhà phát triển ứng dụng phải trả. Giấy tờ 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ị này có thể là một trong những giá trị sau:
|
Không áp dụng | Không |
hasSeparateInvoiceForProduct |
Cờ chỉ định liệu hệ thống có tạo hoá đơn riêng 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 có tạo bảng sao kê bù trừ khi tạo tài liệu thanh toán 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 |
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 |
Ghi chú tư vấn thanh toán ròng. |
Không áp dụng | Không |
nettingStmtPerCurrency |
Cờ chỉ định việc có tạo một bảng sao kê thanh toán bù trừ riêng cho từng đơn vị tiền tệ được sử dụng 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 |
regNo |
Số đăng ký của tổ chức. Số điện thoại bạn nhập cho tài sản này sẽ xuất hiện ở cuối tài liệu thanh toán. |
Không áp dụng | Không |
selfBillingAsExchOrg |
Nếu bạn bật hoá đơn tự lập hoá đơn, hãy cho biết liệu bạn có bật hoá đơn tự lập hoá đơn cho các tổ chức trao đổi 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 |
selfBillingForAllDev |
Nếu bạn đã bật hoá đơn tự lập hoá đơ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ị này có thể là một trong những 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ị 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 dành cho nhà phát triển dùng để lập hoá đơn. Giá trị này có thể là một trong những giá trị sau:
Xem phần Định cấu hình loại thanh toán trả trước và trả sau bằng API. |
PREPAID | Có |
taxModel |
Lưu ý: Chỉ áp dụng nếu bạn thiết lập các gói tỷ lệ chia sẻ doanh thu và muốn tạo tài liệu thanh toán. Mô hình thuế cho các gói giá chia sẻ doanh thu xác định loại giấy 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ý để phục vụ 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 (VAT) của tổ chức, nếu có. Thuộc tính này là không bắt buộc vì số đăng ký thuế hoặc 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 tài liệu thanh toán. |
Không áp dụng | Không |
transactionRelayURL |
URL của một hệ thống khác mà các giao dịch có thể được chuyển tiếp đến, 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 hoạt động của tổ chức, chẳng hạn như Mỹ/New_York hoặc Châu Âu/Paris. Các từ 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 cách sử dụng giao diện người dùng hoặc API, như mô tả trong các phần sau: